[{"id":1,"title":"API a3innuva Contabilidad Importia","slug":"a3innuva-contabilidad-importia","description":null,"color_status":null,"footerText":null,"version":null,"openDoc":{"openapi":"3.0.1","info":{"title":"API a3innuva Contabilidad Importia","description":"API a3innuva Contabilidad Importia","termsOfService":"https://a3developers.wolterskluwer.es/TermsOfUse","contact":{"name":"Wolters Kluwer TAA a3developers","url":"https://a3developers.wolterskluwer.es","email":"a3developers@wolterskluwer.com"},"license":{"name":"Terms of Use","url":"https://a3developers.wolterskluwer.es/TermsOfUse"},"version":"1.0"},"servers":[{"url":"https://a3api.wolterskluwer.es/a3innuva-contabilidad-importia","description":"PRO"}],"paths":{"/api/integrationFiles/{correlationId}":{"get":{"tags":["IntegrationFiles"],"summary":"/api/integrationFiles/{correlationId} - GET","operationId":"get-api-integrationfiles-correlationid","parameters":[{"name":"correlationId","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationFile"},"example":{"correlationId":"string","state":"string","date":"string","name":"string","origin":"string","type":"string","version":"string","sequenceVersion":0}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/integrationFiles/{correlationId}/summary":{"get":{"tags":["IntegrationFiles"],"summary":"/api/integrationFiles/{correlationId}/summary - GET","operationId":"get-api-integrationfiles-correlationid-summary","parameters":[{"name":"correlationId","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IIntegrationFileSummary"},"example":{"resume":[{"entity":"string","total":0,"integrated":0,"failed":0}],"errors":[{"line":0,"id":"string","details":[{"entity":"string","message":"string"}]}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/integrationFiles":{"post":{"tags":["IntegrationFiles"],"summary":"/api/integrationFiles - POST","operationId":"post-api-integrationfiles","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"CorrelationId":{"type":"string"},"ActivityCorrelationId":{"type":"string"},"ChannelCorrelationId":{"type":"string"},"File":{"type":"string"}}}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"string"},"example":"string"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/integrationFiles/validate":{"post":{"tags":["IntegrationFiles"],"summary":"/api/integrationFiles/validate - POST","operationId":"post-api-integrationfiles-validate","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationFileValidationResponse"},"example":{"isValid":true,"invalidInfo":["string"],"invalidEntities":[{"line":0,"code":"string"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationFileValidationResponse"},"example":{"isValid":true,"invalidInfo":["string"],"invalidEntities":[{"line":0,"code":"string"}]}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/integrationFiles/undo":{"post":{"tags":["IntegrationFiles"],"summary":"/api/integrationFiles/undo - POST","operationId":"post-api-integrationfiles-undo","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/UndoIntegrationFile"},"example":{"correlationId":"string","activityCorrelationId":"string","channelCorrelationId":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/UndoIntegrationFile"},"example":{"correlationId":"string","activityCorrelationId":"string","channelCorrelationId":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/UndoIntegrationFile"},"example":{"correlationId":"string","activityCorrelationId":"string","channelCorrelationId":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/UndoIntegrationFile"},"example":{"correlationId":"string","activityCorrelationId":"string","channelCorrelationId":"string"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationFileValidationResponse"},"example":{"isValid":true,"invalidInfo":["string"],"invalidEntities":[{"line":0,"code":"string"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}}},"components":{"schemas":{"IApiStatus":{"type":"object","properties":{"status":{"type":"string","nullable":true}},"additionalProperties":false},"IWebhookEventType":{"type":"object","properties":{"appName":{"type":"string","nullable":true},"domain":{"type":"string","nullable":true},"resource":{"type":"string","nullable":true},"eventType":{"type":"string","nullable":true},"semanticName":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"OnResourceWebhookUnsubscribeRequest":{"type":"object","properties":{"thirdPartyApplicationName":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"eventTypes":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"IIntegrationFileSummaryError":{"type":"object","properties":{"line":{"type":"integer","format":"int32"},"id":{"type":"string","nullable":true},"details":{"type":"array","items":{"$ref":"#/components/schemas/IIntegrationFileSummaryErrorDetail"},"nullable":true}},"additionalProperties":false},"IntegrationFileValidationResponse":{"type":"object","properties":{"isValid":{"type":"boolean"},"invalidInfo":{"type":"array","items":{"type":"string"},"nullable":true},"invalidEntities":{"type":"array","items":{"$ref":"#/components/schemas/IIntegrationFileValidationEntityDetail"},"nullable":true}},"additionalProperties":false},"ChangeEnableStatusRequest":{"type":"object","properties":{"webhookId":{"type":"string","format":"uuid"},"enable":{"type":"boolean"}},"additionalProperties":false},"IIntegrationFileSummaryResume":{"type":"object","properties":{"entity":{"type":"string","nullable":true},"total":{"type":"integer","format":"int32"},"integrated":{"type":"integer","format":"int32"},"failed":{"type":"integer","format":"int32"}},"additionalProperties":false},"IMessageResource":{"type":"object","properties":{"type":{"type":"string","nullable":true},"description":{"type":"string","nullable":true}},"additionalProperties":false},"IWebhookSubscriptionResponse":{"type":"object","properties":{"responseState":{"$ref":"#/components/schemas/WebhookSubscriptionResponseState"},"webhookId":{"type":"string","format":"uuid","nullable":true},"errors":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"UndoIntegrationFile":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"activityCorrelationId":{"type":"string","nullable":true},"channelCorrelationId":{"type":"string","nullable":true}},"additionalProperties":false},"IWebhook":{"type":"object","properties":{"tenantId":{"type":"string","nullable":true},"deletedAt":{"type":"string","format":"date-time","nullable":true},"url":{"type":"string","nullable":true},"isDeleted":{"type":"boolean"},"isActive":{"type":"boolean"},"secret":{"type":"string","nullable":true},"userIdentifier":{"type":"string","nullable":true},"events":{"type":"array","items":{"$ref":"#/components/schemas/IWebhookEventType"},"nullable":true},"id":{"type":"string","format":"uuid"},"thirdPartyApplicationName":{"type":"string","nullable":true}},"additionalProperties":false},"OnResourceWebhookSubscribeRequest":{"type":"object","properties":{"thirdPartyApplicationName":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"secret":{"type":"string","nullable":true},"eventTypes":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"ResponseResource":{"type":"object","properties":{"ok":{"type":"boolean"},"httpCode":{"type":"integer","format":"int32"},"result":{"type":"string","nullable":true},"messages":{"type":"array","items":{"$ref":"#/components/schemas/IMessageResource"},"nullable":true},"processId":{"type":"string","nullable":true},"appName":{"type":"string","nullable":true}},"additionalProperties":false},"IntegrationFile":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"date":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"origin":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"version":{"type":"string","format":"date-time"},"sequenceVersion":{"type":"integer","format":"int64"}},"additionalProperties":false},"ChangeUrlRequest":{"type":"object","properties":{"webhookId":{"type":"string","format":"uuid"},"url":{"type":"string","nullable":true}},"additionalProperties":false},"IIntegrationFileValidationEntityDetail":{"type":"object","properties":{"line":{"type":"integer","format":"int32"},"code":{"type":"string","nullable":true}},"additionalProperties":false},"IIntegrationFileSummaryErrorDetail":{"type":"object","properties":{"entity":{"type":"string","nullable":true},"message":{"type":"string","nullable":true}},"additionalProperties":false},"WebhookSubscriptionResponseState":{"enum":[0,1,2,3,4,5,6,7,8],"type":"integer","format":"int32"},"IIntegrationFileSummary":{"type":"object","properties":{"resume":{"type":"array","items":{"$ref":"#/components/schemas/IIntegrationFileSummaryResume"},"nullable":true},"errors":{"type":"array","items":{"$ref":"#/components/schemas/IIntegrationFileSummaryError"},"nullable":true}},"additionalProperties":false}},"parameters":{"pageNumber":{"name":"pageNumber","in":"query","description":"Specify the page to retrieve. Index starts at 1.","schema":{"maximum":99999,"minimum":1,"type":"integer","format":"int32"}},"pageSize":{"name":"pageSize","in":"query","description":"Number of results to be returned by page.","schema":{"maximum":1000,"minimum":1,"type":"integer","format":"int32"}},"context":{"name":"context","in":"header","description":"The company correlationId. Example: {\"clientId\": \"A3TFR:061602:CM:98d52a37-3659-4d01-a526-750888feb5d9\"}\n \"none\" for common requests.","required":true,"schema":{"type":"string"}}},"securitySchemes":{"apiKeyHeader":{"type":"apiKey","description":"a3developer portal subscription key","name":"Ocp-Apim-Subscription-Key","in":"header"},"Authorization":{"type":"http","description":"WKA OAuth authorization token","scheme":"bearer"}}},"security":[{"apiKeyHeader":[]},{"Authorization":[]}]},"markdown":"","status":"publicado","published_at":"2023-06-22T23:42:39.000Z","created_at":"2023-06-22T23:37:22.000Z","updated_at":"2023-09-29T00:12:29.000Z","buttons":[{"id":6,"name":"Consulta la definición de la API","type":"primary","order":0,"link":"https://wke-portal-pre.apimarket.io/apis/a3innuva-contabilidad-importia/swagger-ui","class":"secondary"}],"benefits":[],"tags":[],"image":[{"id":5,"name":"wk-api-a3innuva-contabilidad.png","alternativeText":"","caption":"","width":768,"height":530,"formats":{"thumbnail":{"name":"thumbnail_wk-api-a3innuva-contabilidad.png","hash":"thumbnail_wk_api_a3innuva_contabilidad_042d0c45a7","ext":".png","mime":"image/png","width":226,"height":156,"size":22.1,"path":null,"url":"https://wke-portal.apimarket.io/assets/thumbnail_wk_api_a3innuva_contabilidad_042d0c45a7.png"},"medium":{"name":"medium_wk-api-a3innuva-contabilidad.png","hash":"medium_wk_api_a3innuva_contabilidad_042d0c45a7","ext":".png","mime":"image/png","width":750,"height":518,"size":163.21,"path":null,"url":"https://wke-portal.apimarket.io/assets/medium_wk_api_a3innuva_contabilidad_042d0c45a7.png"},"small":{"name":"small_wk-api-a3innuva-contabilidad.png","hash":"small_wk_api_a3innuva_contabilidad_042d0c45a7","ext":".png","mime":"image/png","width":500,"height":345,"size":79.6,"path":null,"url":"https://wke-portal.apimarket.io/assets/small_wk_api_a3innuva_contabilidad_042d0c45a7.png"}},"hash":"wk_api_a3innuva_contabilidad_042d0c45a7","ext":".png","mime":"image/png","size":130.5,"url":"https://wke-portal.apimarket.io/assets/wk_api_a3innuva_contabilidad_042d0c45a7.png","previewUrl":null,"provider":"aws-s3-use-cdn","provider_metadata":null,"created_at":"2023-06-23T03:28:42.000Z","updated_at":"2023-06-23T03:28:43.000Z"}],"products":[]},{"id":2,"title":"API a3innuva Contabilidad","slug":"a3innuva-contabilidad","description":null,"color_status":null,"footerText":null,"version":null,"openDoc":{"openapi":"3.0.1","info":{"title":"API a3innuva Contabilidad","description":"API a3innuva Contabilidad","termsOfService":"https://a3developers.wolterskluwer.es/user/terms","contact":{"name":"Wolters Kluwer TAA a3developers","url":"https://a3developers.wolterskluwer.es","email":"a3developers@wolterskluwer.com"},"license":{"name":"Terms of Use","url":"https://a3developers.wolterskluwer.es/user/terms"},"version":"1.0"},"servers":[{"url":"https://a3api.wolterskluwer.es/a3innuva-contabilidad","description":"PRO"}],"paths":{"/api/accountBanks":{"get":{"tags":["Account Banks"],"summary":"Get all or filtered account bank","operationId":"get-api-accountbanks","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccountBank"}},"example":[{"correlationId":"string","iban":"string","accountCorrelationId":"string","accountCode":"string","state":"string","version":"string","sequenceVersion":0}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/accountBanks/{correlationId}":{"get":{"tags":["Account Banks"],"summary":"Get an account bank by correlationId","operationId":"get-api-accountbanks-correlationid","parameters":[{"name":"correlationId","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountBank"},"example":{"correlationId":"string","iban":"string","accountCorrelationId":"string","accountCode":"string","state":"string","version":"string","sequenceVersion":0}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/accountingYears":{"get":{"tags":["AccountingYears"],"summary":"Get all or filtered accounts","operationId":"get-api-accountingyears","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccountingYear"}},"example":[{"correlationId":"string","startDate":"string","endDate":"string","description":"string","profitAndLossBalanceId":0,"stateBalanceId":0,"state":"string","version":"string","sequenceVersion":0}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"post":{"tags":["AccountingYears"],"summary":"Open an accounting year","operationId":"post-api-accountingyears","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/OpenAccountingYear"},"example":{"correlationId":"string","startDate":"string","endDate":"string","profitAndLossBalanceId":0,"stateBalanceId":0,"type":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/OpenAccountingYear"},"example":{"correlationId":"string","startDate":"string","endDate":"string","profitAndLossBalanceId":0,"stateBalanceId":0,"type":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/OpenAccountingYear"},"example":{"correlationId":"string","startDate":"string","endDate":"string","profitAndLossBalanceId":0,"stateBalanceId":0,"type":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/OpenAccountingYear"},"example":{"correlationId":"string","startDate":"string","endDate":"string","profitAndLossBalanceId":0,"stateBalanceId":0,"type":"string"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/accountingYears/{correlationId}":{"get":{"tags":["AccountingYears"],"summary":"Get an account by correlationId","operationId":"get-api-accountingyears-correlationid","parameters":[{"name":"correlationId","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingYear"},"example":{"correlationId":"string","startDate":"string","endDate":"string","description":"string","profitAndLossBalanceId":0,"stateBalanceId":0,"state":"string","version":"string","sequenceVersion":0}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"delete":{"tags":["AccountingYears"],"summary":"Delete an accounting year","operationId":"delete-api-accountingyears-correlationid","parameters":[{"name":"correlationId","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/accounts":{"get":{"tags":["Accounts"],"summary":"Get all or filtered accounts","operationId":"get-api-accounts","parameters":[{"name":"AccountGroup","in":"query","schema":{"type":"string"}},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Account"}},"example":[{"correlationId":"string","code":"string","description":"string","state":"string","version":"string","sequenceVersion":0}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"post":{"tags":["Accounts"],"summary":"Create an account","operationId":"post-api-accounts","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CreateAccount"},"example":{"correlationId":"string","code":"string","description":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateAccount"},"example":{"correlationId":"string","code":"string","description":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateAccount"},"example":{"correlationId":"string","code":"string","description":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreateAccount"},"example":{"correlationId":"string","code":"string","description":"string"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"put":{"tags":["Accounts"],"summary":"Update an account","operationId":"put-api-accounts","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ModifyAccount"},"example":{"correlationId":"string","code":"string","description":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/ModifyAccount"},"example":{"correlationId":"string","code":"string","description":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/ModifyAccount"},"example":{"correlationId":"string","code":"string","description":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/ModifyAccount"},"example":{"correlationId":"string","code":"string","description":"string"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/accounts/{correlationId}":{"get":{"tags":["Accounts"],"summary":"Get an account by correlationId","operationId":"get-api-accounts-correlationid","parameters":[{"name":"correlationId","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"},"example":{"correlationId":"string","code":"string","description":"string","state":"string","version":"string","sequenceVersion":0}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/accountsFinder":{"get":{"tags":["Accounts"],"summary":"Get next available account code by an account code pattern","operationId":"get-api-accountsfinder","parameters":[{"name":"AccountCodePattern","in":"query","schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"},"example":"string"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/activities":{"get":{"tags":["Activities"],"summary":"Get all or filtered activities","operationId":"get-api-activities","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Activity"}},"example":[{"description":"string","shortDescription":"string","state":"string","startDate":"string","endDate":"string","correlationId":"string","taxation":"string","version":"string","sequenceVersion":0}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/activities/{correlationId}":{"get":{"tags":["Activities"],"summary":"Get an activity by correlationId","operationId":"get-api-activities-correlationid","parameters":[{"name":"correlationId","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Activity"},"example":{"description":"string","shortDescription":"string","state":"string","startDate":"string","endDate":"string","correlationId":"string","taxation":"string","version":"string","sequenceVersion":0}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/BalanceSheets/profitAndLost":{"get":{"tags":["BalanceSheets"],"summary":"Get all or filtered accounts","operationId":"get-api-balancesheets-profitandlost","parameters":[{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IReadAccountingYear"}},"example":[{"version":"string","sequenceVersion":0,"timestamp":0,"correlationId":"string","id":"string","tenantId":"string","partitionClientId":"string","startDate":{"day":0,"month":0,"ticks":0,"value":"string","year":0},"endDate":{"day":0,"month":0,"ticks":0,"value":"string","year":0},"description":"string","profitResultAccount":"string","loseResultAccount":"string","profitAndLossBalanceId":0,"stateBalanceId":0,"state":0}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/BalanceSheets/state":{"get":{"tags":["BalanceSheets"],"summary":"Get all or filtered accounts","operationId":"get-api-balancesheets-state","parameters":[{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IReadAccountingYear"}},"example":[{"version":"string","sequenceVersion":0,"timestamp":0,"correlationId":"string","id":"string","tenantId":"string","partitionClientId":"string","startDate":{"day":0,"month":0,"ticks":0,"value":"string","year":0},"endDate":{"day":0,"month":0,"ticks":0,"value":"string","year":0},"description":"string","profitResultAccount":"string","loseResultAccount":"string","profitAndLossBalanceId":0,"stateBalanceId":0,"state":0}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/channels":{"get":{"tags":["Channels"],"summary":"Get all or filtered channels","operationId":"get-api-channels","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}},"example":[{"description":"string","shortDescription":"string","state":"string","correlationId":"string","version":"string","sequenceVersion":0}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/channels/{correlationId}":{"get":{"tags":["Channels"],"summary":"Get a channel by correlationId","operationId":"get-api-channels-correlationid","parameters":[{"name":"correlationId","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Channel"},"example":{"description":"string","shortDescription":"string","state":"string","correlationId":"string","version":"string","sequenceVersion":0}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/charges":{"get":{"tags":["Charges"],"summary":"Get all or filtered charges","operationId":"get-api-charges","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Charge"}},"example":[{"customerCorrelationId":"string","customerAccountCorrelationId":"string","customerAccountCode":"string","issuedInvoiceCorrelationId":"string","issuedInvoiceNumber":"string","issuedInvoiceDate":"string","correlationId":"string","situation":"string","amount":0,"date":"string","accountBankCorrelationId":"string","accountBankCode":"string","state":"string","vatNumberCorrelationId":"string","vatNumber":"string","vatName":"string","journalCorrelationId":"string","version":"string","sequenceVersion":0}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"post":{"tags":["Charges"],"summary":"Create a charge","operationId":"post-api-charges","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CreateCharge"},"example":{"correlationId":"string","situation":"string","amount":0,"date":"string","accountBankCorrelationId":"string","issuedInvoiceCorrelationId":"string","createJournal":true}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateCharge"},"example":{"correlationId":"string","situation":"string","amount":0,"date":"string","accountBankCorrelationId":"string","issuedInvoiceCorrelationId":"string","createJournal":true}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateCharge"},"example":{"correlationId":"string","situation":"string","amount":0,"date":"string","accountBankCorrelationId":"string","issuedInvoiceCorrelationId":"string","createJournal":true}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreateCharge"},"example":{"correlationId":"string","situation":"string","amount":0,"date":"string","accountBankCorrelationId":"string","issuedInvoiceCorrelationId":"string","createJournal":true}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/charges/{correlationId}":{"get":{"tags":["Charges"],"summary":"Get a charge by correlationId","operationId":"get-api-charges-correlationid","parameters":[{"name":"correlationId","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"},"example":{"correlationId":"string","code":"string","description":"string","state":"string","version":"string","sequenceVersion":0}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"delete":{"tags":["Charges"],"summary":"Delete a charge by correlationId","operationId":"delete-api-charges-correlationid","parameters":[{"name":"correlationId","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/chartOfAccounts":{"get":{"tags":["ChartOfAccounts"],"summary":"Get chart of accounts","operationId":"get-api-chartofaccounts","parameters":[{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IChartOfAccount"}},"example":[{"id":0,"description":"string"}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/companies/{id}/chartofaccounts":{"put":{"tags":["ChartOfAccounts"],"summary":"Configure company chart of accounts","operationId":"put-api-companies-id-chartofaccounts","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ConfigureChartOfAccounts"},"example":{"chartOfAccountId":0,"accountsLength":0,"correlationId":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConfigureChartOfAccounts"},"example":{"chartOfAccountId":0,"accountsLength":0,"correlationId":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/ConfigureChartOfAccounts"},"example":{"chartOfAccountId":0,"accountsLength":0,"correlationId":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/ConfigureChartOfAccounts"},"example":{"chartOfAccountId":0,"accountsLength":0,"correlationId":"string"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/companies":{"get":{"tags":["Companies"],"summary":"Get all or filtered companies","operationId":"get-api-companies","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Company"}},"example":[{"vatName":"string","vatNumber":"string","state":"string","chartOfAccountId":0,"accountLength":0,"correlationId":"string","version":"string","sequenceVersion":0}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/companies/{correlationId}":{"get":{"tags":["Companies"],"summary":"Get a company by correlationId","operationId":"get-api-companies-correlationid","parameters":[{"name":"correlationId","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"},"example":{"vatName":"string","vatNumber":"string","state":"string","chartOfAccountId":0,"accountLength":0,"correlationId":"string","version":"string","sequenceVersion":0}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/customers":{"get":{"tags":["Customers"],"summary":"Get all or filtered customers","operationId":"get-api-customers","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}},"example":[{"tradeName":"string","state":"string","vatNumber":"string","vatName":"string","accountCode":"string","correlationId":"string","vatNumberCorrelationId":"string","accountCodeCorrelationId":"string","version":"string","sequenceVersion":0,"fiscalData":{"lines":[{"taxation":"string","transaction":"string","tax":"string","withHolding":"string","counterpartCorrelationId":"string","counterpart":"string","hasSurcharge":true}]}}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"post":{"tags":["Customers"],"summary":"Create a customer","operationId":"post-api-customers","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CreateCustomer"},"example":{"correlationId":"string","vatNumberCorrelationId":"string","accountCorrelationId":"string","tradeName":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomer"},"example":{"correlationId":"string","vatNumberCorrelationId":"string","accountCorrelationId":"string","tradeName":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateCustomer"},"example":{"correlationId":"string","vatNumberCorrelationId":"string","accountCorrelationId":"string","tradeName":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreateCustomer"},"example":{"correlationId":"string","vatNumberCorrelationId":"string","accountCorrelationId":"string","tradeName":"string"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"put":{"tags":["Customers"],"summary":"Update a customer","operationId":"put-api-customers","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ModifyCustomer"},"example":{"correlationId":"string","vatNumberCorrelationId":"string","tradeName":"string","state":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/ModifyCustomer"},"example":{"correlationId":"string","vatNumberCorrelationId":"string","tradeName":"string","state":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/ModifyCustomer"},"example":{"correlationId":"string","vatNumberCorrelationId":"string","tradeName":"string","state":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/ModifyCustomer"},"example":{"correlationId":"string","vatNumberCorrelationId":"string","tradeName":"string","state":"string"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/customers/{correlationId}":{"get":{"tags":["Customers"],"summary":"Get a customer by correlationId","operationId":"get-api-customers-correlationid","parameters":[{"name":"correlationId","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"},"example":{"tradeName":"string","state":"string","vatNumber":"string","vatName":"string","accountCode":"string","correlationId":"string","vatNumberCorrelationId":"string","accountCodeCorrelationId":"string","version":"string","sequenceVersion":0,"fiscalData":{"lines":[{"taxation":"string","transaction":"string","tax":"string","withHolding":"string","counterpartCorrelationId":"string","counterpart":"string","hasSurcharge":true}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/inputInvoices/{correlationId}/additionalData":{"get":{"tags":["Input Invoices"],"summary":"Get an input invoice additional data by correlationId","operationId":"get-api-inputinvoices-correlationid-additionaldata","parameters":[{"name":"correlationId","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InputInvoiceAdditionalDataResume"},"example":{"registryDate":"string","duaDocumentId":"string","description":"string","typeOfDocument":"string","fundamental":"string","initialNumberOfDocument":"string","lastNumberOfDocument":"string","invoicesInSpecialRegime":true,"taxableIncomeAtCost":0,"correlationId":"string","version":"string","sequenceVersion":0}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/inputInvoices/modifyAdditionalData":{"put":{"tags":["Input Invoices"],"summary":"Modify input invoice additional data","operationId":"put-api-inputinvoices-modifyadditionaldata","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/IModifyInputInvoiceAdditionalData"},"example":{"correlationId":"string","description":"string","typeOfDocument":"string","fundamental":"string","initialNumberOfDocument":"string","lastNumberOfDocument":"string","invoicesInSpecialRegime":true,"taxableIncomeAtCost":0,"registryDate":"string","duaDocumentId":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/IModifyInputInvoiceAdditionalData"},"example":{"correlationId":"string","description":"string","typeOfDocument":"string","fundamental":"string","initialNumberOfDocument":"string","lastNumberOfDocument":"string","invoicesInSpecialRegime":true,"taxableIncomeAtCost":0,"registryDate":"string","duaDocumentId":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/IModifyInputInvoiceAdditionalData"},"example":{"correlationId":"string","description":"string","typeOfDocument":"string","fundamental":"string","initialNumberOfDocument":"string","lastNumberOfDocument":"string","invoicesInSpecialRegime":true,"taxableIncomeAtCost":0,"registryDate":"string","duaDocumentId":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/IModifyInputInvoiceAdditionalData"},"example":{"correlationId":"string","description":"string","typeOfDocument":"string","fundamental":"string","initialNumberOfDocument":"string","lastNumberOfDocument":"string","invoicesInSpecialRegime":true,"taxableIncomeAtCost":0,"registryDate":"string","duaDocumentId":"string"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/inputInvoices":{"get":{"tags":["Input Invoices"],"summary":"Get all or filtered input invoices","operationId":"get-api-inputinvoices","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"name":"Document","in":"query","schema":{"type":"string"}},{"name":"InvoiceNumber","in":"query","schema":{"type":"string"}},{"name":"Year","in":"query","description":"Format - int32.","schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceInputResume"}},"example":[{"correlationId":"string","activityCorrelationId":"string","channelCorrelationId":"string","invoiceDate":"string","journalDate":"string","transactionDate":"string","invoiceNumber":"string","vatNumberCorrelationId":"string","tradeName":"string","isCorrective":true,"correctiveInvoiceNumber":"string","totalAmount":0,"approvalState":"string","lines":[{"transactionCorrelationId":0,"transaction":"string","taxCorrelationId":0,"tax":"string","baseAmount":0,"taxAmount":0,"taxSurchargeAmount":0,"withHoldingCorrelationId":0,"withHolding":"string","withHoldingAmount":0}],"source":"string","journalCorrelationId":"string","version":"string","sequenceVersion":0,"supplierCorrelationId":"string","activityShortDescription":"string","channelShortDescription":"string","vatName":"string","vatNumber":"string","state":"string"}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"post":{"tags":["Input Invoices"],"summary":"Create an input invoice","operationId":"post-api-inputinvoices","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ICreateInputInvoice"},"example":{"correlationId":"string","activityCorrelationId":"string","channelCorrelationId":"string","invoiceDate":"string","journalDate":"string","transactionDate":"string","invoiceNumber":"string","vatNumberCorrelationId":"string","isCorrective":true,"correctiveInvoiceNumber":"string","totalAmount":0,"createJournal":true,"approvalState":"string","createMaturity":true,"supplierCorrelationId":"string","lines":[{"transaction":"string","tax":"string","baseAmount":0,"taxAmount":0,"taxSurchargeAmount":0,"withHolding":"string","withHoldingAmount":0,"counterpartCorrelationId":"string","taxAmountDeductible":0,"taxSurchargeAmountDeductible":0,"applyProrate":true}]}},"application/json":{"schema":{"$ref":"#/components/schemas/ICreateInputInvoice"},"example":{"correlationId":"string","activityCorrelationId":"string","channelCorrelationId":"string","invoiceDate":"string","journalDate":"string","transactionDate":"string","invoiceNumber":"string","vatNumberCorrelationId":"string","isCorrective":true,"correctiveInvoiceNumber":"string","totalAmount":0,"createJournal":true,"approvalState":"string","createMaturity":true,"supplierCorrelationId":"string","lines":[{"transaction":"string","tax":"string","baseAmount":0,"taxAmount":0,"taxSurchargeAmount":0,"withHolding":"string","withHoldingAmount":0,"counterpartCorrelationId":"string","taxAmountDeductible":0,"taxSurchargeAmountDeductible":0,"applyProrate":true}]}},"text/json":{"schema":{"$ref":"#/components/schemas/ICreateInputInvoice"},"example":{"correlationId":"string","activityCorrelationId":"string","channelCorrelationId":"string","invoiceDate":"string","journalDate":"string","transactionDate":"string","invoiceNumber":"string","vatNumberCorrelationId":"string","isCorrective":true,"correctiveInvoiceNumber":"string","totalAmount":0,"createJournal":true,"approvalState":"string","createMaturity":true,"supplierCorrelationId":"string","lines":[{"transaction":"string","tax":"string","baseAmount":0,"taxAmount":0,"taxSurchargeAmount":0,"withHolding":"string","withHoldingAmount":0,"counterpartCorrelationId":"string","taxAmountDeductible":0,"taxSurchargeAmountDeductible":0,"applyProrate":true}]}},"application/*+json":{"schema":{"$ref":"#/components/schemas/ICreateInputInvoice"},"example":{"correlationId":"string","activityCorrelationId":"string","channelCorrelationId":"string","invoiceDate":"string","journalDate":"string","transactionDate":"string","invoiceNumber":"string","vatNumberCorrelationId":"string","isCorrective":true,"correctiveInvoiceNumber":"string","totalAmount":0,"createJournal":true,"approvalState":"string","createMaturity":true,"supplierCorrelationId":"string","lines":[{"transaction":"string","tax":"string","baseAmount":0,"taxAmount":0,"taxSurchargeAmount":0,"withHolding":"string","withHoldingAmount":0,"counterpartCorrelationId":"string","taxAmountDeductible":0,"taxSurchargeAmountDeductible":0,"applyProrate":true}]}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/inputInvoices/{correlationId}":{"get":{"tags":["Input Invoices"],"summary":"Get an input invoice by correlationId","operationId":"get-api-inputinvoices-correlationid","parameters":[{"name":"correlationId","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceInputResume"},"example":{"correlationId":"string","activityCorrelationId":"string","channelCorrelationId":"string","invoiceDate":"string","journalDate":"string","transactionDate":"string","invoiceNumber":"string","vatNumberCorrelationId":"string","tradeName":"string","isCorrective":true,"correctiveInvoiceNumber":"string","totalAmount":0,"approvalState":"string","lines":[{"transactionCorrelationId":0,"transaction":"string","taxCorrelationId":0,"tax":"string","baseAmount":0,"taxAmount":0,"taxSurchargeAmount":0,"withHoldingCorrelationId":0,"withHolding":"string","withHoldingAmount":0}],"source":"string","journalCorrelationId":"string","version":"string","sequenceVersion":0,"supplierCorrelationId":"string","activityShortDescription":"string","channelShortDescription":"string","vatName":"string","vatNumber":"string","state":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"delete":{"tags":["Input Invoices"],"summary":"Delete an input invoice","operationId":"delete-api-inputinvoices-correlationid","parameters":[{"name":"correlationId","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/inputInvoices/modifyHeader":{"put":{"tags":["Input Invoices"],"summary":"Modify input invoice header","operationId":"put-api-inputinvoices-modifyheader","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/IModifyInputInvoiceHeader"},"example":{"correlationId":"string","channelCorrelationId":"string","invoiceDate":"string","journalDate":"string","transactionDate":"string","invoiceNumber":"string","vatNumberCorrelationId":"string","isCorrective":true,"correctiveInvoiceNumber":"string","totalAmount":0,"approvalState":"string","supplierCorrelationId":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/IModifyInputInvoiceHeader"},"example":{"correlationId":"string","channelCorrelationId":"string","invoiceDate":"string","journalDate":"string","transactionDate":"string","invoiceNumber":"string","vatNumberCorrelationId":"string","isCorrective":true,"correctiveInvoiceNumber":"string","totalAmount":0,"approvalState":"string","supplierCorrelationId":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/IModifyInputInvoiceHeader"},"example":{"correlationId":"string","channelCorrelationId":"string","invoiceDate":"string","journalDate":"string","transactionDate":"string","invoiceNumber":"string","vatNumberCorrelationId":"string","isCorrective":true,"correctiveInvoiceNumber":"string","totalAmount":0,"approvalState":"string","supplierCorrelationId":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/IModifyInputInvoiceHeader"},"example":{"correlationId":"string","channelCorrelationId":"string","invoiceDate":"string","journalDate":"string","transactionDate":"string","invoiceNumber":"string","vatNumberCorrelationId":"string","isCorrective":true,"correctiveInvoiceNumber":"string","totalAmount":0,"approvalState":"string","supplierCorrelationId":"string"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/inputInvoices/modifyDetail":{"put":{"tags":["Input Invoices"],"summary":"Modify input invoice detail","operationId":"put-api-inputinvoices-modifydetail","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/IModifyInputInvoiceDetail"},"example":{"correlationId":"string","lines":[{"transaction":"string","tax":"string","baseAmount":0,"taxAmount":0,"taxSurchargeAmount":0,"withHolding":"string","withHoldingAmount":0,"counterpartCorrelationId":"string","taxAmountDeductible":0,"taxSurchargeAmountDeductible":0,"applyProrate":true}]}},"application/json":{"schema":{"$ref":"#/components/schemas/IModifyInputInvoiceDetail"},"example":{"correlationId":"string","lines":[{"transaction":"string","tax":"string","baseAmount":0,"taxAmount":0,"taxSurchargeAmount":0,"withHolding":"string","withHoldingAmount":0,"counterpartCorrelationId":"string","taxAmountDeductible":0,"taxSurchargeAmountDeductible":0,"applyProrate":true}]}},"text/json":{"schema":{"$ref":"#/components/schemas/IModifyInputInvoiceDetail"},"example":{"correlationId":"string","lines":[{"transaction":"string","tax":"string","baseAmount":0,"taxAmount":0,"taxSurchargeAmount":0,"withHolding":"string","withHoldingAmount":0,"counterpartCorrelationId":"string","taxAmountDeductible":0,"taxSurchargeAmountDeductible":0,"applyProrate":true}]}},"application/*+json":{"schema":{"$ref":"#/components/schemas/IModifyInputInvoiceDetail"},"example":{"correlationId":"string","lines":[{"transaction":"string","tax":"string","baseAmount":0,"taxAmount":0,"taxSurchargeAmount":0,"withHolding":"string","withHoldingAmount":0,"counterpartCorrelationId":"string","taxAmountDeductible":0,"taxSurchargeAmountDeductible":0,"applyProrate":true}]}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/issuedInvoices/{correlationId}/additionalData":{"get":{"tags":["Issued Invoices"],"summary":"Get an issued invoice additional data by correlationId","operationId":"get-api-issuedinvoices-correlationid-additionaldata","parameters":[{"name":"correlationId","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuedInvoiceAdditionalDataResume"},"example":{"notIncludedInCensus":true,"invoiceByThird":true,"multipleRecipients":true,"couponsBonusesOrDiscounts":true,"description":"string","typeOfDocument":"string","fundamental":"string","initialNumberOfDocument":"string","lastNumberOfDocument":"string","invoicesInSpecialRegime":true,"taxableIncomeAtCost":0,"correlationId":"string","version":"string","sequenceVersion":0}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/issuedInvoices/modifyAdditionalData":{"put":{"tags":["Issued Invoices"],"summary":"Modify issued invoice additional data","operationId":"put-api-issuedinvoices-modifyadditionaldata","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/IModifyIssuedInvoiceAdditionalData"},"example":{"correlationId":"string","description":"string","typeOfDocument":"string","fundamental":"string","initialNumberOfDocument":"string","lastNumberOfDocument":"string","invoicesInSpecialRegime":true,"taxableIncomeAtCost":0,"notIncludedInCensus":true,"invoiceByThird":true,"multipleRecipients":true,"couponsBonusesOrDiscounts":true}},"application/json":{"schema":{"$ref":"#/components/schemas/IModifyIssuedInvoiceAdditionalData"},"example":{"correlationId":"string","description":"string","typeOfDocument":"string","fundamental":"string","initialNumberOfDocument":"string","lastNumberOfDocument":"string","invoicesInSpecialRegime":true,"taxableIncomeAtCost":0,"notIncludedInCensus":true,"invoiceByThird":true,"multipleRecipients":true,"couponsBonusesOrDiscounts":true}},"text/json":{"schema":{"$ref":"#/components/schemas/IModifyIssuedInvoiceAdditionalData"},"example":{"correlationId":"string","description":"string","typeOfDocument":"string","fundamental":"string","initialNumberOfDocument":"string","lastNumberOfDocument":"string","invoicesInSpecialRegime":true,"taxableIncomeAtCost":0,"notIncludedInCensus":true,"invoiceByThird":true,"multipleRecipients":true,"couponsBonusesOrDiscounts":true}},"application/*+json":{"schema":{"$ref":"#/components/schemas/IModifyIssuedInvoiceAdditionalData"},"example":{"correlationId":"string","description":"string","typeOfDocument":"string","fundamental":"string","initialNumberOfDocument":"string","lastNumberOfDocument":"string","invoicesInSpecialRegime":true,"taxableIncomeAtCost":0,"notIncludedInCensus":true,"invoiceByThird":true,"multipleRecipients":true,"couponsBonusesOrDiscounts":true}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/issuedInvoices":{"get":{"tags":["Issued Invoices"],"summary":"Get all or filtered issued invoices","operationId":"get-api-issuedinvoices","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"name":"Document","in":"query","schema":{"type":"string"}},{"name":"InvoiceNumber","in":"query","schema":{"type":"string"}},{"name":"Year","in":"query","description":"Format - int32.","schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceIssuedResume"}},"example":[{"correlationId":"string","activityCorrelationId":"string","channelCorrelationId":"string","invoiceDate":"string","journalDate":"string","transactionDate":"string","invoiceNumber":"string","vatNumberCorrelationId":"string","tradeName":"string","isCorrective":true,"correctiveInvoiceNumber":"string","totalAmount":0,"approvalState":"string","lines":[{"transactionCorrelationId":0,"transaction":"string","taxCorrelationId":0,"tax":"string","baseAmount":0,"taxAmount":0,"taxSurchargeAmount":0,"withHoldingCorrelationId":0,"withHolding":"string","withHoldingAmount":0}],"source":"string","journalCorrelationId":"string","version":"string","sequenceVersion":0,"customerCorrelationId":"string","activityShortDescription":"string","channelShortDescription":"string","vatName":"string","vatNumber":"string","state":"string"}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"post":{"tags":["Issued Invoices"],"summary":"Create an issued invoice","operationId":"post-api-issuedinvoices","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ICreateIssuedInvoice"},"example":{"correlationId":"string","activityCorrelationId":"string","channelCorrelationId":"string","invoiceDate":"string","journalDate":"string","transactionDate":"string","invoiceNumber":"string","vatNumberCorrelationId":"string","isCorrective":true,"correctiveInvoiceNumber":"string","totalAmount":0,"createJournal":true,"approvalState":"string","createMaturity":true,"customerCorrelationId":"string","lines":[{"transaction":"string","tax":"string","baseAmount":0,"taxAmount":0,"taxSurchargeAmount":0,"withHolding":"string","withHoldingAmount":0,"counterpartCorrelationId":"string"}]}},"application/json":{"schema":{"$ref":"#/components/schemas/ICreateIssuedInvoice"},"example":{"correlationId":"string","activityCorrelationId":"string","channelCorrelationId":"string","invoiceDate":"string","journalDate":"string","transactionDate":"string","invoiceNumber":"string","vatNumberCorrelationId":"string","isCorrective":true,"correctiveInvoiceNumber":"string","totalAmount":0,"createJournal":true,"approvalState":"string","createMaturity":true,"customerCorrelationId":"string","lines":[{"transaction":"string","tax":"string","baseAmount":0,"taxAmount":0,"taxSurchargeAmount":0,"withHolding":"string","withHoldingAmount":0,"counterpartCorrelationId":"string"}]}},"text/json":{"schema":{"$ref":"#/components/schemas/ICreateIssuedInvoice"},"example":{"correlationId":"string","activityCorrelationId":"string","channelCorrelationId":"string","invoiceDate":"string","journalDate":"string","transactionDate":"string","invoiceNumber":"string","vatNumberCorrelationId":"string","isCorrective":true,"correctiveInvoiceNumber":"string","totalAmount":0,"createJournal":true,"approvalState":"string","createMaturity":true,"customerCorrelationId":"string","lines":[{"transaction":"string","tax":"string","baseAmount":0,"taxAmount":0,"taxSurchargeAmount":0,"withHolding":"string","withHoldingAmount":0,"counterpartCorrelationId":"string"}]}},"application/*+json":{"schema":{"$ref":"#/components/schemas/ICreateIssuedInvoice"},"example":{"correlationId":"string","activityCorrelationId":"string","channelCorrelationId":"string","invoiceDate":"string","journalDate":"string","transactionDate":"string","invoiceNumber":"string","vatNumberCorrelationId":"string","isCorrective":true,"correctiveInvoiceNumber":"string","totalAmount":0,"createJournal":true,"approvalState":"string","createMaturity":true,"customerCorrelationId":"string","lines":[{"transaction":"string","tax":"string","baseAmount":0,"taxAmount":0,"taxSurchargeAmount":0,"withHolding":"string","withHoldingAmount":0,"counterpartCorrelationId":"string"}]}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/issuedInvoices/{correlationId}":{"get":{"tags":["Issued Invoices"],"summary":"Get an issued invoice by correlationId","operationId":"get-api-issuedinvoices-correlationid","parameters":[{"name":"correlationId","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceIssuedResume"},"example":{"correlationId":"string","activityCorrelationId":"string","channelCorrelationId":"string","invoiceDate":"string","journalDate":"string","transactionDate":"string","invoiceNumber":"string","vatNumberCorrelationId":"string","tradeName":"string","isCorrective":true,"correctiveInvoiceNumber":"string","totalAmount":0,"approvalState":"string","lines":[{"transactionCorrelationId":0,"transaction":"string","taxCorrelationId":0,"tax":"string","baseAmount":0,"taxAmount":0,"taxSurchargeAmount":0,"withHoldingCorrelationId":0,"withHolding":"string","withHoldingAmount":0}],"source":"string","journalCorrelationId":"string","version":"string","sequenceVersion":0,"customerCorrelationId":"string","activityShortDescription":"string","channelShortDescription":"string","vatName":"string","vatNumber":"string","state":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"delete":{"tags":["Issued Invoices"],"summary":"Delete an issued invoice","operationId":"delete-api-issuedinvoices-correlationid","parameters":[{"name":"correlationId","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/issuedInvoices/modifyHeader":{"put":{"tags":["Issued Invoices"],"summary":"Modify issued invoice header","operationId":"put-api-issuedinvoices-modifyheader","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/IModifyIssuedInvoiceHeader"},"example":{"correlationId":"string","channelCorrelationId":"string","invoiceDate":"string","journalDate":"string","transactionDate":"string","invoiceNumber":"string","vatNumberCorrelationId":"string","isCorrective":true,"correctiveInvoiceNumber":"string","totalAmount":0,"approvalState":"string","customerCorrelationId":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/IModifyIssuedInvoiceHeader"},"example":{"correlationId":"string","channelCorrelationId":"string","invoiceDate":"string","journalDate":"string","transactionDate":"string","invoiceNumber":"string","vatNumberCorrelationId":"string","isCorrective":true,"correctiveInvoiceNumber":"string","totalAmount":0,"approvalState":"string","customerCorrelationId":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/IModifyIssuedInvoiceHeader"},"example":{"correlationId":"string","channelCorrelationId":"string","invoiceDate":"string","journalDate":"string","transactionDate":"string","invoiceNumber":"string","vatNumberCorrelationId":"string","isCorrective":true,"correctiveInvoiceNumber":"string","totalAmount":0,"approvalState":"string","customerCorrelationId":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/IModifyIssuedInvoiceHeader"},"example":{"correlationId":"string","channelCorrelationId":"string","invoiceDate":"string","journalDate":"string","transactionDate":"string","invoiceNumber":"string","vatNumberCorrelationId":"string","isCorrective":true,"correctiveInvoiceNumber":"string","totalAmount":0,"approvalState":"string","customerCorrelationId":"string"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/issuedInvoices/modifyDetail":{"put":{"tags":["Issued Invoices"],"summary":"Modify issued invoice detail","operationId":"put-api-issuedinvoices-modifydetail","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/IModifyIssuedInvoiceDetail"},"example":{"correlationId":"string","lines":[{"transaction":"string","tax":"string","baseAmount":0,"taxAmount":0,"taxSurchargeAmount":0,"withHolding":"string","withHoldingAmount":0,"counterpartCorrelationId":"string"}]}},"application/json":{"schema":{"$ref":"#/components/schemas/IModifyIssuedInvoiceDetail"},"example":{"correlationId":"string","lines":[{"transaction":"string","tax":"string","baseAmount":0,"taxAmount":0,"taxSurchargeAmount":0,"withHolding":"string","withHoldingAmount":0,"counterpartCorrelationId":"string"}]}},"text/json":{"schema":{"$ref":"#/components/schemas/IModifyIssuedInvoiceDetail"},"example":{"correlationId":"string","lines":[{"transaction":"string","tax":"string","baseAmount":0,"taxAmount":0,"taxSurchargeAmount":0,"withHolding":"string","withHoldingAmount":0,"counterpartCorrelationId":"string"}]}},"application/*+json":{"schema":{"$ref":"#/components/schemas/IModifyIssuedInvoiceDetail"},"example":{"correlationId":"string","lines":[{"transaction":"string","tax":"string","baseAmount":0,"taxAmount":0,"taxSurchargeAmount":0,"withHolding":"string","withHoldingAmount":0,"counterpartCorrelationId":"string"}]}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/journals":{"get":{"tags":["Journals"],"summary":"Get all or filtered journals","operationId":"get-api-journals","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JournalResume"}},"example":[{"version":"string","sequenceVersion":0,"correlationId":"string","activityCorrelationId":"string","activityShortDescription":"string","channelShortDescription":"string","channelCorrelationId":"string","journalDate":"string","approvalState":"string","state":"string","lines":[{"document":"string","concept":"string","accountCorrelationId":"string","accountCode":"string","accountDescription":"string","isAmountOnDebit":true,"amount":0,"journalLineType":"string"}],"source":"string","journalType":"string"}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"post":{"tags":["Journals"],"summary":"Create a journal","operationId":"post-api-journals","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CreateJournal"},"example":{"correlationId":"string","activityCorrelationId":"string","channelCorrelationId":"string","journalDate":"string","approvalState":"string","journalType":"string","lines":[{"document":"string","concept":"string","accountCorrelationId":"string","isAmountOnDebit":true,"amount":0}],"maturityCorrelationId":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateJournal"},"example":{"correlationId":"string","activityCorrelationId":"string","channelCorrelationId":"string","journalDate":"string","approvalState":"string","journalType":"string","lines":[{"document":"string","concept":"string","accountCorrelationId":"string","isAmountOnDebit":true,"amount":0}],"maturityCorrelationId":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateJournal"},"example":{"correlationId":"string","activityCorrelationId":"string","channelCorrelationId":"string","journalDate":"string","approvalState":"string","journalType":"string","lines":[{"document":"string","concept":"string","accountCorrelationId":"string","isAmountOnDebit":true,"amount":0}],"maturityCorrelationId":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreateJournal"},"example":{"correlationId":"string","activityCorrelationId":"string","channelCorrelationId":"string","journalDate":"string","approvalState":"string","journalType":"string","lines":[{"document":"string","concept":"string","accountCorrelationId":"string","isAmountOnDebit":true,"amount":0}],"maturityCorrelationId":"string"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/journals/{correlationId}":{"get":{"tags":["Journals"],"summary":"Get journal by correlationId","operationId":"get-api-journals-correlationid","parameters":[{"name":"correlationId","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JournalResume"},"example":{"version":"string","sequenceVersion":0,"correlationId":"string","activityCorrelationId":"string","activityShortDescription":"string","channelShortDescription":"string","channelCorrelationId":"string","journalDate":"string","approvalState":"string","state":"string","lines":[{"document":"string","concept":"string","accountCorrelationId":"string","accountCode":"string","accountDescription":"string","isAmountOnDebit":true,"amount":0,"journalLineType":"string"}],"source":"string","journalType":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"delete":{"tags":["Journals"],"summary":"Delete a journal by correlationId","operationId":"delete-api-journals-correlationid","parameters":[{"name":"correlationId","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/payments":{"get":{"tags":["Payments"],"summary":"Get all or filtered payments","operationId":"get-api-payments","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Payment"}},"example":[{"supplierCorrelationId":"string","supplierAccountCorrelationId":"string","supplierAccountCode":"string","inputInvoiceCorrelationId":"string","inputInvoiceNumber":"string","inputInvoiceDate":"string","correlationId":"string","situation":"string","amount":0,"date":"string","accountBankCorrelationId":"string","accountBankCode":"string","state":"string","vatNumberCorrelationId":"string","vatNumber":"string","vatName":"string","journalCorrelationId":"string","version":"string","sequenceVersion":0}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"post":{"tags":["Payments"],"summary":"Create a payment","operationId":"post-api-payments","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CreatePayment"},"example":{"correlationId":"string","situation":"string","amount":0,"date":"string","accountBankCorrelationId":"string","inputInvoiceCorrelationId":"string","createJournal":true}},"application/json":{"schema":{"$ref":"#/components/schemas/CreatePayment"},"example":{"correlationId":"string","situation":"string","amount":0,"date":"string","accountBankCorrelationId":"string","inputInvoiceCorrelationId":"string","createJournal":true}},"text/json":{"schema":{"$ref":"#/components/schemas/CreatePayment"},"example":{"correlationId":"string","situation":"string","amount":0,"date":"string","accountBankCorrelationId":"string","inputInvoiceCorrelationId":"string","createJournal":true}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreatePayment"},"example":{"correlationId":"string","situation":"string","amount":0,"date":"string","accountBankCorrelationId":"string","inputInvoiceCorrelationId":"string","createJournal":true}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/payments/{correlationId}":{"get":{"tags":["Payments"],"summary":"Get a payment by correlationId","operationId":"get-api-payments-correlationid","parameters":[{"name":"correlationId","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment"},"example":{"supplierCorrelationId":"string","supplierAccountCorrelationId":"string","supplierAccountCode":"string","inputInvoiceCorrelationId":"string","inputInvoiceNumber":"string","inputInvoiceDate":"string","correlationId":"string","situation":"string","amount":0,"date":"string","accountBankCorrelationId":"string","accountBankCode":"string","state":"string","vatNumberCorrelationId":"string","vatNumber":"string","vatName":"string","journalCorrelationId":"string","version":"string","sequenceVersion":0}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"delete":{"tags":["Payments"],"summary":"Delete a payment by correlationId","operationId":"delete-api-payments-correlationid","parameters":[{"name":"correlationId","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/suppliers":{"get":{"tags":["Suppliers"],"summary":"Get all or filtered suppliers","operationId":"get-api-suppliers","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Supplier"}},"example":[{"tradeName":"string","state":"string","vatNumber":"string","vatName":"string","accountCode":"string","correlationId":"string","vatNumberCorrelationId":"string","accountCodeCorrelationId":"string","version":"string","sequenceVersion":0,"fiscalData":{"lines":[{"taxation":"string","transaction":"string","tax":"string","withHolding":"string","counterpartCorrelationId":"string","counterpart":"string","hasSurcharge":true}]}}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"post":{"tags":["Suppliers"],"summary":"Create a supplier","operationId":"post-api-suppliers","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CreateSupplier"},"example":{"correlationId":"string","vatNumberCorrelationId":"string","accountCorrelationId":"string","tradeName":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateSupplier"},"example":{"correlationId":"string","vatNumberCorrelationId":"string","accountCorrelationId":"string","tradeName":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateSupplier"},"example":{"correlationId":"string","vatNumberCorrelationId":"string","accountCorrelationId":"string","tradeName":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreateSupplier"},"example":{"correlationId":"string","vatNumberCorrelationId":"string","accountCorrelationId":"string","tradeName":"string"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"put":{"tags":["Suppliers"],"summary":"Update a supplier","operationId":"put-api-suppliers","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ModifySupplier"},"example":{"correlationId":"string","vatNumberCorrelationId":"string","tradeName":"string","state":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/ModifySupplier"},"example":{"correlationId":"string","vatNumberCorrelationId":"string","tradeName":"string","state":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/ModifySupplier"},"example":{"correlationId":"string","vatNumberCorrelationId":"string","tradeName":"string","state":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/ModifySupplier"},"example":{"correlationId":"string","vatNumberCorrelationId":"string","tradeName":"string","state":"string"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/suppliers/{correlationId}":{"get":{"tags":["Suppliers"],"summary":"Get a supplier by correlationId","operationId":"get-api-suppliers-correlationid","parameters":[{"name":"correlationId","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Supplier"},"example":{"tradeName":"string","state":"string","vatNumber":"string","vatName":"string","accountCode":"string","correlationId":"string","vatNumberCorrelationId":"string","accountCodeCorrelationId":"string","version":"string","sequenceVersion":0,"fiscalData":{"lines":[{"taxation":"string","transaction":"string","tax":"string","withHolding":"string","counterpartCorrelationId":"string","counterpart":"string","hasSurcharge":true}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/taxes":{"get":{"tags":["Taxes"],"summary":"Get all or filtered taxes","operationId":"get-api-taxes","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"name":"Type","in":"query","description":"Format - int32.","schema":{"$ref":"#/components/schemas/QueryTaxType"}},{"name":"Code","in":"query","schema":{"type":"string"}},{"name":"Date","in":"query","description":"Format - date-time (as date-time in RFC3339).","schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TaxInfo"}},"example":[{"id":0,"code":"string","description":"string","percentage":0,"surchargePercentage":0,"hasSurcharge":true,"type":"string","startDate":"string","endDate":"string"}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/taxes/{id}":{"get":{"tags":["Taxes"],"summary":"Get a tax by id","operationId":"get-api-taxes-id","parameters":[{"name":"id","in":"path","description":"Format - int32.","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxInfo"},"example":{"id":0,"code":"string","description":"string","percentage":0,"surchargePercentage":0,"hasSurcharge":true,"type":"string","startDate":"string","endDate":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/transactions/inputInvoices":{"get":{"tags":["Transaction"],"summary":"Get all transaction for input invoices","operationId":"get-api-transactions-inputinvoices","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TransactionResume"}},"example":[{"taxation":"string","longCode":"string","description":"string","shortDescription":"string","startDate":"string","endDate":"string","validTaxTypes":["string"]}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/transactions/issuedInvoices":{"get":{"tags":["Transaction"],"summary":"Get all transactions for issued invoices","operationId":"get-api-transactions-issuedinvoices","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/context"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TransactionResume"}},"example":[{"taxation":"string","longCode":"string","description":"string","shortDescription":"string","startDate":"string","endDate":"string","validTaxTypes":["string"]}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}}},"components":{"schemas":{"Account":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"code":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"version":{"type":"string","format":"date-time"},"sequenceVersion":{"type":"integer","format":"int64"}},"additionalProperties":false},"AccountBank":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"iban":{"type":"string","nullable":true},"accountCorrelationId":{"type":"string","nullable":true},"accountCode":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"version":{"type":"string","format":"date-time"},"sequenceVersion":{"type":"integer","format":"int64"}},"additionalProperties":false},"AccountingYear":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"startDate":{"type":"string","format":"date-time"},"endDate":{"type":"string","format":"date-time"},"description":{"type":"string","nullable":true},"profitAndLossBalanceId":{"type":"integer","format":"int64"},"stateBalanceId":{"type":"integer","format":"int64"},"state":{"type":"string","nullable":true},"version":{"type":"string","format":"date-time"},"sequenceVersion":{"type":"integer","format":"int64"}},"additionalProperties":false},"AccountingYearState":{"enum":[0,1,2,3,99],"type":"integer","format":"int32"},"Activity":{"type":"object","properties":{"description":{"type":"string","nullable":true},"shortDescription":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"startDate":{"type":"string","nullable":true},"endDate":{"type":"string","nullable":true},"correlationId":{"type":"string","nullable":true},"taxation":{"type":"string","nullable":true},"version":{"type":"string","format":"date-time"},"sequenceVersion":{"type":"integer","format":"int64"}},"additionalProperties":false},"ChangeEnableStatusRequest":{"type":"object","properties":{"webhookId":{"type":"string","format":"uuid"},"enable":{"type":"boolean"}},"additionalProperties":false},"ChangeUrlRequest":{"type":"object","properties":{"webhookId":{"type":"string","format":"uuid"},"url":{"type":"string","nullable":true}},"additionalProperties":false},"Channel":{"type":"object","properties":{"description":{"type":"string","nullable":true},"shortDescription":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"correlationId":{"type":"string","nullable":true},"version":{"type":"string","format":"date-time"},"sequenceVersion":{"type":"integer","format":"int64"}},"additionalProperties":false},"Charge":{"type":"object","properties":{"customerCorrelationId":{"type":"string","nullable":true},"customerAccountCorrelationId":{"type":"string","nullable":true},"customerAccountCode":{"type":"string","nullable":true},"issuedInvoiceCorrelationId":{"type":"string","nullable":true},"issuedInvoiceNumber":{"type":"string","nullable":true},"issuedInvoiceDate":{"type":"string","nullable":true},"correlationId":{"type":"string","nullable":true},"situation":{"type":"string","nullable":true},"amount":{"type":"number","format":"double"},"date":{"type":"string","nullable":true},"accountBankCorrelationId":{"type":"string","nullable":true},"accountBankCode":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"vatNumberCorrelationId":{"type":"string","nullable":true},"vatNumber":{"type":"string","nullable":true},"vatName":{"type":"string","nullable":true},"journalCorrelationId":{"type":"string","nullable":true},"version":{"type":"string","format":"date-time"},"sequenceVersion":{"type":"integer","format":"int64"}},"additionalProperties":false},"Company":{"type":"object","properties":{"vatName":{"type":"string","nullable":true},"vatNumber":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"chartOfAccountId":{"type":"integer","format":"int64","nullable":true},"accountLength":{"type":"integer","format":"int32","nullable":true},"correlationId":{"type":"string","nullable":true},"version":{"type":"string","format":"date-time"},"sequenceVersion":{"type":"integer","format":"int64"}},"additionalProperties":false},"ConfigureChartOfAccounts":{"type":"object","properties":{"chartOfAccountId":{"type":"integer","format":"int32"},"accountsLength":{"type":"integer","format":"int32"},"correlationId":{"type":"string","nullable":true}},"additionalProperties":false},"CreateAccount":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"code":{"type":"string","nullable":true},"description":{"type":"string","nullable":true}},"additionalProperties":false},"CreateCharge":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"situation":{"type":"string","nullable":true},"amount":{"type":"number","format":"double"},"date":{"type":"string","format":"date-time"},"accountBankCorrelationId":{"type":"string","nullable":true},"issuedInvoiceCorrelationId":{"type":"string","nullable":true},"createJournal":{"type":"boolean"}},"additionalProperties":false},"CreateCustomer":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"vatNumberCorrelationId":{"type":"string","nullable":true},"accountCorrelationId":{"type":"string","nullable":true},"tradeName":{"type":"string","nullable":true}},"additionalProperties":false},"CreateJournal":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"activityCorrelationId":{"type":"string","nullable":true},"channelCorrelationId":{"type":"string","nullable":true},"journalDate":{"type":"string","format":"date-time"},"approvalState":{"type":"string","nullable":true},"journalType":{"type":"string","nullable":true},"lines":{"type":"array","items":{"$ref":"#/components/schemas/IJournalLine"},"nullable":true},"maturityCorrelationId":{"type":"string","nullable":true}},"additionalProperties":false},"CreatePayment":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"situation":{"type":"string","nullable":true},"amount":{"type":"number","format":"double"},"date":{"type":"string","format":"date-time"},"accountBankCorrelationId":{"type":"string","nullable":true},"inputInvoiceCorrelationId":{"type":"string","nullable":true},"createJournal":{"type":"boolean"}},"additionalProperties":false},"CreateSupplier":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"vatNumberCorrelationId":{"type":"string","nullable":true},"accountCorrelationId":{"type":"string","nullable":true},"tradeName":{"type":"string","nullable":true}},"additionalProperties":false},"Customer":{"type":"object","properties":{"tradeName":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"vatNumber":{"type":"string","nullable":true},"vatName":{"type":"string","nullable":true},"accountCode":{"type":"string","nullable":true},"correlationId":{"type":"string","nullable":true},"vatNumberCorrelationId":{"type":"string","nullable":true},"accountCodeCorrelationId":{"type":"string","nullable":true},"version":{"type":"string","format":"date-time"},"sequenceVersion":{"type":"integer","format":"int64"},"fiscalData":{"$ref":"#/components/schemas/IFiscalData"}},"additionalProperties":false},"Date":{"type":"object","properties":{"day":{"type":"integer","format":"int32","readOnly":true},"month":{"type":"integer","format":"int32","readOnly":true},"ticks":{"type":"integer","format":"int64","readOnly":true},"value":{"type":"string","nullable":true},"year":{"type":"integer","format":"int32","readOnly":true}},"additionalProperties":false},"IAPIInputInvoiceLine":{"type":"object","properties":{"transaction":{"type":"string","nullable":true},"tax":{"type":"string","nullable":true},"baseAmount":{"type":"number","format":"double"},"taxAmount":{"type":"number","format":"double","nullable":true},"taxSurchargeAmount":{"type":"number","format":"double","nullable":true},"withHolding":{"type":"string","nullable":true},"withHoldingAmount":{"type":"number","format":"double","nullable":true},"counterpartCorrelationId":{"type":"string","nullable":true},"taxAmountDeductible":{"type":"number","format":"double","nullable":true},"taxSurchargeAmountDeductible":{"type":"number","format":"double","nullable":true},"applyProrate":{"type":"boolean"}},"additionalProperties":false},"IAPIIssuedInvoiceLine":{"type":"object","properties":{"transaction":{"type":"string","nullable":true},"tax":{"type":"string","nullable":true},"baseAmount":{"type":"number","format":"double"},"taxAmount":{"type":"number","format":"double","nullable":true},"taxSurchargeAmount":{"type":"number","format":"double","nullable":true},"withHolding":{"type":"string","nullable":true},"withHoldingAmount":{"type":"number","format":"double","nullable":true},"counterpartCorrelationId":{"type":"string","nullable":true}},"additionalProperties":false},"IChartOfAccount":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"description":{"type":"string","nullable":true}},"additionalProperties":false},"ICreateInputInvoice":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"activityCorrelationId":{"type":"string","nullable":true},"channelCorrelationId":{"type":"string","nullable":true},"invoiceDate":{"type":"string","format":"date-time"},"journalDate":{"type":"string","format":"date-time"},"transactionDate":{"type":"string","format":"date-time","nullable":true},"invoiceNumber":{"type":"string","nullable":true},"vatNumberCorrelationId":{"type":"string","nullable":true},"isCorrective":{"type":"boolean"},"correctiveInvoiceNumber":{"type":"string","nullable":true},"totalAmount":{"type":"number","format":"double"},"createJournal":{"type":"boolean"},"approvalState":{"type":"string","nullable":true},"createMaturity":{"type":"boolean"},"supplierCorrelationId":{"type":"string","nullable":true},"lines":{"type":"array","items":{"$ref":"#/components/schemas/IAPIInputInvoiceLine"},"nullable":true}},"additionalProperties":false},"ICreateIssuedInvoice":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"activityCorrelationId":{"type":"string","nullable":true},"channelCorrelationId":{"type":"string","nullable":true},"invoiceDate":{"type":"string","format":"date-time"},"journalDate":{"type":"string","format":"date-time"},"transactionDate":{"type":"string","format":"date-time","nullable":true},"invoiceNumber":{"type":"string","nullable":true},"vatNumberCorrelationId":{"type":"string","nullable":true},"isCorrective":{"type":"boolean"},"correctiveInvoiceNumber":{"type":"string","nullable":true},"totalAmount":{"type":"number","format":"double"},"createJournal":{"type":"boolean"},"approvalState":{"type":"string","nullable":true},"createMaturity":{"type":"boolean"},"customerCorrelationId":{"type":"string","nullable":true},"lines":{"type":"array","items":{"$ref":"#/components/schemas/IAPIIssuedInvoiceLine"},"nullable":true}},"additionalProperties":false},"IFiscalData":{"type":"object","properties":{"lines":{"type":"array","items":{"$ref":"#/components/schemas/IFiscalDataTaxConfiguration"},"nullable":true}},"additionalProperties":false},"IFiscalDataTaxConfiguration":{"type":"object","properties":{"taxation":{"type":"string","nullable":true},"transaction":{"type":"string","nullable":true},"tax":{"type":"string","nullable":true},"withHolding":{"type":"string","nullable":true},"counterpartCorrelationId":{"type":"string","nullable":true},"counterpart":{"type":"string","nullable":true},"hasSurcharge":{"type":"boolean"}},"additionalProperties":false},"IInvoiceLineResume":{"type":"object","properties":{"transactionCorrelationId":{"type":"integer","format":"int64"},"transaction":{"type":"string","nullable":true},"taxCorrelationId":{"type":"integer","format":"int32","nullable":true},"tax":{"type":"string","nullable":true},"baseAmount":{"type":"number","format":"double"},"taxAmount":{"type":"number","format":"double","nullable":true},"taxSurchargeAmount":{"type":"number","format":"double","nullable":true},"withHoldingCorrelationId":{"type":"integer","format":"int32","nullable":true},"withHolding":{"type":"string","nullable":true},"withHoldingAmount":{"type":"number","format":"double","nullable":true}},"additionalProperties":false},"IJournalLine":{"type":"object","properties":{"document":{"type":"string","nullable":true},"concept":{"type":"string","nullable":true},"accountCorrelationId":{"type":"string","nullable":true},"isAmountOnDebit":{"type":"boolean"},"amount":{"type":"number","format":"double"}},"additionalProperties":false},"IJournalLineResume":{"type":"object","properties":{"document":{"type":"string","nullable":true},"concept":{"type":"string","nullable":true},"accountCorrelationId":{"type":"string","nullable":true},"accountCode":{"type":"string","nullable":true},"accountDescription":{"type":"string","nullable":true},"isAmountOnDebit":{"type":"boolean"},"amount":{"type":"number","format":"double"},"journalLineType":{"type":"string","nullable":true}},"additionalProperties":false},"IMessageResource":{"type":"object","properties":{"type":{"type":"string","nullable":true},"description":{"type":"string","nullable":true}},"additionalProperties":false},"IModifyInputInvoiceAdditionalData":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"typeOfDocument":{"type":"string","nullable":true},"fundamental":{"type":"string","nullable":true},"initialNumberOfDocument":{"type":"string","nullable":true},"lastNumberOfDocument":{"type":"string","nullable":true},"invoicesInSpecialRegime":{"type":"boolean"},"taxableIncomeAtCost":{"type":"number","format":"double"},"registryDate":{"type":"string","format":"date-time"},"duaDocumentId":{"type":"string","nullable":true}},"additionalProperties":false},"IModifyInputInvoiceDetail":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"lines":{"type":"array","items":{"$ref":"#/components/schemas/IAPIInputInvoiceLine"},"nullable":true}},"additionalProperties":false},"IModifyInputInvoiceHeader":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"channelCorrelationId":{"type":"string","nullable":true},"invoiceDate":{"type":"string","format":"date-time"},"journalDate":{"type":"string","format":"date-time"},"transactionDate":{"type":"string","format":"date-time","nullable":true},"invoiceNumber":{"type":"string","nullable":true},"vatNumberCorrelationId":{"type":"string","nullable":true},"isCorrective":{"type":"boolean"},"correctiveInvoiceNumber":{"type":"string","nullable":true},"totalAmount":{"type":"number","format":"double"},"approvalState":{"type":"string","nullable":true},"supplierCorrelationId":{"type":"string","nullable":true}},"additionalProperties":false},"IModifyIssuedInvoiceAdditionalData":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"typeOfDocument":{"type":"string","nullable":true},"fundamental":{"type":"string","nullable":true},"initialNumberOfDocument":{"type":"string","nullable":true},"lastNumberOfDocument":{"type":"string","nullable":true},"invoicesInSpecialRegime":{"type":"boolean"},"taxableIncomeAtCost":{"type":"number","format":"double"},"notIncludedInCensus":{"type":"boolean"},"invoiceByThird":{"type":"boolean"},"multipleRecipients":{"type":"boolean"},"couponsBonusesOrDiscounts":{"type":"boolean"}},"additionalProperties":false},"IModifyIssuedInvoiceDetail":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"lines":{"type":"array","items":{"$ref":"#/components/schemas/IAPIIssuedInvoiceLine"},"nullable":true}},"additionalProperties":false},"IModifyIssuedInvoiceHeader":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"channelCorrelationId":{"type":"string","nullable":true},"invoiceDate":{"type":"string","format":"date-time"},"journalDate":{"type":"string","format":"date-time"},"transactionDate":{"type":"string","format":"date-time","nullable":true},"invoiceNumber":{"type":"string","nullable":true},"vatNumberCorrelationId":{"type":"string","nullable":true},"isCorrective":{"type":"boolean"},"correctiveInvoiceNumber":{"type":"string","nullable":true},"totalAmount":{"type":"number","format":"double"},"approvalState":{"type":"string","nullable":true},"customerCorrelationId":{"type":"string","nullable":true}},"additionalProperties":false},"IReadAccountingYear":{"type":"object","properties":{"version":{"type":"string","format":"date-time"},"sequenceVersion":{"type":"integer","format":"int64"},"timestamp":{"type":"integer","format":"int64"},"correlationId":{"type":"string","nullable":true},"id":{"type":"string","format":"uuid"},"tenantId":{"type":"string","nullable":true},"partitionClientId":{"type":"string","nullable":true},"startDate":{"$ref":"#/components/schemas/Date"},"endDate":{"$ref":"#/components/schemas/Date"},"description":{"type":"string","nullable":true},"profitResultAccount":{"type":"string","nullable":true},"loseResultAccount":{"type":"string","nullable":true},"profitAndLossBalanceId":{"type":"integer","format":"int64"},"stateBalanceId":{"type":"integer","format":"int64"},"state":{"$ref":"#/components/schemas/AccountingYearState"}},"additionalProperties":false},"IWebhook":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"userIdentifier":{"type":"string","nullable":true},"thirdPartyApplicationName":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"tenantId":{"type":"string","nullable":true},"secret":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"isDeleted":{"type":"boolean"},"deletedAt":{"type":"string","format":"date-time","nullable":true},"events":{"type":"array","items":{"$ref":"#/components/schemas/IWebhookEventType"},"nullable":true}},"additionalProperties":false},"IWebhookEventType":{"type":"object","properties":{"appName":{"type":"string","nullable":true},"domain":{"type":"string","nullable":true},"resource":{"type":"string","nullable":true},"eventType":{"type":"string","nullable":true},"semanticName":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"IWebhookSubscriptionResponse":{"type":"object","properties":{"responseState":{"$ref":"#/components/schemas/WebhookSubscriptionResponseState"},"webhookId":{"type":"string","format":"uuid","nullable":true},"errors":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"InputInvoiceAdditionalDataResume":{"type":"object","properties":{"registryDate":{"type":"string","nullable":true},"duaDocumentId":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"typeOfDocument":{"type":"string","nullable":true},"fundamental":{"type":"string","nullable":true},"initialNumberOfDocument":{"type":"string","nullable":true},"lastNumberOfDocument":{"type":"string","nullable":true},"invoicesInSpecialRegime":{"type":"boolean"},"taxableIncomeAtCost":{"type":"number","format":"double"},"correlationId":{"type":"string","nullable":true},"version":{"type":"string","format":"date-time"},"sequenceVersion":{"type":"integer","format":"int64"}},"additionalProperties":false},"InvoiceInputResume":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"activityCorrelationId":{"type":"string","nullable":true},"channelCorrelationId":{"type":"string","nullable":true},"invoiceDate":{"type":"string","nullable":true},"journalDate":{"type":"string","nullable":true},"transactionDate":{"type":"string","nullable":true},"invoiceNumber":{"type":"string","nullable":true},"vatNumberCorrelationId":{"type":"string","nullable":true},"tradeName":{"type":"string","nullable":true},"isCorrective":{"type":"boolean"},"correctiveInvoiceNumber":{"type":"string","nullable":true},"totalAmount":{"type":"number","format":"double"},"approvalState":{"type":"string","nullable":true},"lines":{"type":"array","items":{"$ref":"#/components/schemas/IInvoiceLineResume"},"nullable":true},"source":{"type":"string","nullable":true},"journalCorrelationId":{"type":"string","nullable":true},"version":{"type":"string","format":"date-time"},"sequenceVersion":{"type":"integer","format":"int64"},"supplierCorrelationId":{"type":"string","nullable":true},"activityShortDescription":{"type":"string","nullable":true},"channelShortDescription":{"type":"string","nullable":true},"vatName":{"type":"string","nullable":true},"vatNumber":{"type":"string","nullable":true},"state":{"type":"string","nullable":true}},"additionalProperties":false},"InvoiceIssuedResume":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"activityCorrelationId":{"type":"string","nullable":true},"channelCorrelationId":{"type":"string","nullable":true},"invoiceDate":{"type":"string","nullable":true},"journalDate":{"type":"string","nullable":true},"transactionDate":{"type":"string","nullable":true},"invoiceNumber":{"type":"string","nullable":true},"vatNumberCorrelationId":{"type":"string","nullable":true},"tradeName":{"type":"string","nullable":true},"isCorrective":{"type":"boolean"},"correctiveInvoiceNumber":{"type":"string","nullable":true},"totalAmount":{"type":"number","format":"double"},"approvalState":{"type":"string","nullable":true},"lines":{"type":"array","items":{"$ref":"#/components/schemas/IInvoiceLineResume"},"nullable":true},"source":{"type":"string","nullable":true},"journalCorrelationId":{"type":"string","nullable":true},"version":{"type":"string","format":"date-time"},"sequenceVersion":{"type":"integer","format":"int64"},"customerCorrelationId":{"type":"string","nullable":true},"activityShortDescription":{"type":"string","nullable":true},"channelShortDescription":{"type":"string","nullable":true},"vatName":{"type":"string","nullable":true},"vatNumber":{"type":"string","nullable":true},"state":{"type":"string","nullable":true}},"additionalProperties":false},"IssuedInvoiceAdditionalDataResume":{"type":"object","properties":{"notIncludedInCensus":{"type":"boolean"},"invoiceByThird":{"type":"boolean"},"multipleRecipients":{"type":"boolean"},"couponsBonusesOrDiscounts":{"type":"boolean"},"description":{"type":"string","nullable":true},"typeOfDocument":{"type":"string","nullable":true},"fundamental":{"type":"string","nullable":true},"initialNumberOfDocument":{"type":"string","nullable":true},"lastNumberOfDocument":{"type":"string","nullable":true},"invoicesInSpecialRegime":{"type":"boolean"},"taxableIncomeAtCost":{"type":"number","format":"double"},"correlationId":{"type":"string","nullable":true},"version":{"type":"string","format":"date-time"},"sequenceVersion":{"type":"integer","format":"int64"}},"additionalProperties":false},"JournalResume":{"type":"object","properties":{"version":{"type":"string","format":"date-time"},"sequenceVersion":{"type":"integer","format":"int64"},"correlationId":{"type":"string","nullable":true},"activityCorrelationId":{"type":"string","nullable":true},"activityShortDescription":{"type":"string","nullable":true},"channelShortDescription":{"type":"string","nullable":true},"channelCorrelationId":{"type":"string","nullable":true},"journalDate":{"type":"string","nullable":true},"approvalState":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"lines":{"type":"array","items":{"$ref":"#/components/schemas/IJournalLineResume"},"nullable":true},"source":{"type":"string","nullable":true},"journalType":{"type":"string","nullable":true}},"additionalProperties":false},"ModifyAccount":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"code":{"type":"string","nullable":true},"description":{"type":"string","nullable":true}},"additionalProperties":false},"ModifyCustomer":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"vatNumberCorrelationId":{"type":"string","nullable":true},"tradeName":{"type":"string","nullable":true},"state":{"type":"string","nullable":true}},"additionalProperties":false},"ModifySupplier":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"vatNumberCorrelationId":{"type":"string","nullable":true},"tradeName":{"type":"string","nullable":true},"state":{"type":"string","nullable":true}},"additionalProperties":false},"OnResourceWebhookSubscribeRequest":{"type":"object","properties":{"thirdPartyApplicationName":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"secret":{"type":"string","nullable":true},"eventTypes":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"OnResourceWebhookUnsubscribeRequest":{"type":"object","properties":{"thirdPartyApplicationName":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"eventTypes":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"OpenAccountingYear":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"startDate":{"type":"string","format":"date-time"},"endDate":{"type":"string","format":"date-time"},"profitAndLossBalanceId":{"type":"integer","format":"int64"},"stateBalanceId":{"type":"integer","format":"int64"},"type":{"type":"string","nullable":true}},"additionalProperties":false},"Payment":{"type":"object","properties":{"supplierCorrelationId":{"type":"string","nullable":true},"supplierAccountCorrelationId":{"type":"string","nullable":true},"supplierAccountCode":{"type":"string","nullable":true},"inputInvoiceCorrelationId":{"type":"string","nullable":true},"inputInvoiceNumber":{"type":"string","nullable":true},"inputInvoiceDate":{"type":"string","nullable":true},"correlationId":{"type":"string","nullable":true},"situation":{"type":"string","nullable":true},"amount":{"type":"number","format":"double"},"date":{"type":"string","nullable":true},"accountBankCorrelationId":{"type":"string","nullable":true},"accountBankCode":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"vatNumberCorrelationId":{"type":"string","nullable":true},"vatNumber":{"type":"string","nullable":true},"vatName":{"type":"string","nullable":true},"journalCorrelationId":{"type":"string","nullable":true},"version":{"type":"string","format":"date-time"},"sequenceVersion":{"type":"integer","format":"int64"}},"additionalProperties":false},"QueryTaxType":{"enum":[0,1,2,3,4,5],"type":"integer","format":"int32"},"ResourcesFilter":{"type":"object","properties":{"domains":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"ResponseResource":{"type":"object","properties":{"ok":{"type":"boolean"},"httpCode":{"type":"integer","format":"int32"},"result":{"type":"string","nullable":true},"messages":{"type":"array","items":{"$ref":"#/components/schemas/IMessageResource"},"nullable":true},"processId":{"type":"string","nullable":true},"appName":{"type":"string","nullable":true}},"additionalProperties":false},"Supplier":{"type":"object","properties":{"tradeName":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"vatNumber":{"type":"string","nullable":true},"vatName":{"type":"string","nullable":true},"accountCode":{"type":"string","nullable":true},"correlationId":{"type":"string","nullable":true},"vatNumberCorrelationId":{"type":"string","nullable":true},"accountCodeCorrelationId":{"type":"string","nullable":true},"version":{"type":"string","format":"date-time"},"sequenceVersion":{"type":"integer","format":"int64"},"fiscalData":{"$ref":"#/components/schemas/IFiscalData"}},"additionalProperties":false},"TaxInfo":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"code":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"percentage":{"type":"number","format":"double"},"surchargePercentage":{"type":"number","format":"double","nullable":true},"hasSurcharge":{"type":"boolean"},"type":{"type":"string","nullable":true},"startDate":{"type":"string","nullable":true},"endDate":{"type":"string","nullable":true}},"additionalProperties":false},"TransactionResume":{"type":"object","properties":{"taxation":{"type":"string","nullable":true},"longCode":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"shortDescription":{"type":"string","nullable":true},"startDate":{"type":"string","nullable":true},"endDate":{"type":"string","nullable":true},"validTaxTypes":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"WebhookSubscriptionResponseState":{"enum":[0,1,2,3,4,5,6,7,8],"type":"integer","format":"int32"}},"parameters":{"pageNumber":{"name":"pageNumber","in":"query","description":"Specify the page to retrieve. Index starts at 1.","schema":{"maximum":99999,"minimum":1,"type":"integer","format":"int32"}},"pageSize":{"name":"pageSize","in":"query","description":"Number of results to be returned by page.","schema":{"maximum":1000,"minimum":1,"type":"integer","format":"int32"}},"context":{"name":"context","in":"header","description":"The company correlationId. Example: {\"clientId\": \"A3TFR:061602:CM:98d52a37-3659-4d01-a526-750888feb5d9\"}\n \"none\" for common requests.","required":true,"schema":{"type":"string"}}},"securitySchemes":{"apiKeyHeader":{"type":"apiKey","description":"a3developer portal subscription key","name":"Ocp-Apim-Subscription-Key","in":"header"},"Authorization":{"type":"http","description":"WKA OAuth authorization token","scheme":"bearer"}}},"security":[{"apiKeyHeader":[]},{"Authorization":[]}]},"markdown":null,"status":"publicado","published_at":"2023-06-22T23:42:46.000Z","created_at":"2023-06-22T23:38:00.000Z","updated_at":"2025-01-27T11:03:10.000Z","buttons":[{"id":7,"name":"Consulta la definición de la API","type":"primary","order":0,"link":"https://wke-portal-pre.apimarket.io/apis/a3innuva-contabilidad/swagger-ui","class":"secondary"}],"benefits":[],"tags":[],"image":[{"id":5,"name":"wk-api-a3innuva-contabilidad.png","alternativeText":"","caption":"","width":768,"height":530,"formats":{"thumbnail":{"name":"thumbnail_wk-api-a3innuva-contabilidad.png","hash":"thumbnail_wk_api_a3innuva_contabilidad_042d0c45a7","ext":".png","mime":"image/png","width":226,"height":156,"size":22.1,"path":null,"url":"https://wke-portal.apimarket.io/assets/thumbnail_wk_api_a3innuva_contabilidad_042d0c45a7.png"},"medium":{"name":"medium_wk-api-a3innuva-contabilidad.png","hash":"medium_wk_api_a3innuva_contabilidad_042d0c45a7","ext":".png","mime":"image/png","width":750,"height":518,"size":163.21,"path":null,"url":"https://wke-portal.apimarket.io/assets/medium_wk_api_a3innuva_contabilidad_042d0c45a7.png"},"small":{"name":"small_wk-api-a3innuva-contabilidad.png","hash":"small_wk_api_a3innuva_contabilidad_042d0c45a7","ext":".png","mime":"image/png","width":500,"height":345,"size":79.6,"path":null,"url":"https://wke-portal.apimarket.io/assets/small_wk_api_a3innuva_contabilidad_042d0c45a7.png"}},"hash":"wk_api_a3innuva_contabilidad_042d0c45a7","ext":".png","mime":"image/png","size":130.5,"url":"https://wke-portal.apimarket.io/assets/wk_api_a3innuva_contabilidad_042d0c45a7.png","previewUrl":null,"provider":"aws-s3-use-cdn","provider_metadata":null,"created_at":"2023-06-23T03:28:42.000Z","updated_at":"2023-06-23T03:28:43.000Z"}],"products":[]},{"id":3,"title":"API a3innuva Contabilidad Core","slug":"a3innuva-contabilidad-core","description":null,"color_status":null,"footerText":null,"version":null,"openDoc":{"openapi":"3.0.1","info":{"title":"API a3innuva Contabilidad Core","description":"API a3innuva Contabilidad Core","termsOfService":"https://a3developers.wolterskluwer.es/user/terms","contact":{"name":"Wolters Kluwer TAA a3developers","url":"https://a3developers.wolterskluwer.es","email":"a3developers@wolterskluwer.com"},"license":{"name":"Terms of Use","url":"https://a3developers.wolterskluwer.es/user/terms"},"version":"1.0"},"servers":[{"url":"https://a3api.wolterskluwer.es/a3innuva-contabilidad-core","description":"PRO"}],"paths":{"/api/activities":{"get":{"tags":["activities"],"summary":"Get all or filtered activities","description":"Get all or filtered activities","operationId":"get-api-activities","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"name":"document","in":"query","schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IActivity"}},"example":[{"correlationId":"string","description":"string","shortDescription":"string","startDate":"string","endDate":"string","taxation":"string","estimations":[{"taxYear":0,"estimation":"string","typeOfActivity":"string","epigraph":"string","vatSystem":"string","agriculturalKey":"string","cnae":"string","vatProduct":"string"}],"prorates":[{"prorateType":"string","initialPercentage":0,"finalPercentage":0,"taxYear":0}],"version":"string","sequenceVersion":0}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"post":{"tags":["activities"],"summary":"Create an Activity","description":"Create an Activity","operationId":"post-api-activities","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ICreateActivityHeader"},"example":{"correlationId":"string","description":"string","shortDescription":"string","startDate":"string","taxation":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/ICreateActivityHeader"},"example":{"correlationId":"string","description":"string","shortDescription":"string","startDate":"string","taxation":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/ICreateActivityHeader"},"example":{"correlationId":"string","description":"string","shortDescription":"string","startDate":"string","taxation":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/ICreateActivityHeader"},"example":{"correlationId":"string","description":"string","shortDescription":"string","startDate":"string","taxation":"string"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/activities/{correlationId}":{"get":{"tags":["activities"],"summary":"Get an activity by id","description":"Get an activity by id","operationId":"get-api-activities-correlationid","parameters":[{"name":"correlationId","in":"path","description":"","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IActivity"},"example":{"correlationId":"string","description":"string","shortDescription":"string","startDate":"string","endDate":"string","taxation":"string","estimations":[{"taxYear":0,"estimation":"string","typeOfActivity":"string","epigraph":"string","vatSystem":"string","agriculturalKey":"string","cnae":"string","vatProduct":"string"}],"prorates":[{"prorateType":"string","initialPercentage":0,"finalPercentage":0,"taxYear":0}],"version":"string","sequenceVersion":0}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"delete":{"tags":["activities"],"summary":"Delete an activity","description":"Delete an activity","operationId":"delete-api-activities-correlationid","parameters":[{"name":"correlationId","in":"path","description":"","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/corporateLegalEntities":{"get":{"tags":["CorporateLegalEntities"],"summary":"Get all or filtered by document","description":"Get all or filtered by document","operationId":"get-api-corporatelegalentities","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"name":"document","in":"query","schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ICorporateLegalEntity"}},"example":[{"correlationId":"string","document":"string","isFirm":true,"version":"string","sequenceVersion":0,"state":"string","socialName":"string"}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"post":{"tags":["CorporateLegalEntities"],"summary":"Create a corporate legal entity","description":"Create a corporate legal entity","operationId":"post-api-corporatelegalentities","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ICreateCorporateLegalEntity"},"example":{"correlationId":"string","document":"string","documentType":"string","socialName":"string","isFirm":true}},"application/json":{"schema":{"$ref":"#/components/schemas/ICreateCorporateLegalEntity"},"example":{"correlationId":"string","document":"string","documentType":"string","socialName":"string","isFirm":true}},"text/json":{"schema":{"$ref":"#/components/schemas/ICreateCorporateLegalEntity"},"example":{"correlationId":"string","document":"string","documentType":"string","socialName":"string","isFirm":true}},"application/*+json":{"schema":{"$ref":"#/components/schemas/ICreateCorporateLegalEntity"},"example":{"correlationId":"string","document":"string","documentType":"string","socialName":"string","isFirm":true}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"put":{"tags":["CorporateLegalEntities"],"summary":"Update a corporate legal entity","description":"Modify a corporate legal entity fiscal data","operationId":"put-api-corporatelegalentities","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/IModifyFiscalDataCorporateLegalEntity"},"example":{"correlationId":"string","document":"string","documentType":"string","socialName":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/IModifyFiscalDataCorporateLegalEntity"},"example":{"correlationId":"string","document":"string","documentType":"string","socialName":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/IModifyFiscalDataCorporateLegalEntity"},"example":{"correlationId":"string","document":"string","documentType":"string","socialName":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/IModifyFiscalDataCorporateLegalEntity"},"example":{"correlationId":"string","document":"string","documentType":"string","socialName":"string"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/corporateLegalEntities/{correlationId}":{"get":{"tags":["CorporateLegalEntities"],"summary":"Get a legal entity by id","description":"Get a legal entity by id","operationId":"get-api-corporatelegalentities-correlationid","parameters":[{"name":"correlationId","in":"path","description":"","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorporateLegalEntity"},"example":{"correlationId":"string","document":"string","isFirm":true,"version":"string","sequenceVersion":0,"state":"string","socialName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/activities/estimations":{"post":{"tags":["Estimations"],"summary":"Define a Estimation for an Activity","description":"Define a Estimation for an Activity","operationId":"post-api-activities-estimations","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/IDefineTaxYearEstimation"},"example":{"correlationId":"string","estimation":"string","taxYear":0,"typeOfActivity":"string","epigraph":"string","epigraphDescription":"string","vatSystem":"string","agriculturalKey":"string","cnae":"string","vatProduct":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/IDefineTaxYearEstimation"},"example":{"correlationId":"string","estimation":"string","taxYear":0,"typeOfActivity":"string","epigraph":"string","epigraphDescription":"string","vatSystem":"string","agriculturalKey":"string","cnae":"string","vatProduct":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/IDefineTaxYearEstimation"},"example":{"correlationId":"string","estimation":"string","taxYear":0,"typeOfActivity":"string","epigraph":"string","epigraphDescription":"string","vatSystem":"string","agriculturalKey":"string","cnae":"string","vatProduct":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/IDefineTaxYearEstimation"},"example":{"correlationId":"string","estimation":"string","taxYear":0,"typeOfActivity":"string","epigraph":"string","epigraphDescription":"string","vatSystem":"string","agriculturalKey":"string","cnae":"string","vatProduct":"string"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/incomeAllocationLegalEntities":{"get":{"tags":["IncomeAllocationLegalEntities"],"summary":"Get all or filtered by document","description":"Get all or filtered by document","operationId":"get-api-incomeallocationlegalentities","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"name":"document","in":"query","schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IIncomeAllocationLegalEntity"}},"example":[{"correlationId":"string","document":"string","isFirm":true,"version":"string","sequenceVersion":0,"state":"string","socialName":"string"}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"post":{"tags":["IncomeAllocationLegalEntities"],"summary":"Create a IncomeAllocation legal entity","description":"Create a IncomeAllocation legal entity","operationId":"post-api-incomeallocationlegalentities","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ICreateIncomeAllocationLegalEntity"},"example":{"correlationId":"string","document":"string","documentType":"string","socialName":"string","isFirm":true}},"application/json":{"schema":{"$ref":"#/components/schemas/ICreateIncomeAllocationLegalEntity"},"example":{"correlationId":"string","document":"string","documentType":"string","socialName":"string","isFirm":true}},"text/json":{"schema":{"$ref":"#/components/schemas/ICreateIncomeAllocationLegalEntity"},"example":{"correlationId":"string","document":"string","documentType":"string","socialName":"string","isFirm":true}},"application/*+json":{"schema":{"$ref":"#/components/schemas/ICreateIncomeAllocationLegalEntity"},"example":{"correlationId":"string","document":"string","documentType":"string","socialName":"string","isFirm":true}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"put":{"tags":["IncomeAllocationLegalEntities"],"summary":"Update a IncomeAllocation legal entity","description":"Modify a IncomeAllocation legal entity","operationId":"put-api-incomeallocationlegalentities","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/IModifyFiscalDataIncomeAllocationLegalEntity"},"example":{"correlationId":"string","document":"string","documentType":"string","socialName":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/IModifyFiscalDataIncomeAllocationLegalEntity"},"example":{"correlationId":"string","document":"string","documentType":"string","socialName":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/IModifyFiscalDataIncomeAllocationLegalEntity"},"example":{"correlationId":"string","document":"string","documentType":"string","socialName":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/IModifyFiscalDataIncomeAllocationLegalEntity"},"example":{"correlationId":"string","document":"string","documentType":"string","socialName":"string"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/incomeAllocationLegalEntities/{correlationId}":{"get":{"tags":["IncomeAllocationLegalEntities"],"summary":"Get a legal entity by id","description":"Get a legal entity by id","operationId":"get-api-incomeallocationlegalentities-correlationid","parameters":[{"name":"correlationId","in":"path","description":"","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IIncomeAllocationLegalEntity"},"example":{"correlationId":"string","document":"string","isFirm":true,"version":"string","sequenceVersion":0,"state":"string","socialName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/individualLegalEntities":{"get":{"tags":["IndividualLegalEntities"],"summary":"Get all or filtered by document","description":"Get all or filtered by document","operationId":"get-api-individuallegalentities","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"name":"document","in":"query","schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IIndividualLegalEntity"}},"example":[{"correlationId":"string","document":"string","isFirm":true,"version":"string","sequenceVersion":0,"state":"string","formattedName":"string","name":"string","surname":"string","secondSurname":"string"}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"post":{"tags":["IndividualLegalEntities"],"summary":"Create an individual legal entity","description":"Create an individual legal entity","operationId":"post-api-individuallegalentities","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ICreateIndividualLegalEntity"},"example":{"correlationId":"string","document":"string","documentType":"string","name":"string","secondSurname":"string","surname":"string","isFirm":true}},"application/json":{"schema":{"$ref":"#/components/schemas/ICreateIndividualLegalEntity"},"example":{"correlationId":"string","document":"string","documentType":"string","name":"string","secondSurname":"string","surname":"string","isFirm":true}},"text/json":{"schema":{"$ref":"#/components/schemas/ICreateIndividualLegalEntity"},"example":{"correlationId":"string","document":"string","documentType":"string","name":"string","secondSurname":"string","surname":"string","isFirm":true}},"application/*+json":{"schema":{"$ref":"#/components/schemas/ICreateIndividualLegalEntity"},"example":{"correlationId":"string","document":"string","documentType":"string","name":"string","secondSurname":"string","surname":"string","isFirm":true}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"put":{"tags":["IndividualLegalEntities"],"summary":"Update an individual legal entity","description":"Modify an individual legal entity","operationId":"put-api-individuallegalentities","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/IModifyFiscalDataIndividualLegalEntity"},"example":{"correlationId":"string","document":"string","documentType":"string","name":"string","secondSurname":"string","surname":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/IModifyFiscalDataIndividualLegalEntity"},"example":{"correlationId":"string","document":"string","documentType":"string","name":"string","secondSurname":"string","surname":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/IModifyFiscalDataIndividualLegalEntity"},"example":{"correlationId":"string","document":"string","documentType":"string","name":"string","secondSurname":"string","surname":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/IModifyFiscalDataIndividualLegalEntity"},"example":{"correlationId":"string","document":"string","documentType":"string","name":"string","secondSurname":"string","surname":"string"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/individualLegalEntities/{correlationId}":{"get":{"tags":["IndividualLegalEntities"],"summary":"Get a legal entity by id","description":"Get a legal entity by id","operationId":"get-api-individuallegalentities-correlationid","parameters":[{"name":"correlationId","in":"path","description":"","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IIndividualLegalEntity"},"example":{"correlationId":"string","document":"string","isFirm":true,"version":"string","sequenceVersion":0,"state":"string","formattedName":"string","name":"string","surname":"string","secondSurname":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/legalEntitiesSummary":{"get":{"tags":["LegalEntities"],"summary":"Get all or filtered by document","description":"Get all or filtered by document","operationId":"get-api-legalentitiessummary","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"name":"document","in":"query","schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ILegalEntitySummary"}},"example":[{"correlationId":"string","document":"string","isFirm":true,"version":"string","sequenceVersion":0,"state":"string","name":"string","type":"string"}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/legalEntitiesSummary/{correlationId}":{"get":{"tags":["LegalEntities"],"summary":"Get a legal entity by id","description":"Get a legal entity by id","operationId":"get-api-legalentitiessummary-correlationid","parameters":[{"name":"correlationId","in":"path","description":"","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ILegalEntitySummary"},"example":{"correlationId":"string","document":"string","isFirm":true,"version":"string","sequenceVersion":0,"state":"string","name":"string","type":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/legalEntityLicences":{"get":{"tags":["LegalEntityLicences"],"summary":"Get all or filtered by document","description":"Get all or filtered by document","operationId":"get-api-legalentitylicences","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"name":"document","in":"query","schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ILegalEntityLicenceAssignableTranche"}},"example":[{"id":"string","description":"string","state":"string","referenceDate":"string"}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"post":{"tags":["LegalEntityLicences"],"summary":"Add Licence to LegalEntity","description":"Add Licence to LegalEntity","operationId":"post-api-legalentitylicences","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/IAddLegalEntityLicence"},"example":{"id":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/IAddLegalEntityLicence"},"example":{"id":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/IAddLegalEntityLicence"},"example":{"id":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/IAddLegalEntityLicence"},"example":{"id":"string"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/persons":{"get":{"tags":["persons"],"summary":"Get all or filtered persons","description":"Get all or filtered persons","operationId":"get-api-persons","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"name":"document","in":"query","schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IPersona"}},"example":[{"correlationId":"string","name":"string","document":"string","documentType":"string","postalCode":"string","countryCode":"string","legalAgentDocument":"string","version":"string","sequenceVersion":0}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"post":{"tags":["persons"],"summary":"Create a person","description":"Create a person","operationId":"post-api-persons","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ICreatePersona"},"example":{"correlationId":"string","name":"string","document":"string","documentType":"string","postalCode":"string","countryCode":"string","legalAgentDocument":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/ICreatePersona"},"example":{"correlationId":"string","name":"string","document":"string","documentType":"string","postalCode":"string","countryCode":"string","legalAgentDocument":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/ICreatePersona"},"example":{"correlationId":"string","name":"string","document":"string","documentType":"string","postalCode":"string","countryCode":"string","legalAgentDocument":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/ICreatePersona"},"example":{"correlationId":"string","name":"string","document":"string","documentType":"string","postalCode":"string","countryCode":"string","legalAgentDocument":"string"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}},"put":{"tags":["persons"],"summary":"Update a person","description":"Update a person","operationId":"put-api-persons","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/IModifyPersona"},"example":{"correlationId":"string","name":"string","document":"string","documentType":"string","postalCode":"string","countryCode":"string","legalAgentDocument":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/IModifyPersona"},"example":{"correlationId":"string","name":"string","document":"string","documentType":"string","postalCode":"string","countryCode":"string","legalAgentDocument":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/IModifyPersona"},"example":{"correlationId":"string","name":"string","document":"string","documentType":"string","postalCode":"string","countryCode":"string","legalAgentDocument":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/IModifyPersona"},"example":{"correlationId":"string","name":"string","document":"string","documentType":"string","postalCode":"string","countryCode":"string","legalAgentDocument":"string"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/persons/{correlationId}":{"get":{"tags":["persons"],"summary":"Get a person by id","description":"Get a person by id","operationId":"get-api-persons-correlationid","parameters":[{"name":"correlationId","in":"path","description":"","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/context"}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IPersona"}},"example":[{"correlationId":"string","name":"string","document":"string","documentType":"string","postalCode":"string","countryCode":"string","legalAgentDocument":"string","version":"string","sequenceVersion":0}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/activities/prorates/initial":{"post":{"tags":["Prorates"],"summary":"Define an Initial Prorate for an Activity","description":"Define an Initial Prorate for an Activity","operationId":"post-api-activities-prorates-initial","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/IDefineTaxYearInitialProrate"},"example":{"correlationId":"string","prorateType":"string","initialPercentage":0,"taxYear":0}},"application/json":{"schema":{"$ref":"#/components/schemas/IDefineTaxYearInitialProrate"},"example":{"correlationId":"string","prorateType":"string","initialPercentage":0,"taxYear":0}},"text/json":{"schema":{"$ref":"#/components/schemas/IDefineTaxYearInitialProrate"},"example":{"correlationId":"string","prorateType":"string","initialPercentage":0,"taxYear":0}},"application/*+json":{"schema":{"$ref":"#/components/schemas/IDefineTaxYearInitialProrate"},"example":{"correlationId":"string","prorateType":"string","initialPercentage":0,"taxYear":0}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/activities/prorates/final":{"post":{"tags":["Prorates"],"summary":"Define a Final Prorate for an Activity","description":"Define a Final Prorate for an Activity","operationId":"post-api-activities-prorates-final","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/IDefineTaxYearFinalProrate"},"example":{"correlationId":"string","finalPercentage":0,"taxYear":0}},"application/json":{"schema":{"$ref":"#/components/schemas/IDefineTaxYearFinalProrate"},"example":{"correlationId":"string","finalPercentage":0,"taxYear":0}},"text/json":{"schema":{"$ref":"#/components/schemas/IDefineTaxYearFinalProrate"},"example":{"correlationId":"string","finalPercentage":0,"taxYear":0}},"application/*+json":{"schema":{"$ref":"#/components/schemas/IDefineTaxYearFinalProrate"},"example":{"correlationId":"string","finalPercentage":0,"taxYear":0}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}},"/api/activities/prorates/deactivate":{"put":{"tags":["Prorates"],"summary":"Deactivate a Prorate for an Activity","description":"Deactivate a Prorate for an Activity","operationId":"put-api-activities-prorates-deactivate","parameters":[{"$ref":"#/components/parameters/context"}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/IDeactivateTaxYearProrate"},"example":{"correlationId":"string","taxYear":0}},"application/json":{"schema":{"$ref":"#/components/schemas/IDeactivateTaxYearProrate"},"example":{"correlationId":"string","taxYear":0}},"text/json":{"schema":{"$ref":"#/components/schemas/IDeactivateTaxYearProrate"},"example":{"correlationId":"string","taxYear":0}},"application/*+json":{"schema":{"$ref":"#/components/schemas/IDeactivateTaxYearProrate"},"example":{"correlationId":"string","taxYear":0}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResource"},"example":{"ok":true,"httpCode":0,"result":"string","messages":[{"type":"string","description":"string"}],"processId":"string","appName":"string"}}}}}}}},"components":{"schemas":{"ChangeEnableStatusRequest":{"type":"object","properties":{"webhookId":{"type":"string","format":"uuid"},"enable":{"type":"boolean"}},"additionalProperties":false},"ChangeUrlRequest":{"type":"object","properties":{"webhookId":{"type":"string","format":"uuid"},"url":{"type":"string","nullable":true}},"additionalProperties":false},"CorporateLegalEntity":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"document":{"type":"string","nullable":true},"isFirm":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"sequenceVersion":{"type":"integer","format":"int64"},"state":{"type":"string","nullable":true},"socialName":{"type":"string","nullable":true}},"additionalProperties":false},"IActivity":{"type":"object","properties":{"correlationId":{"type":"string","description":"Correlation identity across systems","nullable":true},"description":{"type":"string","description":"Activity Description","nullable":true},"shortDescription":{"type":"string","description":"Activity Short Description","nullable":true},"startDate":{"type":"string","description":"Activity Start Date","nullable":true},"endDate":{"type":"string","description":"Activity End Date","nullable":true},"taxation":{"type":"string","description":"Activity Taxation","nullable":true},"estimations":{"type":"array","items":{"$ref":"#/components/schemas/ITaxYearEstimation"},"description":"Activity Estimations","nullable":true},"prorates":{"type":"array","items":{"$ref":"#/components/schemas/ITaxYearProrate"},"description":"Activity Prorates","nullable":true},"version":{"type":"string","description":"Activity Version","format":"date-time"},"sequenceVersion":{"type":"integer","description":"Activity SequenceVersion","format":"int64"}},"additionalProperties":false,"description":"Activity resource"},"IAddLegalEntityLicence":{"type":"object","properties":{"id":{"type":"string","nullable":true}},"additionalProperties":false},"ICorporateLegalEntity":{"type":"object","properties":{"correlationId":{"type":"string","description":"Correlation identity across systems","nullable":true},"document":{"type":"string","description":"LegalEntity Document","nullable":true},"isFirm":{"type":"boolean","description":"LegalEntity IsFirm"},"version":{"type":"string","description":"LegalEntity Version","format":"date-time"},"sequenceVersion":{"type":"integer","description":"LegalEntity SequenceVersion","format":"int64"},"state":{"type":"string","nullable":true},"socialName":{"type":"string","description":"Social name","nullable":true}},"additionalProperties":false,"description":"LegalEntity resource"},"ICreateActivityHeader":{"type":"object","properties":{"correlationId":{"type":"string","description":"Correlation identity across systems","nullable":true},"description":{"type":"string","description":"Activity Description","nullable":true},"shortDescription":{"type":"string","description":"Activity Short Description","nullable":true},"startDate":{"type":"string","description":"Activity Start Date","format":"date-time"},"taxation":{"type":"string","description":"Activity Taxation","nullable":true}},"additionalProperties":false},"ICreateCorporateLegalEntity":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"document":{"type":"string","nullable":true},"documentType":{"type":"string","nullable":true},"socialName":{"type":"string","nullable":true},"isFirm":{"type":"boolean"}},"additionalProperties":false},"ICreateIncomeAllocationLegalEntity":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"document":{"type":"string","nullable":true},"documentType":{"type":"string","nullable":true},"socialName":{"type":"string","nullable":true},"isFirm":{"type":"boolean"}},"additionalProperties":false},"ICreateIndividualLegalEntity":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"document":{"type":"string","nullable":true},"documentType":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"secondSurname":{"type":"string","nullable":true},"surname":{"type":"string","nullable":true},"isFirm":{"type":"boolean"}},"additionalProperties":false},"ICreatePersona":{"type":"object","properties":{"correlationId":{"type":"string","description":"Correlation identity across systems","nullable":true},"name":{"type":"string","description":"Persona Name","nullable":true},"document":{"type":"string","description":"Persona Document","nullable":true},"documentType":{"type":"string","description":"Persona DocumentType","nullable":true},"postalCode":{"type":"string","description":"Persona PostalCode","nullable":true},"countryCode":{"type":"string","description":"Persona CountryCode","nullable":true},"legalAgentDocument":{"type":"string","description":"Persona LegalAgentDocument","nullable":true}},"additionalProperties":false,"description":"Create Persona resource"},"IDeactivateTaxYearProrate":{"type":"object","properties":{"correlationId":{"type":"string","description":"Correlation identity across systems","nullable":true},"taxYear":{"type":"integer","description":"Activity Prorate Tax Year","format":"int32"}},"additionalProperties":false},"IDefineTaxYearEstimation":{"type":"object","properties":{"correlationId":{"type":"string","description":"Correlation identity across systems","nullable":true},"estimation":{"type":"string","description":"Activity Estimation","nullable":true},"taxYear":{"type":"integer","description":"Activity Estimation Tax Year","format":"int32"},"typeOfActivity":{"type":"string","description":"Activity Estimation Type of Activity","nullable":true},"epigraph":{"type":"string","description":"Activity Estimation Epigraph","nullable":true},"epigraphDescription":{"type":"string","description":"Activity Estimation Epigraph Description","nullable":true},"vatSystem":{"type":"string","description":"Activity Estimation Vat System","nullable":true},"agriculturalKey":{"type":"string","description":"Activity Estimation Agricultural Key","nullable":true},"cnae":{"type":"string","description":"Activity Estimation CNAE","nullable":true},"vatProduct":{"type":"string","description":"Activity Estimation Agricultural Vat Product","nullable":true}},"additionalProperties":false},"IDefineTaxYearFinalProrate":{"type":"object","properties":{"correlationId":{"type":"string","description":"Correlation identity across systems","nullable":true},"finalPercentage":{"type":"integer","description":"Activity Prorate final Percentage","format":"int32"},"taxYear":{"type":"integer","description":"Activity Prorate Tax Year","format":"int32"}},"additionalProperties":false},"IDefineTaxYearInitialProrate":{"type":"object","properties":{"correlationId":{"type":"string","description":"Correlation identity across systems","nullable":true},"prorateType":{"type":"string","description":"Activity Prorate Type","nullable":true},"initialPercentage":{"type":"integer","description":"Activity Prorate initial Percentage","format":"int32"},"taxYear":{"type":"integer","description":"Activity Prorate Tax Year","format":"int32"}},"additionalProperties":false},"IIncomeAllocationLegalEntity":{"type":"object","properties":{"correlationId":{"type":"string","description":"Correlation identity across systems","nullable":true},"document":{"type":"string","description":"LegalEntity Document","nullable":true},"isFirm":{"type":"boolean","description":"LegalEntity IsFirm"},"version":{"type":"string","description":"LegalEntity Version","format":"date-time"},"sequenceVersion":{"type":"integer","description":"LegalEntity SequenceVersion","format":"int64"},"state":{"type":"string","nullable":true},"socialName":{"type":"string","description":"Social name","nullable":true}},"additionalProperties":false},"IIndividualLegalEntity":{"type":"object","properties":{"correlationId":{"type":"string","description":"Correlation identity across systems","nullable":true},"document":{"type":"string","description":"LegalEntity Document","nullable":true},"isFirm":{"type":"boolean","description":"LegalEntity IsFirm"},"version":{"type":"string","description":"LegalEntity Version","format":"date-time"},"sequenceVersion":{"type":"integer","description":"LegalEntity SequenceVersion","format":"int64"},"state":{"type":"string","nullable":true},"formattedName":{"type":"string","description":"LegalEntity FormmattedName","nullable":true},"name":{"type":"string","description":"LegalEntity Name","nullable":true},"surname":{"type":"string","description":"LegalEntity Surname","nullable":true},"secondSurname":{"type":"string","description":"LegalEntity SecondSurname","nullable":true}},"additionalProperties":false,"description":"LegalEntity resource"},"ILegalEntityLicenceAssignableTranche":{"type":"object","properties":{"id":{"type":"string","description":"License product identifier","nullable":true},"description":{"type":"string","description":"License description","nullable":true},"state":{"type":"string","description":"License state","nullable":true},"referenceDate":{"type":"string","description":"License Reference Date","nullable":true}},"additionalProperties":false,"description":"LegalEntity License resource"},"ILegalEntitySummary":{"type":"object","properties":{"correlationId":{"type":"string","description":"Correlation identity across systems","nullable":true},"document":{"type":"string","description":"LegalEntity Document","nullable":true},"isFirm":{"type":"boolean","description":"LegalEntity IsFirm"},"version":{"type":"string","description":"LegalEntity Version","format":"date-time"},"sequenceVersion":{"type":"integer","description":"LegalEntity SequenceVersion","format":"int64"},"state":{"type":"string","nullable":true},"name":{"type":"string","description":"Social name","nullable":true},"type":{"type":"string","description":"The legal entity type","nullable":true}},"additionalProperties":false,"description":"LegalEntity summary resource"},"IMessageResource":{"type":"object","properties":{"type":{"type":"string","description":"The type message: Error, Warning, Info.","nullable":true},"description":{"type":"string","description":"A message description","nullable":true}},"additionalProperties":false,"description":"Message resource"},"IModifyFiscalDataCorporateLegalEntity":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"document":{"type":"string","nullable":true},"documentType":{"type":"string","nullable":true},"socialName":{"type":"string","nullable":true}},"additionalProperties":false},"IModifyFiscalDataIncomeAllocationLegalEntity":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"document":{"type":"string","nullable":true},"documentType":{"type":"string","nullable":true},"socialName":{"type":"string","nullable":true}},"additionalProperties":false},"IModifyFiscalDataIndividualLegalEntity":{"type":"object","properties":{"correlationId":{"type":"string","nullable":true},"document":{"type":"string","nullable":true},"documentType":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"secondSurname":{"type":"string","nullable":true},"surname":{"type":"string","nullable":true}},"additionalProperties":false},"IModifyPersona":{"type":"object","properties":{"correlationId":{"type":"string","description":"Correlation identity across systems","nullable":true},"name":{"type":"string","description":"Persona Name","nullable":true},"document":{"type":"string","description":"Persona Document","nullable":true},"documentType":{"type":"string","description":"Persona DocumentType","nullable":true},"postalCode":{"type":"string","description":"Persona PostalCode","nullable":true},"countryCode":{"type":"string","description":"Persona CountryCode","nullable":true},"legalAgentDocument":{"type":"string","description":"Persona LegalAgentDocument","nullable":true}},"additionalProperties":false},"IPersona":{"type":"object","properties":{"correlationId":{"type":"string","description":"Correlation identity across systems","nullable":true},"name":{"type":"string","description":"Persona Name","nullable":true},"document":{"type":"string","description":"Persona Document","nullable":true},"documentType":{"type":"string","description":"Persona DocumentType","nullable":true},"postalCode":{"type":"string","description":"Persona PostalCode","nullable":true},"countryCode":{"type":"string","description":"Persona CountryCode","nullable":true},"legalAgentDocument":{"type":"string","description":"Persona LegalAgentDocument","nullable":true},"version":{"type":"string","description":"Persona Version","format":"date-time"},"sequenceVersion":{"type":"integer","description":"Persona SequenceVersion","format":"int64"}},"additionalProperties":false,"description":"Persona resource"},"ITaxYearEstimation":{"type":"object","properties":{"taxYear":{"type":"integer","description":"Estimation Tax Year","format":"int32"},"estimation":{"type":"string","description":"Estimation","nullable":true},"typeOfActivity":{"type":"string","description":"Estimation Type Of Activity","nullable":true},"epigraph":{"type":"string","description":"Estimation Epigraph","nullable":true},"vatSystem":{"type":"string","description":"Estimation Vat System","nullable":true},"agriculturalKey":{"type":"string","description":"Estimation Agricultural Key","nullable":true},"cnae":{"type":"string","description":"Estimation CNAE","nullable":true},"vatProduct":{"type":"string","description":"Estimation Vat Agricultural Product","nullable":true}},"additionalProperties":false,"description":"TaxYearEstimation resource"},"ITaxYearProrate":{"type":"object","properties":{"prorateType":{"type":"string","description":"Prorate Type","nullable":true},"initialPercentage":{"type":"integer","description":"Prorate Initial Percentage","format":"int32"},"finalPercentage":{"type":"integer","description":"Prorate Final Percentage","format":"int32","nullable":true},"taxYear":{"type":"integer","description":"Prorate Tax Year","format":"int32"}},"additionalProperties":false,"description":"TaxYearProrate resource"},"IWebhook":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"userIdentifier":{"type":"string","nullable":true},"thirdPartyApplicationName":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"tenantId":{"type":"string","nullable":true},"secret":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"isDeleted":{"type":"boolean"},"deletedAt":{"type":"string","format":"date-time","nullable":true},"events":{"type":"array","items":{"$ref":"#/components/schemas/IWebhookEventType"},"nullable":true}},"additionalProperties":false},"IWebhookEventType":{"type":"object","properties":{"appName":{"type":"string","nullable":true},"domain":{"type":"string","nullable":true},"resource":{"type":"string","nullable":true},"eventType":{"type":"string","nullable":true},"semanticName":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"IWebhookSubscriptionResponse":{"type":"object","properties":{"responseState":{"$ref":"#/components/schemas/WebhookSubscriptionResponseState"},"webhookId":{"type":"string","format":"uuid","nullable":true},"errors":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"OnResourceWebhookSubscribeRequest":{"type":"object","properties":{"thirdPartyApplicationName":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"secret":{"type":"string","nullable":true},"eventTypes":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"OnResourceWebhookUnsubscribeRequest":{"type":"object","properties":{"thirdPartyApplicationName":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"eventTypes":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"ResponseResource":{"type":"object","properties":{"ok":{"type":"boolean","description":"It's ok the action"},"httpCode":{"type":"integer","description":"The HTTP code's action","format":"int32"},"result":{"type":"string","description":"The result for HTTP codes 4XX,500","nullable":true},"messages":{"type":"array","items":{"$ref":"#/components/schemas/IMessageResource"},"description":"Message list from validations","nullable":true},"processId":{"type":"string","description":"Id for the process","nullable":true},"appName":{"type":"string","description":"The app name launched the request","nullable":true}},"additionalProperties":false},"WebhookSubscriptionResponseState":{"enum":[0,1,2,3,4,5,6,7,8],"type":"integer","format":"int32"}},"parameters":{"pageNumber":{"name":"pageNumber","in":"query","description":"Specify the page to retrieve. Index starts at 1.","schema":{"maximum":99999,"minimum":1,"type":"integer","format":"int32"}},"pageSize":{"name":"pageSize","in":"query","description":"Number of results to be returned by page.","schema":{"maximum":1000,"minimum":1,"type":"integer","format":"int32"}},"context":{"name":"context","in":"header","description":"The company correlationId. Example: {\"clientId\": \"A3TFR:061602:CM:98d52a37-3659-4d01-a526-750888feb5d9\"}\n \"none\" for common requests.","required":true,"schema":{"type":"string"}}},"securitySchemes":{"apiKeyHeader":{"type":"apiKey","description":"a3developer portal subscription key","name":"Ocp-Apim-Subscription-Key","in":"header"},"Authorization":{"type":"http","description":"WKA OAuth authorization token","scheme":"bearer"}}},"security":[{"apiKeyHeader":[]},{"Authorization":[]}]},"markdown":"","status":"publicado","published_at":"2023-06-22T23:42:50.000Z","created_at":"2023-06-22T23:38:16.000Z","updated_at":"2025-01-27T11:59:49.000Z","buttons":[{"id":8,"name":"Consulta la definición de la API","type":"primary","order":0,"link":"https://wke-portal-pre.apimarket.io/apis/a3innuva-contabilidad-importia/swagger-ui","class":"secondary"}],"benefits":[],"tags":[],"image":[{"id":5,"name":"wk-api-a3innuva-contabilidad.png","alternativeText":"","caption":"","width":768,"height":530,"formats":{"thumbnail":{"name":"thumbnail_wk-api-a3innuva-contabilidad.png","hash":"thumbnail_wk_api_a3innuva_contabilidad_042d0c45a7","ext":".png","mime":"image/png","width":226,"height":156,"size":22.1,"path":null,"url":"https://wke-portal.apimarket.io/assets/thumbnail_wk_api_a3innuva_contabilidad_042d0c45a7.png"},"medium":{"name":"medium_wk-api-a3innuva-contabilidad.png","hash":"medium_wk_api_a3innuva_contabilidad_042d0c45a7","ext":".png","mime":"image/png","width":750,"height":518,"size":163.21,"path":null,"url":"https://wke-portal.apimarket.io/assets/medium_wk_api_a3innuva_contabilidad_042d0c45a7.png"},"small":{"name":"small_wk-api-a3innuva-contabilidad.png","hash":"small_wk_api_a3innuva_contabilidad_042d0c45a7","ext":".png","mime":"image/png","width":500,"height":345,"size":79.6,"path":null,"url":"https://wke-portal.apimarket.io/assets/small_wk_api_a3innuva_contabilidad_042d0c45a7.png"}},"hash":"wk_api_a3innuva_contabilidad_042d0c45a7","ext":".png","mime":"image/png","size":130.5,"url":"https://wke-portal.apimarket.io/assets/wk_api_a3innuva_contabilidad_042d0c45a7.png","previewUrl":null,"provider":"aws-s3-use-cdn","provider_metadata":null,"created_at":"2023-06-23T03:28:42.000Z","updated_at":"2023-06-23T03:28:43.000Z"}],"products":[]},{"id":4,"title":"API a3innuva ERP - a3factura","slug":"a3factura-services-api-2-0","description":null,"color_status":null,"footerText":null,"version":null,"openDoc":{"openapi":"3.0.4","info":{"title":"API a3innuva ERP - a3factura","description":"API a3innuva ERP - a3factura","termsOfService":"https://a3developers.wolterskluwer.es/user/terms","contact":{"name":"Wolters Kluwer TAA a3developers","url":"https://a3developers.wolterskluwer.es","email":"a3developers@wolterskluwer.com"},"license":{"name":"Terms of Use","url":"https://a3developers.wolterskluwer.es/user/terms"},"version":"2.0"},"servers":[{"url":"https://a3api.wolterskluwer.es/a3factura","description":"PRO"}],"paths":{"/api/accounts":{"get":{"tags":["Accounts"],"summary":"Accounts_Get","operationId":"Accounts_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountDTOArray"},"example":[{"description":"string","code":"string","id":"string","legacyId":0}]},"application/xml":{"schema":{"$ref":"#/components/schemas/AccountDTOArray"},"example":"<AccountDTOArray> <description>string</description> <code>string</code> <id>string</id> <legacyId>0</legacyId> </AccountDTOArray>"}}}}},"post":{"tags":["Accounts"],"summary":"Add an account","description":"Add an account","operationId":"Accounts_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountDTO"},"example":{"description":"string","code":"string","id":"string","legacyId":0}},"text/json":{"schema":{"$ref":"#/components/schemas/AccountDTO"},"example":{"description":"string","code":"string","id":"string","legacyId":0}},"text/html":{"schema":{"$ref":"#/components/schemas/AccountDTO"},"example":"<AccountDTO> <description>string</description> <code>string</code> <id>string</id> <legacyId>0</legacyId> </AccountDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/AccountDTO"},"example":{"description":"string","code":"string","id":"string","legacyId":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/AccountDTO"},"example":"<AccountDTO> <description>string</description> <code>string</code> <id>string</id> <legacyId>0</legacyId> </AccountDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/AccountDTO"},"example":"<AccountDTO> <description>string</description> <code>string</code> <id>string</id> <legacyId>0</legacyId> </AccountDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Created","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/activities/{id}":{"get":{"tags":["activities"],"summary":"Get an activity by identifier","description":"Get an activity by identifier","operationId":"Activities_GetById","parameters":[{"name":"id","in":"path","description":"The activity id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityDTO"},"example":{"id":"string","code":"string","name":"string","ecoCompany":"string","ecoActivity":"string","epigraphId":0,"epigraphCode":"string","epigraphDescription":"string","regimen":0,"taxation":0,"description":"string","adhereToTicketBai":true}},"application/xml":{"schema":{"$ref":"#/components/schemas/ActivityDTO"},"example":"<ActivityDTO> <id>string</id> <code>string</code> <name>string</name> <ecoCompany>string</ecoCompany> <ecoActivity>string</ecoActivity> <epigraphId>0</epigraphId> <epigraphCode>string</epigraphCode> <epigraphDescription>string</epigraphDescription> <regimen>0</regimen> <taxation>0</taxation> <description>string</description> <adhereToTicketBai>true</adhereToTicketBai> </ActivityDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["activities"],"summary":"Delete activity by identifier","description":"Delete activity by identifier","operationId":"Activities_Delete","parameters":[{"name":"id","in":"path","description":"activity identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"patch":{"tags":["activities"],"summary":"Update specific properties of an activity","description":"Update specific properties of an activity","operationId":"Activities_Patch","parameters":[{"name":"id","in":"path","description":"Activity identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Collection of {a3ERP.Public.Resources.V2.PatchOperation}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/html":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/activities":{"get":{"tags":["activities"],"summary":"Get all activities","description":"Get all activities","operationId":"Activities_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlatActivityDTOArray"},"example":[{"id":"string","code":"string","name":"string","ecoCompany":"string","ecoActivity":"string","epigraphId":0,"epigraphCode":"string","epigraphDescription":"string","regimen":0,"taxation":0,"description":"string","adhereToTicketBai":true,"isLAFTDisabled":true,"laftDisabledConfirmation":true,"antifraudNonComplianceReason":0,"resignationCode":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/FlatActivityDTOArray"},"example":"<FlatActivityDTOArray> <id>string</id> <code>string</code> <name>string</name> <ecoCompany>string</ecoCompany> <ecoActivity>string</ecoActivity> <epigraphId>0</epigraphId> <epigraphCode>string</epigraphCode> <epigraphDescription>string</epigraphDescription> <regimen>0</regimen> <taxation>0</taxation> <description>string</description> <adhereToTicketBai>true</adhereToTicketBai> <isLAFTDisabled>true</isLAFTDisabled> <laftDisabledConfirmation>true</laftDisabledConfirmation> <antifraudNonComplianceReason>0</antifraudNonComplianceReason> <resignationCode>string</resignationCode> </FlatActivityDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["activities"],"summary":"Add a new Activity","description":"Add a new Activity","operationId":"Activities_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Activity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityDTO"},"example":{"id":"string","code":"string","name":"string","ecoCompany":"string","ecoActivity":"string","epigraphId":0,"epigraphCode":"string","epigraphDescription":"string","regimen":0,"taxation":0,"description":"string","adhereToTicketBai":true}},"text/json":{"schema":{"$ref":"#/components/schemas/ActivityDTO"},"example":{"id":"string","code":"string","name":"string","ecoCompany":"string","ecoActivity":"string","epigraphId":0,"epigraphCode":"string","epigraphDescription":"string","regimen":0,"taxation":0,"description":"string","adhereToTicketBai":true}},"text/html":{"schema":{"$ref":"#/components/schemas/ActivityDTO"},"example":"<ActivityDTO> <id>string</id> <code>string</code> <name>string</name> <ecoCompany>string</ecoCompany> <ecoActivity>string</ecoActivity> <epigraphId>0</epigraphId> <epigraphCode>string</epigraphCode> <epigraphDescription>string</epigraphDescription> <regimen>0</regimen> <taxation>0</taxation> <description>string</description> <adhereToTicketBai>true</adhereToTicketBai> </ActivityDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ActivityDTO"},"example":{"id":"string","code":"string","name":"string","ecoCompany":"string","ecoActivity":"string","epigraphId":0,"epigraphCode":"string","epigraphDescription":"string","regimen":0,"taxation":0,"description":"string","adhereToTicketBai":true}},"application/xml":{"schema":{"$ref":"#/components/schemas/ActivityDTO"},"example":"<ActivityDTO> <id>string</id> <code>string</code> <name>string</name> <ecoCompany>string</ecoCompany> <ecoActivity>string</ecoActivity> <epigraphId>0</epigraphId> <epigraphCode>string</epigraphCode> <epigraphDescription>string</epigraphDescription> <regimen>0</regimen> <taxation>0</taxation> <description>string</description> <adhereToTicketBai>true</adhereToTicketBai> </ActivityDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ActivityDTO"},"example":"<ActivityDTO> <id>string</id> <code>string</code> <name>string</name> <ecoCompany>string</ecoCompany> <ecoActivity>string</ecoActivity> <epigraphId>0</epigraphId> <epigraphCode>string</epigraphCode> <epigraphDescription>string</epigraphDescription> <regimen>0</regimen> <taxation>0</taxation> <description>string</description> <adhereToTicketBai>true</adhereToTicketBai> </ActivityDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Created","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/activities/{idActivity}/antifraud/config":{"put":{"tags":["activities"],"summary":"Update antifraud config of an activity","description":"Update antifraud config of an activity","operationId":"Activities_Put","parameters":[{"name":"idActivity","in":"path","description":"idActivity","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"antifraudConfig","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityAntifraudConfigDTO"},"example":{"isLAFTDisabled":true,"laftDisabledConfirmation":true,"antifraudNonComplianceReason":0,"resignationCode":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/ActivityAntifraudConfigDTO"},"example":{"isLAFTDisabled":true,"laftDisabledConfirmation":true,"antifraudNonComplianceReason":0,"resignationCode":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/ActivityAntifraudConfigDTO"},"example":"<ActivityAntifraudConfigDTO> <isLAFTDisabled>true</isLAFTDisabled> <laftDisabledConfirmation>true</laftDisabledConfirmation> <antifraudNonComplianceReason>0</antifraudNonComplianceReason> <resignationCode>string</resignationCode> </ActivityAntifraudConfigDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ActivityAntifraudConfigDTO"},"example":{"isLAFTDisabled":true,"laftDisabledConfirmation":true,"antifraudNonComplianceReason":0,"resignationCode":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ActivityAntifraudConfigDTO"},"example":"<ActivityAntifraudConfigDTO> <isLAFTDisabled>true</isLAFTDisabled> <laftDisabledConfirmation>true</laftDisabledConfirmation> <antifraudNonComplianceReason>0</antifraudNonComplianceReason> <resignationCode>string</resignationCode> </ActivityAntifraudConfigDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ActivityAntifraudConfigDTO"},"example":"<ActivityAntifraudConfigDTO> <isLAFTDisabled>true</isLAFTDisabled> <laftDisabledConfirmation>true</laftDisabledConfirmation> <antifraudNonComplianceReason>0</antifraudNonComplianceReason> <resignationCode>string</resignationCode> </ActivityAntifraudConfigDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/additionalModules":{"get":{"tags":["additionalModules"],"summary":"Get a list of available modules","description":"Get a list of available modules","operationId":"AdditionalModules_GetModules","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdditionalModuleDTOArray"},"example":[{"name":"string","description":"string","subscribeEndPoint":"string","unsubscribeEndPoint":"string","partnerName":"string","state":0,"frontOfficeURL":"string","logo":[]}]},"application/xml":{"schema":{"$ref":"#/components/schemas/AdditionalModuleDTOArray"},"example":"<AdditionalModuleDTOArray> <name>string</name> <description>string</description> <subscribeEndPoint>string</subscribeEndPoint> <unsubscribeEndPoint>string</unsubscribeEndPoint> <partnerName>string</partnerName> <state>0</state> <frontOfficeURL>string</frontOfficeURL> <logo /> </AdditionalModuleDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/antifraudLaw/configuration":{"get":{"tags":["antifraudLaw"],"summary":"Get Antifraude activation default data","description":"Get Antifraude activation default data","operationId":"AntifraudLaw_GetAntiFraudeConfiguration","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AntifraudLawConfigurationDTO"},"example":{"activation":true,"veriFactuActivation":true,"veriFactuEndDate":"string","motiveNotUse":0,"codeResignation":"string","confirmationNotRequiredToUse":true,"acceptationDate":"string","isProvisional":true,"isRepresentationAuthorized":true,"configuredTimes":0,"digitalCertificateSigned":true,"deadlineNewUsers":"string","corporateDeadlineDate":"string","generalEffectiveDate":"string","provisionalDate":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AntifraudLawConfigurationDTO"},"example":"<AntifraudLawConfigurationDTO> <activation>true</activation> <veriFactuActivation>true</veriFactuActivation> <veriFactuEndDate>string</veriFactuEndDate> <motiveNotUse>0</motiveNotUse> <codeResignation>string</codeResignation> <confirmationNotRequiredToUse>true</confirmationNotRequiredToUse> <acceptationDate>string</acceptationDate> <isProvisional>true</isProvisional> <isRepresentationAuthorized>true</isRepresentationAuthorized> <configuredTimes>0</configuredTimes> <digitalCertificateSigned>true</digitalCertificateSigned> <deadlineNewUsers>string</deadlineNewUsers> <corporateDeadlineDate>string</corporateDeadlineDate> <generalEffectiveDate>string</generalEffectiveDate> <provisionalDate>string</provisionalDate> </AntifraudLawConfigurationDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["antifraudLaw"],"summary":"Antifraude configuration parameters","description":"Descripción de los procesos:\r\n            \r\n    1 - Para configurar una empresa acogida al Reglamento de la Ley Antifraude son necesarios los siguientes parámetros\r\n        activation = true\r\n        veriFactuActivation = true\r\n        motiveNotUse = 0  (valor default)\r\n        softwareUse  = 1 (uso del Software Gestionar mi facturación)\r\n        codeResignation= null\r\n        confirmationNotRequiredToUse = false \r\n        isRepresentationAuthorized = true (indica que el cliente, estando en antifraude, acepta a WK firme en nombre del tributario usando el certificado propio de WK)\r\n        \r\n    2 - Para configurar una empresa NO acogida al Reglamento de la Ley Antifraude son necesarios los siguientes parámetros\r\n        activation = false\r\n        veriFactuActivation = false\r\n        motiveNotUse = 1  (informar el motivo de no estar en el Reglamento de la Ley Antifraude)\r\n                        1 - Empresa acogida al SII\r\n                        2 - Empresa situada fuera del territorio español\r\n                        3 - Empresa establecida en el territorio foral del País Vasco y sujeta a la foralidad\r\n                        4 - Empresa establecida en el territorio foral de Navarra y sujeta a la foralidad\r\n                        5 - Solicitud de no aplicación Art.5 RD 1007/2023\r\n        codeResignation = \"9999999\" (atención si el motivo es 5, es necesario informar el código suministrado por hacienda)\r\n        confirmationNotRequiredToUse = true (este parámetro reconfirma que se ha informado un motívo verídico para no estar acogido al Reglamento)\r\n        isRepresentationAuthorized = false","operationId":"AntifraudLaw_PutConfiguration","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AntifraudLawConfigurationDTO"},"example":{"activation":true,"veriFactuActivation":true,"veriFactuEndDate":"string","motiveNotUse":0,"codeResignation":"string","confirmationNotRequiredToUse":true,"acceptationDate":"string","isProvisional":true,"isRepresentationAuthorized":true,"configuredTimes":0,"digitalCertificateSigned":true,"deadlineNewUsers":"string","corporateDeadlineDate":"string","generalEffectiveDate":"string","provisionalDate":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/AntifraudLawConfigurationDTO"},"example":{"activation":true,"veriFactuActivation":true,"veriFactuEndDate":"string","motiveNotUse":0,"codeResignation":"string","confirmationNotRequiredToUse":true,"acceptationDate":"string","isProvisional":true,"isRepresentationAuthorized":true,"configuredTimes":0,"digitalCertificateSigned":true,"deadlineNewUsers":"string","corporateDeadlineDate":"string","generalEffectiveDate":"string","provisionalDate":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/AntifraudLawConfigurationDTO"},"example":"<AntifraudLawConfigurationDTO> <activation>true</activation> <veriFactuActivation>true</veriFactuActivation> <veriFactuEndDate>string</veriFactuEndDate> <motiveNotUse>0</motiveNotUse> <codeResignation>string</codeResignation> <confirmationNotRequiredToUse>true</confirmationNotRequiredToUse> <acceptationDate>string</acceptationDate> <isProvisional>true</isProvisional> <isRepresentationAuthorized>true</isRepresentationAuthorized> <configuredTimes>0</configuredTimes> <digitalCertificateSigned>true</digitalCertificateSigned> <deadlineNewUsers>string</deadlineNewUsers> <corporateDeadlineDate>string</corporateDeadlineDate> <generalEffectiveDate>string</generalEffectiveDate> <provisionalDate>string</provisionalDate> </AntifraudLawConfigurationDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/AntifraudLawConfigurationDTO"},"example":{"activation":true,"veriFactuActivation":true,"veriFactuEndDate":"string","motiveNotUse":0,"codeResignation":"string","confirmationNotRequiredToUse":true,"acceptationDate":"string","isProvisional":true,"isRepresentationAuthorized":true,"configuredTimes":0,"digitalCertificateSigned":true,"deadlineNewUsers":"string","corporateDeadlineDate":"string","generalEffectiveDate":"string","provisionalDate":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AntifraudLawConfigurationDTO"},"example":"<AntifraudLawConfigurationDTO> <activation>true</activation> <veriFactuActivation>true</veriFactuActivation> <veriFactuEndDate>string</veriFactuEndDate> <motiveNotUse>0</motiveNotUse> <codeResignation>string</codeResignation> <confirmationNotRequiredToUse>true</confirmationNotRequiredToUse> <acceptationDate>string</acceptationDate> <isProvisional>true</isProvisional> <isRepresentationAuthorized>true</isRepresentationAuthorized> <configuredTimes>0</configuredTimes> <digitalCertificateSigned>true</digitalCertificateSigned> <deadlineNewUsers>string</deadlineNewUsers> <corporateDeadlineDate>string</corporateDeadlineDate> <generalEffectiveDate>string</generalEffectiveDate> <provisionalDate>string</provisionalDate> </AntifraudLawConfigurationDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/AntifraudLawConfigurationDTO"},"example":"<AntifraudLawConfigurationDTO> <activation>true</activation> <veriFactuActivation>true</veriFactuActivation> <veriFactuEndDate>string</veriFactuEndDate> <motiveNotUse>0</motiveNotUse> <codeResignation>string</codeResignation> <confirmationNotRequiredToUse>true</confirmationNotRequiredToUse> <acceptationDate>string</acceptationDate> <isProvisional>true</isProvisional> <isRepresentationAuthorized>true</isRepresentationAuthorized> <configuredTimes>0</configuredTimes> <digitalCertificateSigned>true</digitalCertificateSigned> <deadlineNewUsers>string</deadlineNewUsers> <corporateDeadlineDate>string</corporateDeadlineDate> <generalEffectiveDate>string</generalEffectiveDate> <provisionalDate>string</provisionalDate> </AntifraudLawConfigurationDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"204":{"description":"Indicates that the request has been successfully processed and that the response is intentionally blank","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable Content, OK = False and Messages contains errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/antifraudLaw/re-send/{id}":{"post":{"tags":["antifraudLaw"],"summary":"Send LAF invoices","description":"Send LAF invoices","operationId":"AntiFraudLaw_Send","parameters":[{"name":"id","in":"path","description":"invoice correlation Id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiAntifraudLawRe-sendIdPost202ApplicationJsonResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiAntifraudLawRe-sendIdPost202ApplicationXmlResponse"},"example":"<ApiAntifraudLawRe-sendIdPost202ApplicationXmlResponse />"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/antifraudLaw/checkingincidents":{"post":{"tags":["antifraudLaw"],"summary":"Post Checking Incidents","description":"Post Checking Incidents","operationId":"AntifraudLaw_CheckingIncidentsInRecords","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AntifraudLawCheckingIncidentsInRecordsDto"},"example":{"initialDate":"string","endDate":"string","type":0}},"text/json":{"schema":{"$ref":"#/components/schemas/AntifraudLawCheckingIncidentsInRecordsDto"},"example":{"initialDate":"string","endDate":"string","type":0}},"text/html":{"schema":{"$ref":"#/components/schemas/AntifraudLawCheckingIncidentsInRecordsDto"},"example":"<AntifraudLawCheckingIncidentsInRecordsDto> <initialDate>string</initialDate> <endDate>string</endDate> <type>0</type> </AntifraudLawCheckingIncidentsInRecordsDto>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/AntifraudLawCheckingIncidentsInRecordsDto"},"example":{"initialDate":"string","endDate":"string","type":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/AntifraudLawCheckingIncidentsInRecordsDto"},"example":"<AntifraudLawCheckingIncidentsInRecordsDto> <initialDate>string</initialDate> <endDate>string</endDate> <type>0</type> </AntifraudLawCheckingIncidentsInRecordsDto>"},"text/xml":{"schema":{"$ref":"#/components/schemas/AntifraudLawCheckingIncidentsInRecordsDto"},"example":"<AntifraudLawCheckingIncidentsInRecordsDto> <initialDate>string</initialDate> <endDate>string</endDate> <type>0</type> </AntifraudLawCheckingIncidentsInRecordsDto>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/backoffice/showNPS":{"get":{"tags":["backoffice"],"summary":"Get if the NPS form should be displayed","description":"Get if the NPS form should be displayed","operationId":"BackOffice_ShowNPS","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiBackofficeShowNPSGet200ApplicationJsonResponse"},"example":"True"},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiBackofficeShowNPSGet200ApplicationXmlResponse"},"example":"<ApiBackofficeShowNPSGet200ApplicationXmlResponse>true</ApiBackofficeShowNPSGet200ApplicationXmlResponse>"}}}}}},"/api/backoffice/skipvideo":{"get":{"tags":["backoffice"],"summary":"Get skip video value","description":"Get skip video value","operationId":"BackOffice_GetSkipVideo","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiBackofficeSkipvideoGet200ApplicationJsonResponse"},"example":"True"},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiBackofficeSkipvideoGet200ApplicationXmlResponse"},"example":"<ApiBackofficeSkipvideoGet200ApplicationXmlResponse>true</ApiBackofficeSkipvideoGet200ApplicationXmlResponse>"}}}}},"post":{"tags":["backoffice"],"summary":"Set skip video True","description":"Set skip video True","operationId":"BackOffice_SkipVideo","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}}}}},"/api/backoffice/productInfo":{"get":{"tags":["backoffice"],"summary":"Get information about the aplication","description":"Get information about the aplication","operationId":"BackOffice_SelectProductInfo","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductInfoDto"},"example":{"canShowAntifraudeInvoiceStatus":true,"idCDA":"string","description":"string","userPersona":0,"type":0,"licensingStatus":0,"status":"string","isLinked":true,"additionalUsers":0,"tryDays":0,"hasAdvisorInvitation":true,"features":["string"],"applicationsInfoDto":[{"frontOfficeURL":"string","name":"string"}],"softwareVersion":"string","isActiveInTicketBai":true,"ticketBaiErrors":0,"isActiveLeyAntifraude":true,"isSuiteInitialSynchronization":true,"isActiveVeriFactu":true,"realFakeCompanyType":0,"migrationStatus":0,"innuvaTenantId":"string","innuvaPartitionClientId":"string","migrationScenario":0,"isAntifraudWizardShown":true,"isNotNowButtonEnabled":true,"hasLaftAlertCancellation":true,"hasLaftAlertSumbission":true,"hasLaftAlertEvent":true,"latfProvisionalDate":"string","hasLaftIsProvisional":true,"provisionalAlreadyBeenUse":true,"oldWizardConfiguration":true,"latfConfiguredWithDigitalCertificate":true,"isAntifraudLawConfigured":true,"latfDeadlineDateOldLegalEntities":"string","latfDeadlineDateOldNaturalPersons":"string","creationDateCompany":"string","motiveNotUseProvisional":0,"isAntifraudForcedToConfigure":true,"latfForcedWithinDeadline":true}},"application/xml":{"schema":{"$ref":"#/components/schemas/ProductInfoDto"},"example":"<ProductInfoDto> <canShowAntifraudeInvoiceStatus>true</canShowAntifraudeInvoiceStatus> <idCDA>string</idCDA> <description>string</description> <userPersona>0</userPersona> <type>0</type> <licensingStatus>0</licensingStatus> <status>string</status> <isLinked>true</isLinked> <additionalUsers>0</additionalUsers> <tryDays>0</tryDays> <hasAdvisorInvitation>true</hasAdvisorInvitation> <features>string</features> <applicationsInfoDto> <frontOfficeURL>string</frontOfficeURL> <name>string</name> </applicationsInfoDto> <softwareVersion>string</softwareVersion> <isActiveInTicketBai>true</isActiveInTicketBai> <ticketBaiErrors>0</ticketBaiErrors> <isActiveLeyAntifraude>true</isActiveLeyAntifraude> <isSuiteInitialSynchronization>true</isSuiteInitialSynchronization> <isActiveVeriFactu>true</isActiveVeriFactu> <realFakeCompanyType>0</realFakeCompanyType> <migrationStatus>0</migrationStatus> <innuvaTenantId>string</innuvaTenantId> <innuvaPartitionClientId>string</innuvaPartitionClientId> <migrationScenario>0</migrationScenario> <isAntifraudWizardShown>true</isAntifraudWizardShown> <isNotNowButtonEnabled>true</isNotNowButtonEnabled> <hasLaftAlertCancellation>true</hasLaftAlertCancellation> <hasLaftAlertSumbission>true</hasLaftAlertSumbission> <hasLaftAlertEvent>true</hasLaftAlertEvent> <latfProvisionalDate>string</latfProvisionalDate> <hasLaftIsProvisional>true</hasLaftIsProvisional> <provisionalAlreadyBeenUse>true</provisionalAlreadyBeenUse> <oldWizardConfiguration>true</oldWizardConfiguration> <latfConfiguredWithDigitalCertificate>true</latfConfiguredWithDigitalCertificate> <isAntifraudLawConfigured>true</isAntifraudLawConfigured> <latfDeadlineDateOldLegalEntities>string</latfDeadlineDateOldLegalEntities> <latfDeadlineDateOldNaturalPersons>string</latfDeadlineDateOldNaturalPersons> <creationDateCompany>string</creationDateCompany> <motiveNotUseProvisional>0</motiveNotUseProvisional> <isAntifraudForcedToConfigure>true</isAntifraudForcedToConfigure> <latfForcedWithinDeadline>true</latfForcedWithinDeadline> </ProductInfoDto>"}}}}}},"/api/backoffice/showFirstUse":{"get":{"tags":["backoffice"],"summary":"Get if the first use wizard should be displayed","description":"Get if the first use wizard should be displayed","operationId":"BackOffice_ShowFirstUse","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiBackofficeShowFirstUseGet200ApplicationJsonResponse"},"example":"True"},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiBackofficeShowFirstUseGet200ApplicationXmlResponse"},"example":"<ApiBackofficeShowFirstUseGet200ApplicationXmlResponse>true</ApiBackofficeShowFirstUseGet200ApplicationXmlResponse>"}}}}}},"/api/backoffice/answerNPS":{"post":{"tags":["backoffice"],"summary":"Answer NPS","description":"Answer NPS","operationId":"BackOffice_AnswerNPS","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NPSAnswerResource"},"example":{"Answer1":0,"Answer2":0,"Answer3":0,"Answer4":0}},"text/json":{"schema":{"$ref":"#/components/schemas/NPSAnswerResource"},"example":{"Answer1":0,"Answer2":0,"Answer3":0,"Answer4":0}},"text/html":{"schema":{"$ref":"#/components/schemas/NPSAnswerResource"},"example":"<NPSAnswerResource> <Answer1>0</Answer1> <Answer2>0</Answer2> <Answer3>0</Answer3> <Answer4>0</Answer4> </NPSAnswerResource>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/NPSAnswerResource"},"example":{"Answer1":0,"Answer2":0,"Answer3":0,"Answer4":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/NPSAnswerResource"},"example":"<NPSAnswerResource> <Answer1>0</Answer1> <Answer2>0</Answer2> <Answer3>0</Answer3> <Answer4>0</Answer4> </NPSAnswerResource>"},"text/xml":{"schema":{"$ref":"#/components/schemas/NPSAnswerResource"},"example":"<NPSAnswerResource> <Answer1>0</Answer1> <Answer2>0</Answer2> <Answer3>0</Answer3> <Answer4>0</Answer4> </NPSAnswerResource>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}}}}},"/api/backoffice/refuseNPS":{"post":{"tags":["backoffice"],"summary":"Refuse to answer NPS","description":"Refuse to answer NPS","operationId":"BackOffice_RefuseNPS","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}}}}},"/api/backoffice/hideFirstUse":{"post":{"tags":["backoffice"],"summary":"Refuse to show the first use wizard","description":"Refuse to show the first use wizard","operationId":"BackOffice_HideFirstUse","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}}}}},"/api/backoffice/remembercredentials":{"post":{"tags":["backoffice"],"summary":"Rember credentials","description":"Rember credentials","operationId":"BackOffice_RememberCredentials","parameters":[{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Email to send a mail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Email"},"example":"string"},"text/json":{"schema":{"$ref":"#/components/schemas/Email"},"example":"string"},"text/html":{"schema":{"$ref":"#/components/schemas/Email"},"example":"<Email>string</Email>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/Email"},"example":"string"},"application/xml":{"schema":{"$ref":"#/components/schemas/Email"},"example":"<Email>string</Email>"},"text/xml":{"schema":{"$ref":"#/components/schemas/Email"},"example":"<Email>string</Email>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}}}}},"/api/banks/{id}":{"get":{"tags":["banks"],"summary":"Get a bank by identifier","description":"Get a bank by identifier","operationId":"Banks_GetById","parameters":[{"name":"id","in":"path","description":"Bank identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankDTO"},"example":{"id":"string","code":"string","description":"string","iban":"string","swift":"string","isNational":true,"presenterSuffix":"string","creditorSuffix":"string","accountCode":"string","accountId":"string","legacyId":0,"isEnabled":true}},"application/xml":{"schema":{"$ref":"#/components/schemas/BankDTO"},"example":"<BankDTO> <id>string</id> <code>string</code> <description>string</description> <iban>string</iban> <swift>string</swift> <isNational>true</isNational> <presenterSuffix>string</presenterSuffix> <creditorSuffix>string</creditorSuffix> <accountCode>string</accountCode> <accountId>string</accountId> <legacyId>0</legacyId> <isEnabled>true</isEnabled> </BankDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["banks"],"summary":"Delete a bank by identifier","description":"Delete a bank by identifier","operationId":"Banks_Delete","parameters":[{"name":"id","in":"path","description":"Bank identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"patch":{"tags":["banks"],"summary":"Update specific properties of bank","description":"Update specific properties of bank","operationId":"Banks_Patch","parameters":[{"name":"id","in":"path","description":"Bank identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Collection of {a3ERP.Public.Resources.V2.PatchOperation}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/html":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/banks":{"get":{"tags":["banks"],"summary":"Get all banks","description":"Get all banks","operationId":"Banks_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankDTOArray"},"example":[{"id":"string","code":"string","description":"string","iban":"string","swift":"string","isNational":true,"presenterSuffix":"string","creditorSuffix":"string","accountCode":"string","accountId":"string","legacyId":0,"isEnabled":true}]},"application/xml":{"schema":{"$ref":"#/components/schemas/BankDTOArray"},"example":"<BankDTOArray> <id>string</id> <code>string</code> <description>string</description> <iban>string</iban> <swift>string</swift> <isNational>true</isNational> <presenterSuffix>string</presenterSuffix> <creditorSuffix>string</creditorSuffix> <accountCode>string</accountCode> <accountId>string</accountId> <legacyId>0</legacyId> <isEnabled>true</isEnabled> </BankDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["banks"],"summary":"Add a new bank","description":"Add a new bank","operationId":"Banks_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Bank","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankDTO"},"example":{"id":"string","code":"string","description":"string","iban":"string","swift":"string","isNational":true,"presenterSuffix":"string","creditorSuffix":"string","accountCode":"string","accountId":"string","legacyId":0,"isEnabled":true}},"text/json":{"schema":{"$ref":"#/components/schemas/BankDTO"},"example":{"id":"string","code":"string","description":"string","iban":"string","swift":"string","isNational":true,"presenterSuffix":"string","creditorSuffix":"string","accountCode":"string","accountId":"string","legacyId":0,"isEnabled":true}},"text/html":{"schema":{"$ref":"#/components/schemas/BankDTO"},"example":"<BankDTO> <id>string</id> <code>string</code> <description>string</description> <iban>string</iban> <swift>string</swift> <isNational>true</isNational> <presenterSuffix>string</presenterSuffix> <creditorSuffix>string</creditorSuffix> <accountCode>string</accountCode> <accountId>string</accountId> <legacyId>0</legacyId> <isEnabled>true</isEnabled> </BankDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/BankDTO"},"example":{"id":"string","code":"string","description":"string","iban":"string","swift":"string","isNational":true,"presenterSuffix":"string","creditorSuffix":"string","accountCode":"string","accountId":"string","legacyId":0,"isEnabled":true}},"application/xml":{"schema":{"$ref":"#/components/schemas/BankDTO"},"example":"<BankDTO> <id>string</id> <code>string</code> <description>string</description> <iban>string</iban> <swift>string</swift> <isNational>true</isNational> <presenterSuffix>string</presenterSuffix> <creditorSuffix>string</creditorSuffix> <accountCode>string</accountCode> <accountId>string</accountId> <legacyId>0</legacyId> <isEnabled>true</isEnabled> </BankDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/BankDTO"},"example":"<BankDTO> <id>string</id> <code>string</code> <description>string</description> <iban>string</iban> <swift>string</swift> <isNational>true</isNational> <presenterSuffix>string</presenterSuffix> <creditorSuffix>string</creditorSuffix> <accountCode>string</accountCode> <accountId>string</accountId> <legacyId>0</legacyId> <isEnabled>true</isEnabled> </BankDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Created","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies":{"get":{"tags":["companies"],"summary":"Companies_Get","operationId":"Companies_Get","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyDTOArray"},"example":[{"id":0,"name":"string","idCDA":"string","default":true,"companyStatus":"Updating"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/CompanyDTOArray"},"example":"<CompanyDTOArray> <id>0</id> <name>string</name> <idCDA>string</idCDA> <default>true</default> <companyStatus>Updating</companyStatus> </CompanyDTOArray>"}}}}}},"/api/companies/{id}/image":{"get":{"tags":["companies"],"summary":"Gets the company image","description":"Gets the company image","operationId":"Companies_GetImage","parameters":[{"name":"id","in":"path","description":"Company identifier","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"image/jpeg":{"schema":{"$ref":"#/components/schemas/ApiCompaniesIdImageGet200ImageJpegResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"image/jpeg":{}}},"401":{"description":"Unauthorized","content":{"image/jpeg":{}}},"500":{"description":"Internal server error","content":{"image/jpeg":{}}}}}},"/api/companies/{id}/select":{"post":{"tags":["companies"],"summary":"Select a company","description":"Select a company","operationId":"Companies_Select","parameters":[{"name":"id","in":"path","description":"Company identifier","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshToken"},"example":"string"},"text/json":{"schema":{"$ref":"#/components/schemas/RefreshToken"},"example":"string"},"text/html":{"schema":{"$ref":"#/components/schemas/RefreshToken"},"example":"<RefreshToken>string</RefreshToken>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/RefreshToken"},"example":"string"},"application/xml":{"schema":{"$ref":"#/components/schemas/RefreshToken"},"example":"<RefreshToken>string</RefreshToken>"},"text/xml":{"schema":{"$ref":"#/components/schemas/RefreshToken"},"example":"<RefreshToken>string</RefreshToken>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectCompanyResponse"},"example":{"companyStatus":"Updating","token":"string","refreshToken":"string","productType":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/SelectCompanyResponse"},"example":"<SelectCompanyResponse> <companyStatus>Updating</companyStatus> <token>string</token> <refreshToken>string</refreshToken> <productType>0</productType> </SelectCompanyResponse>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/company":{"get":{"tags":["company"],"summary":"Get a company data","description":"Get a company data","operationId":"Company_Get","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyDataDTO"},"example":{"personType":"string","vatNumber":"string","companyName":"string","name":"string","surname":"string","businessName":"string","address":"string","town":"string","zipCode":"string","provinceCode":"string","countryCode":"string","phone":"string","phone2":"string","mail":"string","web":"string","emailCompanyActivated":true,"emailFromName":"string","emailReplyToAddress":"string","companyRegimen":0,"invoiceEmittedByThirdParty":true,"thirdPartyVatNumberType":0,"thirdPartyVatNumber":"string","thirdPartyName":"string","thirdPartyCountryCode":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CompanyDataDTO"},"example":"<CompanyDataDTO> <personType>string</personType> <vatNumber>string</vatNumber> <companyName>string</companyName> <name>string</name> <surname>string</surname> <businessName>string</businessName> <address>string</address> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <countryCode>string</countryCode> <phone>string</phone> <phone2>string</phone2> <mail>string</mail> <web>string</web> <emailCompanyActivated>true</emailCompanyActivated> <emailFromName>string</emailFromName> <emailReplyToAddress>string</emailReplyToAddress> <companyRegimen>0</companyRegimen> <invoiceEmittedByThirdParty>true</invoiceEmittedByThirdParty> <thirdPartyVatNumberType>0</thirdPartyVatNumberType> <thirdPartyVatNumber>string</thirdPartyVatNumber> <thirdPartyName>string</thirdPartyName> <thirdPartyCountryCode>string</thirdPartyCountryCode> </CompanyDataDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"patch":{"tags":["company"],"summary":"Update a company data","description":"Update a company data","operationId":"Company_Patch","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Collection of {a3ERP.Public.Resources.V2.PatchOperation}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/html":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/company/image":{"get":{"tags":["company"],"summary":"Get the company's image","description":"Get the company's image","operationId":"Company_GetImage","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"image/jpeg":{"schema":{"$ref":"#/components/schemas/ApiCompanyImageGet200ImageJpegResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"image/jpeg":{}}},"401":{"description":"Unauthorized","content":{"image/jpeg":{}}},"404":{"description":"Not found","content":{"image/jpeg":{}}},"500":{"description":"Internal server error","content":{"image/jpeg":{}}}}},"put":{"tags":["company"],"summary":"Update the company's image","description":"Update the company's image","operationId":"Company_PutImage","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["uploadedFile"],"properties":{"uploadedFile":{"type":"array","description":"File to upload"}}}}}},"responses":{"204":{"description":"No content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["company"],"summary":"Deletes the image from the company","description":"Deletes the image from the company","operationId":"Company_DeleteImage","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"204":{"description":"NoContent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/company/features":{"get":{"tags":["company"],"summary":"Get the features of the company","description":"Get the features of the company","operationId":"Company_GetFeatures","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiCompanyFeaturesGet200ApplicationJsonResponse"},"example":["string"]},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiCompanyFeaturesGet200ApplicationXmlResponse"},"example":"<ApiCompanyFeaturesGet200ApplicationXmlResponse>string</ApiCompanyFeaturesGet200ApplicationXmlResponse>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/company/settings":{"get":{"tags":["company"],"summary":"Get company settings","description":"Get company settings","operationId":"Company_GetSettings","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanySettingsDTO"},"example":{"activityId":"string","saleOperationType":"string","purchaseOperationType":"string","saleVatType":"string","purchaseVatType":"string","includedTax":true,"irpfPercentage":0,"irpfCode":"string","bankId":"string","paymentTypeId":"string","paymentMethodId":"string","saleFeeId":"string","purchaseRateId":"string","quotaCharacter":"string","saleInvoiceType":"string","saleOfferSerieId":"string","saleOrderSerieId":"string","saleDeliveryNoteSerieId":"string","saleInvoiceSerieId":"string","rectificationSaleInvoiceSerieId":"string","purchaseInvoiceSerieId":"string","rectificationPurchaseInvoiceSerieId":"string","purchaseDeliveryNoteSerieId":"string","purchaseOrderSerieId":"string","decimalUnits":0,"decimalPrices":0,"mercantileRegistry":"string","gdpr":"string","saleOfferTemplateCode":"string","saleOrderTemplateCode":"string","saleDeliveryNoteTemplateCode":"string","saleInvoiceTemplateCode":"string","currencyCode":"string","allAffectStock":true,"defaultValuationInProduct":"string","allowNegativeStock":true,"accountingPlanConfiguration":0,"companyRegimen":0,"confidentiality":true,"defaultDeliveryLabelTemplateCode":"string","warehouseCorrelationId":"string","lowStockAlert":true,"batches":true,"expirationDates":true,"allowExpiredDates":true,"serialNumbers":true,"allocatedCostsCriteria":"string","saleDiscountId":"00000000-0000-0000-0000-000000000000","purchaseDiscountId":"00000000-0000-0000-0000-000000000000","validationAEAT":true,"draftTemplateCode":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CompanySettingsDTO"},"example":"<CompanySettingsDTO> <activityId>string</activityId> <saleOperationType>string</saleOperationType> <purchaseOperationType>string</purchaseOperationType> <saleVatType>string</saleVatType> <purchaseVatType>string</purchaseVatType> <includedTax>true</includedTax> <irpfPercentage>0</irpfPercentage> <irpfCode>string</irpfCode> <bankId>string</bankId> <paymentTypeId>string</paymentTypeId> <paymentMethodId>string</paymentMethodId> <saleFeeId>string</saleFeeId> <purchaseRateId>string</purchaseRateId> <quotaCharacter>string</quotaCharacter> <saleInvoiceType>string</saleInvoiceType> <saleOfferSerieId>string</saleOfferSerieId> <saleOrderSerieId>string</saleOrderSerieId> <saleDeliveryNoteSerieId>string</saleDeliveryNoteSerieId> <saleInvoiceSerieId>string</saleInvoiceSerieId> <rectificationSaleInvoiceSerieId>string</rectificationSaleInvoiceSerieId> <purchaseInvoiceSerieId>string</purchaseInvoiceSerieId> <rectificationPurchaseInvoiceSerieId>string</rectificationPurchaseInvoiceSerieId> <purchaseDeliveryNoteSerieId>string</purchaseDeliveryNoteSerieId> <purchaseOrderSerieId>string</purchaseOrderSerieId> <decimalUnits>0</decimalUnits> <decimalPrices>0</decimalPrices> <mercantileRegistry>string</mercantileRegistry> <gdpr>string</gdpr> <saleOfferTemplateCode>string</saleOfferTemplateCode> <saleOrderTemplateCode>string</saleOrderTemplateCode> <saleDeliveryNoteTemplateCode>string</saleDeliveryNoteTemplateCode> <saleInvoiceTemplateCode>string</saleInvoiceTemplateCode> <currencyCode>string</currencyCode> <allAffectStock>true</allAffectStock> <defaultValuationInProduct>string</defaultValuationInProduct> <allowNegativeStock>true</allowNegativeStock> <accountingPlanConfiguration>0</accountingPlanConfiguration> <companyRegimen>0</companyRegimen> <confidentiality>true</confidentiality> <defaultDeliveryLabelTemplateCode>string</defaultDeliveryLabelTemplateCode> <warehouseCorrelationId>string</warehouseCorrelationId> <lowStockAlert>true</lowStockAlert> <batches>true</batches> <expirationDates>true</expirationDates> <allowExpiredDates>true</allowExpiredDates> <serialNumbers>true</serialNumbers> <allocatedCostsCriteria>string</allocatedCostsCriteria> <saleDiscountId>00000000-0000-0000-0000-000000000000</saleDiscountId> <purchaseDiscountId>00000000-0000-0000-0000-000000000000</purchaseDiscountId> <validationAEAT>true</validationAEAT> <draftTemplateCode>string</draftTemplateCode> </CompanySettingsDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"patch":{"tags":["company"],"summary":"Update company settings","description":"Update company settings","operationId":"Company_PatchSettings","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Collection of {a3ERP.Public.Resources.V2.PatchOperation}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/html":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/company/ticketbai":{"get":{"tags":["company"],"summary":"Get the company TBAI Info","description":"Get the company TBAI Info","operationId":"Company_GetTBAIInfo","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TBAIInfoDTO"},"example":{"manufacture":"string","manufactureVat":"string","product":"string","softwareVersion":"string","activationDate":"string","taxAdministration":0,"epigraph":"string","lroeType":"string","companyRegime":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/TBAIInfoDTO"},"example":"<TBAIInfoDTO> <manufacture>string</manufacture> <manufactureVat>string</manufactureVat> <product>string</product> <softwareVersion>string</softwareVersion> <activationDate>string</activationDate> <taxAdministration>0</taxAdministration> <epigraph>string</epigraph> <lroeType>string</lroeType> <companyRegime>0</companyRegime> </TBAIInfoDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["company"],"summary":"Activate TicketBAI","description":"Activate TicketBAI","operationId":"Company_Put","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElectronicBillActivationDTO"},"example":{"vatNumber":"string","companyName":"string","taxAdministration":0,"activationDate":"string","invoiceTemplate":"string","epigraph":"string","lroeType":0,"acceptTerms":true,"companyRegime":0,"confidentiality":true,"zipCode":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/ElectronicBillActivationDTO"},"example":{"vatNumber":"string","companyName":"string","taxAdministration":0,"activationDate":"string","invoiceTemplate":"string","epigraph":"string","lroeType":0,"acceptTerms":true,"companyRegime":0,"confidentiality":true,"zipCode":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/ElectronicBillActivationDTO"},"example":"<ElectronicBillActivationDTO> <vatNumber>string</vatNumber> <companyName>string</companyName> <taxAdministration>0</taxAdministration> <activationDate>string</activationDate> <invoiceTemplate>string</invoiceTemplate> <epigraph>string</epigraph> <lroeType>0</lroeType> <acceptTerms>true</acceptTerms> <companyRegime>0</companyRegime> <confidentiality>true</confidentiality> <zipCode>string</zipCode> </ElectronicBillActivationDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ElectronicBillActivationDTO"},"example":{"vatNumber":"string","companyName":"string","taxAdministration":0,"activationDate":"string","invoiceTemplate":"string","epigraph":"string","lroeType":0,"acceptTerms":true,"companyRegime":0,"confidentiality":true,"zipCode":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ElectronicBillActivationDTO"},"example":"<ElectronicBillActivationDTO> <vatNumber>string</vatNumber> <companyName>string</companyName> <taxAdministration>0</taxAdministration> <activationDate>string</activationDate> <invoiceTemplate>string</invoiceTemplate> <epigraph>string</epigraph> <lroeType>0</lroeType> <acceptTerms>true</acceptTerms> <companyRegime>0</companyRegime> <confidentiality>true</confidentiality> <zipCode>string</zipCode> </ElectronicBillActivationDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ElectronicBillActivationDTO"},"example":"<ElectronicBillActivationDTO> <vatNumber>string</vatNumber> <companyName>string</companyName> <taxAdministration>0</taxAdministration> <activationDate>string</activationDate> <invoiceTemplate>string</invoiceTemplate> <epigraph>string</epigraph> <lroeType>0</lroeType> <acceptTerms>true</acceptTerms> <companyRegime>0</companyRegime> <confidentiality>true</confidentiality> <zipCode>string</zipCode> </ElectronicBillActivationDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/company/fakeRealType":{"get":{"tags":["company"],"summary":"Get company type data","description":"Unknown = 0,\r\nReal = 1,\r\nFake = 2","operationId":"FakeRea_GetConfigurationFakeCompany","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiCompanyFakeRealTypeGet200ApplicationJsonResponse"},"example":"Unknown"},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiCompanyFakeRealTypeGet200ApplicationXmlResponse"},"example":"<ApiCompanyFakeRealTypeGet200ApplicationXmlResponse>Unknown</ApiCompanyFakeRealTypeGet200ApplicationXmlResponse>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["company"],"summary":"Put company type","description":"Put company type","operationId":"FakeRea_PutConfiguration","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FakeRealCompanyConfigurationDto"},"example":{"realFakeCompanyType":0}},"text/json":{"schema":{"$ref":"#/components/schemas/FakeRealCompanyConfigurationDto"},"example":{"realFakeCompanyType":0}},"text/html":{"schema":{"$ref":"#/components/schemas/FakeRealCompanyConfigurationDto"},"example":"<FakeRealCompanyConfigurationDto> <realFakeCompanyType>0</realFakeCompanyType> </FakeRealCompanyConfigurationDto>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/FakeRealCompanyConfigurationDto"},"example":{"realFakeCompanyType":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/FakeRealCompanyConfigurationDto"},"example":"<FakeRealCompanyConfigurationDto> <realFakeCompanyType>0</realFakeCompanyType> </FakeRealCompanyConfigurationDto>"},"text/xml":{"schema":{"$ref":"#/components/schemas/FakeRealCompanyConfigurationDto"},"example":"<FakeRealCompanyConfigurationDto> <realFakeCompanyType>0</realFakeCompanyType> </FakeRealCompanyConfigurationDto>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/company/configuration":{"get":{"tags":["company"],"summary":"Get the company configuration","description":"Get the company configuration","operationId":"Company_GetConfiguration","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigurationValueDTOArray"},"example":[{"key":"string","value":{}}]},"application/xml":{"schema":{"$ref":"#/components/schemas/ConfigurationValueDTOArray"},"example":"<ConfigurationValueDTOArray> <key>string</key> <value /> </ConfigurationValueDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/company/drafttemplates":{"get":{"tags":["company"],"summary":"Get the company draft report templates","description":"Get the company draft report templates","operationId":"Company_GetDraftReportTemplates","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportTemplateDTOArray"},"example":[{"id":"string","code":"string","title":"string","tags":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/ReportTemplateDTOArray"},"example":"<ReportTemplateDTOArray> <id>string</id> <code>string</code> <title>string</title> <tags>string</tags> </ReportTemplateDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/company/offertemplates":{"get":{"tags":["company"],"summary":"Get the company offer report templates","description":"Get the company offer report templates","operationId":"Company_GetOfferReportTemplates","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportTemplateDTOArray"},"example":[{"id":"string","code":"string","title":"string","tags":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/ReportTemplateDTOArray"},"example":"<ReportTemplateDTOArray> <id>string</id> <code>string</code> <title>string</title> <tags>string</tags> </ReportTemplateDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/company/ordertemplates":{"get":{"tags":["company"],"summary":"Get the company order report templates","description":"Get the company order report templates","operationId":"Company_GetOrderReportTemplates","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportTemplateDTOArray"},"example":[{"id":"string","code":"string","title":"string","tags":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/ReportTemplateDTOArray"},"example":"<ReportTemplateDTOArray> <id>string</id> <code>string</code> <title>string</title> <tags>string</tags> </ReportTemplateDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/company/delierynotetemplates":{"get":{"tags":["company"],"summary":"Get the company delivery note report templates","description":"Get the company delivery note report templates","operationId":"Company_GetDeliveryNoteReportTemplates","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportTemplateDTOArray"},"example":[{"id":"string","code":"string","title":"string","tags":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/ReportTemplateDTOArray"},"example":"<ReportTemplateDTOArray> <id>string</id> <code>string</code> <title>string</title> <tags>string</tags> </ReportTemplateDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/company/ticketbai/onboarding":{"get":{"tags":["company"],"summary":"Get TicketBAI activation default data","description":"Get TicketBAI activation default data","operationId":"Company_GetTicketBaiOnboarding","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElectronicBillActivationDTO"},"example":{"vatNumber":"string","companyName":"string","taxAdministration":0,"activationDate":"string","invoiceTemplate":"string","epigraph":"string","lroeType":0,"acceptTerms":true,"companyRegime":0,"confidentiality":true,"zipCode":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ElectronicBillActivationDTO"},"example":"<ElectronicBillActivationDTO> <vatNumber>string</vatNumber> <companyName>string</companyName> <taxAdministration>0</taxAdministration> <activationDate>string</activationDate> <invoiceTemplate>string</invoiceTemplate> <epigraph>string</epigraph> <lroeType>0</lroeType> <acceptTerms>true</acceptTerms> <companyRegime>0</companyRegime> <confidentiality>true</confidentiality> <zipCode>string</zipCode> </ElectronicBillActivationDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/company/accountsgroups/{type}":{"get":{"tags":["company"],"summary":"Get accounts groups","description":"Get accounts groups","operationId":"Company_GetAccountsGroups","parameters":[{"name":"type","in":"path","description":"Group type: Income types =  1, Expense types = 2","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountsGroupDTOArray"},"example":[{"code":"string","description":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/AccountsGroupDTOArray"},"example":"<AccountsGroupDTOArray> <code>string</code> <description>string</description> </AccountsGroupDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/company/settings/antifraudlaw":{"get":{"tags":["company"],"summary":"Get whether the company is allowed to access the api according to the antifraud regulation","description":"Get whether the company is allowed to access the api according to the antifraud regulation","operationId":"Company_IsLatfCompliant","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanySettingsAntifraudDTO"},"example":{"allowed":true,"reason":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CompanySettingsAntifraudDTO"},"example":"<CompanySettingsAntifraudDTO> <allowed>true</allowed> <reason>string</reason> </CompanySettingsAntifraudDTO>"}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/company/deliverylabeltemplates":{"get":{"tags":["company"],"summary":"Get the company delivery labels report templates","description":"Get the company delivery labels report templates","operationId":"Company_GetDeliveryLabelReportTemplates","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportTemplateDTOArray"},"example":[{"id":"string","code":"string","title":"string","tags":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/ReportTemplateDTOArray"},"example":"<ReportTemplateDTOArray> <id>string</id> <code>string</code> <title>string</title> <tags>string</tags> </ReportTemplateDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/company/invoicetemplates":{"get":{"tags":["company"],"summary":"Get the company invoice report templates","description":"Get the company invoice report templates","operationId":"Company_GetInvoiceReportTemplates","parameters":[{"name":"tags","in":"query","description":"Filter the templates that have any of the tags in the semicolon delimited list (or all the templates if no tags are specified)","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportTemplateDTOArray"},"example":[{"id":"string","code":"string","title":"string","tags":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/ReportTemplateDTOArray"},"example":"<ReportTemplateDTOArray> <id>string</id> <code>string</code> <title>string</title> <tags>string</tags> </ReportTemplateDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/company/initialsetting":{"put":{"tags":["company"],"summary":"Put company type, vatnumber and company name (can not set in A3Innuva company type)","description":"Put company type, vatnumber and company name (can not set in A3Innuva company type)","operationId":"FakeRea_SetFakeOrRealCompanyWithVatNumberAndCompanyName","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyInitialSettingDto"},"example":{"realFakeCompanyType":0,"companyVatNumber":"string","companyName":"string","personType":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/CompanyInitialSettingDto"},"example":{"realFakeCompanyType":0,"companyVatNumber":"string","companyName":"string","personType":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/CompanyInitialSettingDto"},"example":"<CompanyInitialSettingDto> <realFakeCompanyType>0</realFakeCompanyType> <companyVatNumber>string</companyVatNumber> <companyName>string</companyName> <personType>string</personType> </CompanyInitialSettingDto>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/CompanyInitialSettingDto"},"example":{"realFakeCompanyType":0,"companyVatNumber":"string","companyName":"string","personType":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CompanyInitialSettingDto"},"example":"<CompanyInitialSettingDto> <realFakeCompanyType>0</realFakeCompanyType> <companyVatNumber>string</companyVatNumber> <companyName>string</companyName> <personType>string</personType> </CompanyInitialSettingDto>"},"text/xml":{"schema":{"$ref":"#/components/schemas/CompanyInitialSettingDto"},"example":"<CompanyInitialSettingDto> <realFakeCompanyType>0</realFakeCompanyType> <companyVatNumber>string</companyVatNumber> <companyName>string</companyName> <personType>string</personType> </CompanyInitialSettingDto>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/company/fakeCompany":{"delete":{"tags":["company"],"summary":"Delete fake company","description":"Delete fake company","operationId":"FakeRea_Delete","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/countries":{"get":{"tags":["countries"],"summary":"Get all countries","description":"Get all countries","operationId":"Countries_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountryDTOArray"},"example":[{"code":"string","description":"string","vatNumberCode":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/CountryDTOArray"},"example":"<CountryDTOArray> <code>string</code> <description>string</description> <vatNumberCode>string</vatNumberCode> </CountryDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/currencies/{code}":{"get":{"tags":["currencies"],"summary":"Get a currency by code","description":"Get a currency by code","operationId":"Currencies_GetById","parameters":[{"name":"code","in":"path","description":"Currency code","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrencyDTO"},"example":{"code":"string","iso":"string","iso3166":"string","description":"string","symbol":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CurrencyDTO"},"example":"<CurrencyDTO> <code>string</code> <iso>string</iso> <iso3166>string</iso3166> <description>string</description> <symbol>string</symbol> </CurrencyDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/currencies":{"get":{"tags":["currencies"],"summary":"Get all currencies","description":"Get all currencies","operationId":"Currencies_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrencyDTOArray"},"example":[{"code":"string","iso":"string","iso3166":"string","description":"string","symbol":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/CurrencyDTOArray"},"example":"<CurrencyDTOArray> <code>string</code> <iso>string</iso> <iso3166>string</iso3166> <description>string</description> <symbol>string</symbol> </CurrencyDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/customers/new":{"get":{"tags":["customers"],"summary":"Get a new customer with default values","description":"Get a new customer with default values","operationId":"Customers_GetNew","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDTO"},"example":{"id":"string","creationDate":"string","vatNumber":"string","vatNumberType":0,"code":"string","name":"string","businessName":"string","web":"string","address":{"correlationId":"string","street":"string","town":"string","zipCode":"string","provinceCode":"string","provinceName":"string","countryCode":"string","localization":"string"},"phone":"string","mail":"string","mailCC":"string","isSameAddress":true,"businessAddress":{"correlationId":"string","street":"string","town":"string","zipCode":"string","provinceCode":"string","provinceName":"string","countryCode":"string","localization":"string"},"businessPhone":"string","businessMail":"string","businessMailCC":"string","annotations":"string","rateId":"string","discountId":"00000000-0000-0000-0000-000000000000","discountPercentage":0,"bankId":"string","paymentTypeId":"string","paymentMethodId":"string","paymentDay1":0,"paymentDay2":0,"paymentDay3":0,"operationType":"string","taxType":"string","taxIncluded":true,"applyIRPF":true,"sendPdfByEmail":true,"directDebit":{"id":"string","name":"string","account":"string","isNational":true,"bicswift":"string","isDefault":true,"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string"},"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string","contact":{"id":"string","name":"string","mail":"string","phone":"string","source":"string","sourceId":"string"},"representativeId":"string","representativeName":"string","source":"string","sourceId":"string","saleOfferTemplateId":"string","saleOrderTemplateId":"string","saleDeliveryNoteTemplateId":"string","saleInvoiceTemplateId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"accountCode":"string","accountId":"string","customerFaceData":{"id":"string","accountingOfficeCode":"string","accountingOffice":"string","organManagingCode":"string","organManaging":"string","processingUnitCode":"string","processingUnit":"string","proposingOrganCode":"string","proposingOrgan":"string"},"transactionType":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/CustomerDTO"},"example":"<CustomerDTO> <id>string</id> <creationDate>string</creationDate> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <code>string</code> <name>string</name> <businessName>string</businessName> <web>string</web> <address> <correlationId>string</correlationId> <street>string</street> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <localization>string</localization> </address> <phone>string</phone> <mail>string</mail> <mailCC>string</mailCC> <isSameAddress>true</isSameAddress> <businessAddress> <correlationId>string</correlationId> <street>string</street> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <localization>string</localization> </businessAddress> <businessPhone>string</businessPhone> <businessMail>string</businessMail> <businessMailCC>string</businessMailCC> <annotations>string</annotations> <rateId>string</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> <discountPercentage>0</discountPercentage> <bankId>string</bankId> <paymentTypeId>string</paymentTypeId> <paymentMethodId>string</paymentMethodId> <paymentDay1>0</paymentDay1> <paymentDay2>0</paymentDay2> <paymentDay3>0</paymentDay3> <operationType>string</operationType> <taxType>string</taxType> <taxIncluded>true</taxIncluded> <applyIRPF>true</applyIRPF> <sendPdfByEmail>true</sendPdfByEmail> <directDebit> <id>string</id> <name>string</name> <account>string</account> <isNational>true</isNational> <bicswift>string</bicswift> <isDefault>true</isDefault> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> </directDebit> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> <contact> <id>string</id> <name>string</name> <mail>string</mail> <phone>string</phone> <source>string</source> <sourceId>string</sourceId> </contact> <representativeId>string</representativeId> <representativeName>string</representativeName> <source>string</source> <sourceId>string</sourceId> <saleOfferTemplateId>string</saleOfferTemplateId> <saleOrderTemplateId>string</saleOrderTemplateId> <saleDeliveryNoteTemplateId>string</saleDeliveryNoteTemplateId> <saleInvoiceTemplateId>string</saleInvoiceTemplateId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <accountCode>string</accountCode> <accountId>string</accountId> <customerFaceData> <id>string</id> <accountingOfficeCode>string</accountingOfficeCode> <accountingOffice>string</accountingOffice> <organManagingCode>string</organManagingCode> <organManaging>string</organManaging> <processingUnitCode>string</processingUnitCode> <processingUnit>string</processingUnit> <proposingOrganCode>string</proposingOrganCode> <proposingOrgan>string</proposingOrgan> </customerFaceData> <transactionType>0</transactionType> </CustomerDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/customers/{id}":{"get":{"tags":["customers"],"summary":"Get a customer by identifier","description":"Get a customer by identifier","operationId":"Customers_GetById","parameters":[{"name":"id","in":"path","description":"Customer identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDTO"},"example":{"id":"string","creationDate":"string","vatNumber":"string","vatNumberType":0,"code":"string","name":"string","businessName":"string","web":"string","address":{"correlationId":"string","street":"string","town":"string","zipCode":"string","provinceCode":"string","provinceName":"string","countryCode":"string","localization":"string"},"phone":"string","mail":"string","mailCC":"string","isSameAddress":true,"businessAddress":{"correlationId":"string","street":"string","town":"string","zipCode":"string","provinceCode":"string","provinceName":"string","countryCode":"string","localization":"string"},"businessPhone":"string","businessMail":"string","businessMailCC":"string","annotations":"string","rateId":"string","discountId":"00000000-0000-0000-0000-000000000000","discountPercentage":0,"bankId":"string","paymentTypeId":"string","paymentMethodId":"string","paymentDay1":0,"paymentDay2":0,"paymentDay3":0,"operationType":"string","taxType":"string","taxIncluded":true,"applyIRPF":true,"sendPdfByEmail":true,"directDebit":{"id":"string","name":"string","account":"string","isNational":true,"bicswift":"string","isDefault":true,"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string"},"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string","contact":{"id":"string","name":"string","mail":"string","phone":"string","source":"string","sourceId":"string"},"representativeId":"string","representativeName":"string","source":"string","sourceId":"string","saleOfferTemplateId":"string","saleOrderTemplateId":"string","saleDeliveryNoteTemplateId":"string","saleInvoiceTemplateId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"accountCode":"string","accountId":"string","customerFaceData":{"id":"string","accountingOfficeCode":"string","accountingOffice":"string","organManagingCode":"string","organManaging":"string","processingUnitCode":"string","processingUnit":"string","proposingOrganCode":"string","proposingOrgan":"string"},"transactionType":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/CustomerDTO"},"example":"<CustomerDTO> <id>string</id> <creationDate>string</creationDate> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <code>string</code> <name>string</name> <businessName>string</businessName> <web>string</web> <address> <correlationId>string</correlationId> <street>string</street> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <localization>string</localization> </address> <phone>string</phone> <mail>string</mail> <mailCC>string</mailCC> <isSameAddress>true</isSameAddress> <businessAddress> <correlationId>string</correlationId> <street>string</street> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <localization>string</localization> </businessAddress> <businessPhone>string</businessPhone> <businessMail>string</businessMail> <businessMailCC>string</businessMailCC> <annotations>string</annotations> <rateId>string</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> <discountPercentage>0</discountPercentage> <bankId>string</bankId> <paymentTypeId>string</paymentTypeId> <paymentMethodId>string</paymentMethodId> <paymentDay1>0</paymentDay1> <paymentDay2>0</paymentDay2> <paymentDay3>0</paymentDay3> <operationType>string</operationType> <taxType>string</taxType> <taxIncluded>true</taxIncluded> <applyIRPF>true</applyIRPF> <sendPdfByEmail>true</sendPdfByEmail> <directDebit> <id>string</id> <name>string</name> <account>string</account> <isNational>true</isNational> <bicswift>string</bicswift> <isDefault>true</isDefault> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> </directDebit> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> <contact> <id>string</id> <name>string</name> <mail>string</mail> <phone>string</phone> <source>string</source> <sourceId>string</sourceId> </contact> <representativeId>string</representativeId> <representativeName>string</representativeName> <source>string</source> <sourceId>string</sourceId> <saleOfferTemplateId>string</saleOfferTemplateId> <saleOrderTemplateId>string</saleOrderTemplateId> <saleDeliveryNoteTemplateId>string</saleDeliveryNoteTemplateId> <saleInvoiceTemplateId>string</saleInvoiceTemplateId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <accountCode>string</accountCode> <accountId>string</accountId> <customerFaceData> <id>string</id> <accountingOfficeCode>string</accountingOfficeCode> <accountingOffice>string</accountingOffice> <organManagingCode>string</organManagingCode> <organManaging>string</organManaging> <processingUnitCode>string</processingUnitCode> <processingUnit>string</processingUnit> <proposingOrganCode>string</proposingOrganCode> <proposingOrgan>string</proposingOrgan> </customerFaceData> <transactionType>0</transactionType> </CustomerDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["customers"],"summary":"Delete a customer by identifier","description":"Delete a customer by identifier","operationId":"Customers_Delete","parameters":[{"name":"id","in":"path","description":"Customer identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"patch":{"tags":["customers"],"summary":"Update specific properties of customer","description":"Update specific properties of customer","operationId":"Customers_Patch","parameters":[{"name":"id","in":"path","description":"Customer identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Collection of {a3ERP.Public.Resources.V2.PatchOperation}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/html":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/customers/{id}/image":{"get":{"tags":["customers"],"summary":"Get the customer's image","description":"Get the customer's image","operationId":"Customers_GetImage","parameters":[{"name":"id","in":"path","description":"Customer identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"image/jpeg":{"schema":{"$ref":"#/components/schemas/ApiCustomersIdImageGet200ImageJpegResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"image/jpeg":{"schema":{"$ref":"#/components/schemas/ApiCustomersIdImageGet204ImageJpegResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"image/jpeg":{}}},"401":{"description":"Unauthorized","content":{"image/jpeg":{}}},"404":{"description":"Unprocessable request","content":{"image/jpeg":{}}},"500":{"description":"Internal server error","content":{"image/jpeg":{}}}}},"put":{"tags":["customers"],"summary":"Update the customer's image","description":"Update the customer's image","operationId":"Customers_PutImage","parameters":[{"name":"id","in":"path","description":"Customer identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["uploadedFile"],"properties":{"uploadedFile":{"type":"array","description":"File to upload"}}}}}},"responses":{"204":{"description":"No content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["customers"],"summary":"Deletes the customer's image by customer identifier","description":"Deletes the customer's image by customer identifier","operationId":"Customers_DeleteImage","parameters":[{"name":"id","in":"path","description":"Customer identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/customers/{id}/fee/new":{"get":{"tags":["customers"],"summary":"Get a new fee of a specific customer","description":"Get a new fee of a specific customer","operationId":"Customers_GetNewFee","parameters":[{"name":"id","in":"path","description":"Customer identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeeDTO"},"example":{"id":"string","productId":"string","description":"string","price":0,"discountPercentage":0,"serieId":"string","invoiceType":"string","isIndependentInvoice":true,"taxTypeCode":"string","operationTypeCode":"string","incomeTypeId":"string","taxBase":0,"applyJanuary":true,"applyFebruary":true,"applyMarch":true,"applyApril":true,"applyMay":true,"applyJune":true,"applyJuly":true,"applyAugust":true,"applySeptember":true,"applyOctober":true,"applyNovember":true,"applyDecember":true,"lastEmission":"string","lastEmissionState":0,"nextEmission":"string","tags":[{"id":"string","tagId":"string","description":"string"}],"activityId":"string","lastEmissionIsDraft":true,"isObsolete":true}},"application/xml":{"schema":{"$ref":"#/components/schemas/FeeDTO"},"example":"<FeeDTO> <id>string</id> <productId>string</productId> <description>string</description> <price>0</price> <discountPercentage>0</discountPercentage> <serieId>string</serieId> <invoiceType>string</invoiceType> <isIndependentInvoice>true</isIndependentInvoice> <taxTypeCode>string</taxTypeCode> <operationTypeCode>string</operationTypeCode> <incomeTypeId>string</incomeTypeId> <taxBase>0</taxBase> <applyJanuary>true</applyJanuary> <applyFebruary>true</applyFebruary> <applyMarch>true</applyMarch> <applyApril>true</applyApril> <applyMay>true</applyMay> <applyJune>true</applyJune> <applyJuly>true</applyJuly> <applyAugust>true</applyAugust> <applySeptember>true</applySeptember> <applyOctober>true</applyOctober> <applyNovember>true</applyNovember> <applyDecember>true</applyDecember> <lastEmission>string</lastEmission> <lastEmissionState>0</lastEmissionState> <nextEmission>string</nextEmission> <tags> <id>string</id> <tagId>string</tagId> <description>string</description> </tags> <activityId>string</activityId> <lastEmissionIsDraft>true</lastEmissionIsDraft> <isObsolete>true</isObsolete> </FeeDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/customers/{id}/addresses":{"get":{"tags":["customers"],"summary":"Get the addresses of a customer by identifier","description":"Get the addresses of a customer by identifier","operationId":"Customers_GetAddresses","parameters":[{"name":"id","in":"path","description":"Customer identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddressDTOArray"},"example":[{"street":"string","town":"string","zipCode":"string","provinceCode":"string","provinceName":"string","countryCode":"string","localization":"string","phone":"string","mail":"string","mailCC":"string","carrierId":"00000000-0000-0000-0000-000000000000","types":[0],"correlationId":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/CustomerAddressDTOArray"},"example":"<CustomerAddressDTOArray> <street>string</street> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <localization>string</localization> <phone>string</phone> <mail>string</mail> <mailCC>string</mailCC> <carrierId>00000000-0000-0000-0000-000000000000</carrierId> <types>0</types> <correlationId>string</correlationId> </CustomerAddressDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["customers"],"summary":"Update addresses of a customer","description":"Update addresses of a customer","operationId":"Customers_PutAdresses","parameters":[{"name":"id","in":"path","description":"Customer identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Addresses list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddressDTOArray"},"example":[{"street":"string","town":"string","zipCode":"string","provinceCode":"string","provinceName":"string","countryCode":"string","localization":"string","phone":"string","mail":"string","mailCC":"string","carrierId":"00000000-0000-0000-0000-000000000000","types":[0],"correlationId":"string"}]},"text/json":{"schema":{"$ref":"#/components/schemas/CustomerAddressDTOArray"},"example":[{"street":"string","town":"string","zipCode":"string","provinceCode":"string","provinceName":"string","countryCode":"string","localization":"string","phone":"string","mail":"string","mailCC":"string","carrierId":"00000000-0000-0000-0000-000000000000","types":[0],"correlationId":"string"}]},"text/html":{"schema":{"$ref":"#/components/schemas/CustomerAddressDTOArray"},"example":"<CustomerAddressDTOArray> <street>string</street> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <localization>string</localization> <phone>string</phone> <mail>string</mail> <mailCC>string</mailCC> <carrierId>00000000-0000-0000-0000-000000000000</carrierId> <types>0</types> <correlationId>string</correlationId> </CustomerAddressDTOArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/CustomerAddressDTOArray"},"example":[{"street":"string","town":"string","zipCode":"string","provinceCode":"string","provinceName":"string","countryCode":"string","localization":"string","phone":"string","mail":"string","mailCC":"string","carrierId":"00000000-0000-0000-0000-000000000000","types":[0],"correlationId":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/CustomerAddressDTOArray"},"example":"<CustomerAddressDTOArray> <street>string</street> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <localization>string</localization> <phone>string</phone> <mail>string</mail> <mailCC>string</mailCC> <carrierId>00000000-0000-0000-0000-000000000000</carrierId> <types>0</types> <correlationId>string</correlationId> </CustomerAddressDTOArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/CustomerAddressDTOArray"},"example":"<CustomerAddressDTOArray> <street>string</street> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <localization>string</localization> <phone>string</phone> <mail>string</mail> <mailCC>string</mailCC> <carrierId>00000000-0000-0000-0000-000000000000</carrierId> <types>0</types> <correlationId>string</correlationId> </CustomerAddressDTOArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/customers/{id}/directdebits":{"get":{"tags":["customers"],"summary":"Get the direct debitings of a customer by identifier","description":"Get the direct debitings of a customer by identifier","operationId":"Customers_GetDirectDebits","parameters":[{"name":"id","in":"path","description":"Customer identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectDebitDTOArray"},"example":[{"id":"string","name":"string","account":"string","isNational":true,"bicswift":"string","isDefault":true,"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/DirectDebitDTOArray"},"example":"<DirectDebitDTOArray> <id>string</id> <name>string</name> <account>string</account> <isNational>true</isNational> <bicswift>string</bicswift> <isDefault>true</isDefault> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> </DirectDebitDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["customers"],"summary":"Add a new direct debit","description":"Add a new direct debit","operationId":"Customers_PostDirectDebit","parameters":[{"name":"id","in":"path","description":"Customer id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Direct Debit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectDebitDTO"},"example":{"id":"string","name":"string","account":"string","isNational":true,"bicswift":"string","isDefault":true,"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/DirectDebitDTO"},"example":{"id":"string","name":"string","account":"string","isNational":true,"bicswift":"string","isDefault":true,"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/DirectDebitDTO"},"example":"<DirectDebitDTO> <id>string</id> <name>string</name> <account>string</account> <isNational>true</isNational> <bicswift>string</bicswift> <isDefault>true</isDefault> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> </DirectDebitDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/DirectDebitDTO"},"example":{"id":"string","name":"string","account":"string","isNational":true,"bicswift":"string","isDefault":true,"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DirectDebitDTO"},"example":"<DirectDebitDTO> <id>string</id> <name>string</name> <account>string</account> <isNational>true</isNational> <bicswift>string</bicswift> <isDefault>true</isDefault> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> </DirectDebitDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/DirectDebitDTO"},"example":"<DirectDebitDTO> <id>string</id> <name>string</name> <account>string</account> <isNational>true</isNational> <bicswift>string</bicswift> <isDefault>true</isDefault> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> </DirectDebitDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/customers/{id}/feecollection":{"get":{"tags":["customers"],"summary":"Get the fees of a customer by identifier","description":"Get the fees of a customer by identifier","operationId":"Customers_GetFeesCollection","parameters":[{"name":"id","in":"path","description":"Customer identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeeDTOArray"},"example":[{"id":"string","productId":"string","description":"string","price":0,"discountPercentage":0,"serieId":"string","invoiceType":"string","isIndependentInvoice":true,"taxTypeCode":"string","operationTypeCode":"string","incomeTypeId":"string","taxBase":0,"applyJanuary":true,"applyFebruary":true,"applyMarch":true,"applyApril":true,"applyMay":true,"applyJune":true,"applyJuly":true,"applyAugust":true,"applySeptember":true,"applyOctober":true,"applyNovember":true,"applyDecember":true,"lastEmission":"string","lastEmissionState":0,"nextEmission":"string","tags":[{"id":"string","tagId":"string","description":"string"}],"activityId":"string","lastEmissionIsDraft":true,"isObsolete":true}]},"application/xml":{"schema":{"$ref":"#/components/schemas/FeeDTOArray"},"example":"<FeeDTOArray> <id>string</id> <productId>string</productId> <description>string</description> <price>0</price> <discountPercentage>0</discountPercentage> <serieId>string</serieId> <invoiceType>string</invoiceType> <isIndependentInvoice>true</isIndependentInvoice> <taxTypeCode>string</taxTypeCode> <operationTypeCode>string</operationTypeCode> <incomeTypeId>string</incomeTypeId> <taxBase>0</taxBase> <applyJanuary>true</applyJanuary> <applyFebruary>true</applyFebruary> <applyMarch>true</applyMarch> <applyApril>true</applyApril> <applyMay>true</applyMay> <applyJune>true</applyJune> <applyJuly>true</applyJuly> <applyAugust>true</applyAugust> <applySeptember>true</applySeptember> <applyOctober>true</applyOctober> <applyNovember>true</applyNovember> <applyDecember>true</applyDecember> <lastEmission>string</lastEmission> <lastEmissionState>0</lastEmissionState> <nextEmission>string</nextEmission> <tags> <id>string</id> <tagId>string</tagId> <description>string</description> </tags> <activityId>string</activityId> <lastEmissionIsDraft>true</lastEmissionIsDraft> <isObsolete>true</isObsolete> </FeeDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["customers"],"summary":"Update fee collection","description":"Update fee collection","operationId":"Customers_PutFees","parameters":[{"name":"id","in":"path","description":"Customer identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"fees list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeeDTOArray"},"example":[{"id":"string","productId":"string","description":"string","price":0,"discountPercentage":0,"serieId":"string","invoiceType":"string","isIndependentInvoice":true,"taxTypeCode":"string","operationTypeCode":"string","incomeTypeId":"string","taxBase":0,"applyJanuary":true,"applyFebruary":true,"applyMarch":true,"applyApril":true,"applyMay":true,"applyJune":true,"applyJuly":true,"applyAugust":true,"applySeptember":true,"applyOctober":true,"applyNovember":true,"applyDecember":true,"lastEmission":"string","lastEmissionState":0,"nextEmission":"string","tags":[{"id":"string","tagId":"string","description":"string"}],"activityId":"string","lastEmissionIsDraft":true,"isObsolete":true}]},"text/json":{"schema":{"$ref":"#/components/schemas/FeeDTOArray"},"example":[{"id":"string","productId":"string","description":"string","price":0,"discountPercentage":0,"serieId":"string","invoiceType":"string","isIndependentInvoice":true,"taxTypeCode":"string","operationTypeCode":"string","incomeTypeId":"string","taxBase":0,"applyJanuary":true,"applyFebruary":true,"applyMarch":true,"applyApril":true,"applyMay":true,"applyJune":true,"applyJuly":true,"applyAugust":true,"applySeptember":true,"applyOctober":true,"applyNovember":true,"applyDecember":true,"lastEmission":"string","lastEmissionState":0,"nextEmission":"string","tags":[{"id":"string","tagId":"string","description":"string"}],"activityId":"string","lastEmissionIsDraft":true,"isObsolete":true}]},"text/html":{"schema":{"$ref":"#/components/schemas/FeeDTOArray"},"example":"<FeeDTOArray> <id>string</id> <productId>string</productId> <description>string</description> <price>0</price> <discountPercentage>0</discountPercentage> <serieId>string</serieId> <invoiceType>string</invoiceType> <isIndependentInvoice>true</isIndependentInvoice> <taxTypeCode>string</taxTypeCode> <operationTypeCode>string</operationTypeCode> <incomeTypeId>string</incomeTypeId> <taxBase>0</taxBase> <applyJanuary>true</applyJanuary> <applyFebruary>true</applyFebruary> <applyMarch>true</applyMarch> <applyApril>true</applyApril> <applyMay>true</applyMay> <applyJune>true</applyJune> <applyJuly>true</applyJuly> <applyAugust>true</applyAugust> <applySeptember>true</applySeptember> <applyOctober>true</applyOctober> <applyNovember>true</applyNovember> <applyDecember>true</applyDecember> <lastEmission>string</lastEmission> <lastEmissionState>0</lastEmissionState> <nextEmission>string</nextEmission> <tags> <id>string</id> <tagId>string</tagId> <description>string</description> </tags> <activityId>string</activityId> <lastEmissionIsDraft>true</lastEmissionIsDraft> <isObsolete>true</isObsolete> </FeeDTOArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/FeeDTOArray"},"example":[{"id":"string","productId":"string","description":"string","price":0,"discountPercentage":0,"serieId":"string","invoiceType":"string","isIndependentInvoice":true,"taxTypeCode":"string","operationTypeCode":"string","incomeTypeId":"string","taxBase":0,"applyJanuary":true,"applyFebruary":true,"applyMarch":true,"applyApril":true,"applyMay":true,"applyJune":true,"applyJuly":true,"applyAugust":true,"applySeptember":true,"applyOctober":true,"applyNovember":true,"applyDecember":true,"lastEmission":"string","lastEmissionState":0,"nextEmission":"string","tags":[{"id":"string","tagId":"string","description":"string"}],"activityId":"string","lastEmissionIsDraft":true,"isObsolete":true}]},"application/xml":{"schema":{"$ref":"#/components/schemas/FeeDTOArray"},"example":"<FeeDTOArray> <id>string</id> <productId>string</productId> <description>string</description> <price>0</price> <discountPercentage>0</discountPercentage> <serieId>string</serieId> <invoiceType>string</invoiceType> <isIndependentInvoice>true</isIndependentInvoice> <taxTypeCode>string</taxTypeCode> <operationTypeCode>string</operationTypeCode> <incomeTypeId>string</incomeTypeId> <taxBase>0</taxBase> <applyJanuary>true</applyJanuary> <applyFebruary>true</applyFebruary> <applyMarch>true</applyMarch> <applyApril>true</applyApril> <applyMay>true</applyMay> <applyJune>true</applyJune> <applyJuly>true</applyJuly> <applyAugust>true</applyAugust> <applySeptember>true</applySeptember> <applyOctober>true</applyOctober> <applyNovember>true</applyNovember> <applyDecember>true</applyDecember> <lastEmission>string</lastEmission> <lastEmissionState>0</lastEmissionState> <nextEmission>string</nextEmission> <tags> <id>string</id> <tagId>string</tagId> <description>string</description> </tags> <activityId>string</activityId> <lastEmissionIsDraft>true</lastEmissionIsDraft> <isObsolete>true</isObsolete> </FeeDTOArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/FeeDTOArray"},"example":"<FeeDTOArray> <id>string</id> <productId>string</productId> <description>string</description> <price>0</price> <discountPercentage>0</discountPercentage> <serieId>string</serieId> <invoiceType>string</invoiceType> <isIndependentInvoice>true</isIndependentInvoice> <taxTypeCode>string</taxTypeCode> <operationTypeCode>string</operationTypeCode> <incomeTypeId>string</incomeTypeId> <taxBase>0</taxBase> <applyJanuary>true</applyJanuary> <applyFebruary>true</applyFebruary> <applyMarch>true</applyMarch> <applyApril>true</applyApril> <applyMay>true</applyMay> <applyJune>true</applyJune> <applyJuly>true</applyJuly> <applyAugust>true</applyAugust> <applySeptember>true</applySeptember> <applyOctober>true</applyOctober> <applyNovember>true</applyNovember> <applyDecember>true</applyDecember> <lastEmission>string</lastEmission> <lastEmissionState>0</lastEmissionState> <nextEmission>string</nextEmission> <tags> <id>string</id> <tagId>string</tagId> <description>string</description> </tags> <activityId>string</activityId> <lastEmissionIsDraft>true</lastEmissionIsDraft> <isObsolete>true</isObsolete> </FeeDTOArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/customers/{customerId}/contacts":{"get":{"tags":["customers"],"summary":"Get the contacts by customer identifier","description":"Get the contacts by customer identifier","operationId":"Customers_GetContacts","parameters":[{"name":"customerId","in":"path","description":"Customer identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerContactDTOArray"},"example":[{"id":"string","name":"string","mail":"string","phone":"string","phone2":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/CustomerContactDTOArray"},"example":"<CustomerContactDTOArray> <id>string</id> <name>string</name> <mail>string</mail> <phone>string</phone> <phone2>string</phone2> </CustomerContactDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["customers"],"summary":"Add a new contact by customer identifier","description":"Add a new contact by customer identifier","operationId":"Customers_PostContact","parameters":[{"name":"customerId","in":"path","description":"Customer id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"contact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerContactDTO"},"example":{"id":"string","name":"string","mail":"string","phone":"string","phone2":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/CustomerContactDTO"},"example":{"id":"string","name":"string","mail":"string","phone":"string","phone2":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/CustomerContactDTO"},"example":"<CustomerContactDTO> <id>string</id> <name>string</name> <mail>string</mail> <phone>string</phone> <phone2>string</phone2> </CustomerContactDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/CustomerContactDTO"},"example":{"id":"string","name":"string","mail":"string","phone":"string","phone2":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CustomerContactDTO"},"example":"<CustomerContactDTO> <id>string</id> <name>string</name> <mail>string</mail> <phone>string</phone> <phone2>string</phone2> </CustomerContactDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/CustomerContactDTO"},"example":"<CustomerContactDTO> <id>string</id> <name>string</name> <mail>string</mail> <phone>string</phone> <phone2>string</phone2> </CustomerContactDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/customers/{id}/directdebit/{directDebitId}":{"get":{"tags":["customers"],"summary":"Get a direct debiting by identifier","description":"Get a direct debiting by identifier","operationId":"Customers_GetDirectDebitById","parameters":[{"name":"id","in":"path","description":"Customer identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"directDebitId","in":"path","description":"Direct debiting identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectDebitDTO"},"example":{"id":"string","name":"string","account":"string","isNational":true,"bicswift":"string","isDefault":true,"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DirectDebitDTO"},"example":"<DirectDebitDTO> <id>string</id> <name>string</name> <account>string</account> <isNational>true</isNational> <bicswift>string</bicswift> <isDefault>true</isDefault> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> </DirectDebitDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/customers/{customerId}/contacts/{contactId}":{"get":{"tags":["customers"],"summary":"Get a contact by customer identifier","description":"Get a contact by customer identifier","operationId":"Customers_GetContactById","parameters":[{"name":"customerId","in":"path","description":"Customer identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"contactId","in":"path","description":"contact identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerContactDTO"},"example":{"id":"string","name":"string","mail":"string","phone":"string","phone2":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CustomerContactDTO"},"example":"<CustomerContactDTO> <id>string</id> <name>string</name> <mail>string</mail> <phone>string</phone> <phone2>string</phone2> </CustomerContactDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["customers"],"summary":"Delete a contact by identifier and by customer identifier","description":"Delete a contact by identifier and by customer identifier","operationId":"Customers_DeleteContact","parameters":[{"name":"customerId","in":"path","description":"Customer identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"contactId","in":"path","description":"Contact identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"patch":{"tags":["customers"],"summary":"Update specific properties of a contact by identifier and  customer identifier","description":"Update specific properties of a contact by identifier and  customer identifier","operationId":"Customers_PatchContact","parameters":[{"name":"customerId","in":"path","description":"Customer identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"contactId","in":"path","description":"Contact identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Collection of {a3ERP.Public.Resources.V2.PatchOperation}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/html":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/customers":{"get":{"tags":["customers"],"summary":"Get all customers","description":"Get all customers","operationId":"Customers_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlatCustomerDTOArray"},"example":[{"id":"string","creationDate":"string","vatNumber":"string","vatNumberType":0,"code":"string","name":"string","businessName":"string","web":"string","street":"string","zipCode":"string","town":"string","province":"string","phone":"string","mail":"string","businessStreet":"string","businessZipCode":"string","businessTown":"string","businessProvince":"string","businessPhone":"string","businessMail":"string","accountCode":"string","accountId":"string","source":"string","sourceId":"string","enabled":true,"legacyId":0,"transactionType":0,"sendPdfByEmail":0}]},"application/xml":{"schema":{"$ref":"#/components/schemas/FlatCustomerDTOArray"},"example":"<FlatCustomerDTOArray> <id>string</id> <creationDate>string</creationDate> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <code>string</code> <name>string</name> <businessName>string</businessName> <web>string</web> <street>string</street> <zipCode>string</zipCode> <town>string</town> <province>string</province> <phone>string</phone> <mail>string</mail> <businessStreet>string</businessStreet> <businessZipCode>string</businessZipCode> <businessTown>string</businessTown> <businessProvince>string</businessProvince> <businessPhone>string</businessPhone> <businessMail>string</businessMail> <accountCode>string</accountCode> <accountId>string</accountId> <source>string</source> <sourceId>string</sourceId> <enabled>true</enabled> <legacyId>0</legacyId> <transactionType>0</transactionType> <sendPdfByEmail>0</sendPdfByEmail> </FlatCustomerDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["customers"],"summary":"Add a new customer","description":"Add a new customer","operationId":"Customers_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Customer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDTO"},"example":{"id":"string","creationDate":"string","vatNumber":"string","vatNumberType":0,"code":"string","name":"string","businessName":"string","web":"string","address":{"correlationId":"string","street":"string","town":"string","zipCode":"string","provinceCode":"string","provinceName":"string","countryCode":"string","localization":"string"},"phone":"string","mail":"string","mailCC":"string","isSameAddress":true,"businessAddress":{"correlationId":"string","street":"string","town":"string","zipCode":"string","provinceCode":"string","provinceName":"string","countryCode":"string","localization":"string"},"businessPhone":"string","businessMail":"string","businessMailCC":"string","annotations":"string","rateId":"string","discountId":"00000000-0000-0000-0000-000000000000","discountPercentage":0,"bankId":"string","paymentTypeId":"string","paymentMethodId":"string","paymentDay1":0,"paymentDay2":0,"paymentDay3":0,"operationType":"string","taxType":"string","taxIncluded":true,"applyIRPF":true,"sendPdfByEmail":true,"directDebit":{"id":"string","name":"string","account":"string","isNational":true,"bicswift":"string","isDefault":true,"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string"},"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string","contact":{"id":"string","name":"string","mail":"string","phone":"string","source":"string","sourceId":"string"},"representativeId":"string","representativeName":"string","source":"string","sourceId":"string","saleOfferTemplateId":"string","saleOrderTemplateId":"string","saleDeliveryNoteTemplateId":"string","saleInvoiceTemplateId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"accountCode":"string","accountId":"string","customerFaceData":{"id":"string","accountingOfficeCode":"string","accountingOffice":"string","organManagingCode":"string","organManaging":"string","processingUnitCode":"string","processingUnit":"string","proposingOrganCode":"string","proposingOrgan":"string"},"transactionType":0}},"text/json":{"schema":{"$ref":"#/components/schemas/CustomerDTO"},"example":{"id":"string","creationDate":"string","vatNumber":"string","vatNumberType":0,"code":"string","name":"string","businessName":"string","web":"string","address":{"correlationId":"string","street":"string","town":"string","zipCode":"string","provinceCode":"string","provinceName":"string","countryCode":"string","localization":"string"},"phone":"string","mail":"string","mailCC":"string","isSameAddress":true,"businessAddress":{"correlationId":"string","street":"string","town":"string","zipCode":"string","provinceCode":"string","provinceName":"string","countryCode":"string","localization":"string"},"businessPhone":"string","businessMail":"string","businessMailCC":"string","annotations":"string","rateId":"string","discountId":"00000000-0000-0000-0000-000000000000","discountPercentage":0,"bankId":"string","paymentTypeId":"string","paymentMethodId":"string","paymentDay1":0,"paymentDay2":0,"paymentDay3":0,"operationType":"string","taxType":"string","taxIncluded":true,"applyIRPF":true,"sendPdfByEmail":true,"directDebit":{"id":"string","name":"string","account":"string","isNational":true,"bicswift":"string","isDefault":true,"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string"},"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string","contact":{"id":"string","name":"string","mail":"string","phone":"string","source":"string","sourceId":"string"},"representativeId":"string","representativeName":"string","source":"string","sourceId":"string","saleOfferTemplateId":"string","saleOrderTemplateId":"string","saleDeliveryNoteTemplateId":"string","saleInvoiceTemplateId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"accountCode":"string","accountId":"string","customerFaceData":{"id":"string","accountingOfficeCode":"string","accountingOffice":"string","organManagingCode":"string","organManaging":"string","processingUnitCode":"string","processingUnit":"string","proposingOrganCode":"string","proposingOrgan":"string"},"transactionType":0}},"text/html":{"schema":{"$ref":"#/components/schemas/CustomerDTO"},"example":"<CustomerDTO> <id>string</id> <creationDate>string</creationDate> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <code>string</code> <name>string</name> <businessName>string</businessName> <web>string</web> <address> <correlationId>string</correlationId> <street>string</street> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <localization>string</localization> </address> <phone>string</phone> <mail>string</mail> <mailCC>string</mailCC> <isSameAddress>true</isSameAddress> <businessAddress> <correlationId>string</correlationId> <street>string</street> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <localization>string</localization> </businessAddress> <businessPhone>string</businessPhone> <businessMail>string</businessMail> <businessMailCC>string</businessMailCC> <annotations>string</annotations> <rateId>string</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> <discountPercentage>0</discountPercentage> <bankId>string</bankId> <paymentTypeId>string</paymentTypeId> <paymentMethodId>string</paymentMethodId> <paymentDay1>0</paymentDay1> <paymentDay2>0</paymentDay2> <paymentDay3>0</paymentDay3> <operationType>string</operationType> <taxType>string</taxType> <taxIncluded>true</taxIncluded> <applyIRPF>true</applyIRPF> <sendPdfByEmail>true</sendPdfByEmail> <directDebit> <id>string</id> <name>string</name> <account>string</account> <isNational>true</isNational> <bicswift>string</bicswift> <isDefault>true</isDefault> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> </directDebit> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> <contact> <id>string</id> <name>string</name> <mail>string</mail> <phone>string</phone> <source>string</source> <sourceId>string</sourceId> </contact> <representativeId>string</representativeId> <representativeName>string</representativeName> <source>string</source> <sourceId>string</sourceId> <saleOfferTemplateId>string</saleOfferTemplateId> <saleOrderTemplateId>string</saleOrderTemplateId> <saleDeliveryNoteTemplateId>string</saleDeliveryNoteTemplateId> <saleInvoiceTemplateId>string</saleInvoiceTemplateId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <accountCode>string</accountCode> <accountId>string</accountId> <customerFaceData> <id>string</id> <accountingOfficeCode>string</accountingOfficeCode> <accountingOffice>string</accountingOffice> <organManagingCode>string</organManagingCode> <organManaging>string</organManaging> <processingUnitCode>string</processingUnitCode> <processingUnit>string</processingUnit> <proposingOrganCode>string</proposingOrganCode> <proposingOrgan>string</proposingOrgan> </customerFaceData> <transactionType>0</transactionType> </CustomerDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/CustomerDTO"},"example":{"id":"string","creationDate":"string","vatNumber":"string","vatNumberType":0,"code":"string","name":"string","businessName":"string","web":"string","address":{"correlationId":"string","street":"string","town":"string","zipCode":"string","provinceCode":"string","provinceName":"string","countryCode":"string","localization":"string"},"phone":"string","mail":"string","mailCC":"string","isSameAddress":true,"businessAddress":{"correlationId":"string","street":"string","town":"string","zipCode":"string","provinceCode":"string","provinceName":"string","countryCode":"string","localization":"string"},"businessPhone":"string","businessMail":"string","businessMailCC":"string","annotations":"string","rateId":"string","discountId":"00000000-0000-0000-0000-000000000000","discountPercentage":0,"bankId":"string","paymentTypeId":"string","paymentMethodId":"string","paymentDay1":0,"paymentDay2":0,"paymentDay3":0,"operationType":"string","taxType":"string","taxIncluded":true,"applyIRPF":true,"sendPdfByEmail":true,"directDebit":{"id":"string","name":"string","account":"string","isNational":true,"bicswift":"string","isDefault":true,"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string"},"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string","contact":{"id":"string","name":"string","mail":"string","phone":"string","source":"string","sourceId":"string"},"representativeId":"string","representativeName":"string","source":"string","sourceId":"string","saleOfferTemplateId":"string","saleOrderTemplateId":"string","saleDeliveryNoteTemplateId":"string","saleInvoiceTemplateId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"accountCode":"string","accountId":"string","customerFaceData":{"id":"string","accountingOfficeCode":"string","accountingOffice":"string","organManagingCode":"string","organManaging":"string","processingUnitCode":"string","processingUnit":"string","proposingOrganCode":"string","proposingOrgan":"string"},"transactionType":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/CustomerDTO"},"example":"<CustomerDTO> <id>string</id> <creationDate>string</creationDate> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <code>string</code> <name>string</name> <businessName>string</businessName> <web>string</web> <address> <correlationId>string</correlationId> <street>string</street> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <localization>string</localization> </address> <phone>string</phone> <mail>string</mail> <mailCC>string</mailCC> <isSameAddress>true</isSameAddress> <businessAddress> <correlationId>string</correlationId> <street>string</street> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <localization>string</localization> </businessAddress> <businessPhone>string</businessPhone> <businessMail>string</businessMail> <businessMailCC>string</businessMailCC> <annotations>string</annotations> <rateId>string</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> <discountPercentage>0</discountPercentage> <bankId>string</bankId> <paymentTypeId>string</paymentTypeId> <paymentMethodId>string</paymentMethodId> <paymentDay1>0</paymentDay1> <paymentDay2>0</paymentDay2> <paymentDay3>0</paymentDay3> <operationType>string</operationType> <taxType>string</taxType> <taxIncluded>true</taxIncluded> <applyIRPF>true</applyIRPF> <sendPdfByEmail>true</sendPdfByEmail> <directDebit> <id>string</id> <name>string</name> <account>string</account> <isNational>true</isNational> <bicswift>string</bicswift> <isDefault>true</isDefault> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> </directDebit> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> <contact> <id>string</id> <name>string</name> <mail>string</mail> <phone>string</phone> <source>string</source> <sourceId>string</sourceId> </contact> <representativeId>string</representativeId> <representativeName>string</representativeName> <source>string</source> <sourceId>string</sourceId> <saleOfferTemplateId>string</saleOfferTemplateId> <saleOrderTemplateId>string</saleOrderTemplateId> <saleDeliveryNoteTemplateId>string</saleDeliveryNoteTemplateId> <saleInvoiceTemplateId>string</saleInvoiceTemplateId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <accountCode>string</accountCode> <accountId>string</accountId> <customerFaceData> <id>string</id> <accountingOfficeCode>string</accountingOfficeCode> <accountingOffice>string</accountingOffice> <organManagingCode>string</organManagingCode> <organManaging>string</organManaging> <processingUnitCode>string</processingUnitCode> <processingUnit>string</processingUnit> <proposingOrganCode>string</proposingOrganCode> <proposingOrgan>string</proposingOrgan> </customerFaceData> <transactionType>0</transactionType> </CustomerDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/CustomerDTO"},"example":"<CustomerDTO> <id>string</id> <creationDate>string</creationDate> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <code>string</code> <name>string</name> <businessName>string</businessName> <web>string</web> <address> <correlationId>string</correlationId> <street>string</street> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <localization>string</localization> </address> <phone>string</phone> <mail>string</mail> <mailCC>string</mailCC> <isSameAddress>true</isSameAddress> <businessAddress> <correlationId>string</correlationId> <street>string</street> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <localization>string</localization> </businessAddress> <businessPhone>string</businessPhone> <businessMail>string</businessMail> <businessMailCC>string</businessMailCC> <annotations>string</annotations> <rateId>string</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> <discountPercentage>0</discountPercentage> <bankId>string</bankId> <paymentTypeId>string</paymentTypeId> <paymentMethodId>string</paymentMethodId> <paymentDay1>0</paymentDay1> <paymentDay2>0</paymentDay2> <paymentDay3>0</paymentDay3> <operationType>string</operationType> <taxType>string</taxType> <taxIncluded>true</taxIncluded> <applyIRPF>true</applyIRPF> <sendPdfByEmail>true</sendPdfByEmail> <directDebit> <id>string</id> <name>string</name> <account>string</account> <isNational>true</isNational> <bicswift>string</bicswift> <isDefault>true</isDefault> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> </directDebit> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> <contact> <id>string</id> <name>string</name> <mail>string</mail> <phone>string</phone> <source>string</source> <sourceId>string</sourceId> </contact> <representativeId>string</representativeId> <representativeName>string</representativeName> <source>string</source> <sourceId>string</sourceId> <saleOfferTemplateId>string</saleOfferTemplateId> <saleOrderTemplateId>string</saleOrderTemplateId> <saleDeliveryNoteTemplateId>string</saleDeliveryNoteTemplateId> <saleInvoiceTemplateId>string</saleInvoiceTemplateId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <accountCode>string</accountCode> <accountId>string</accountId> <customerFaceData> <id>string</id> <accountingOfficeCode>string</accountingOfficeCode> <accountingOffice>string</accountingOffice> <organManagingCode>string</organManagingCode> <organManaging>string</organManaging> <processingUnitCode>string</processingUnitCode> <processingUnit>string</processingUnit> <proposingOrganCode>string</proposingOrganCode> <proposingOrgan>string</proposingOrgan> </customerFaceData> <transactionType>0</transactionType> </CustomerDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Created","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/customers/{id}/directdebitsCollection":{"put":{"tags":["customers"],"summary":"Update direct debit collection","description":"Update direct debit collection","operationId":"Customers_PutDirectDebits","parameters":[{"name":"id","in":"path","description":"Customer identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Direct debit list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectDebitDTOArray"},"example":[{"id":"string","name":"string","account":"string","isNational":true,"bicswift":"string","isDefault":true,"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string"}]},"text/json":{"schema":{"$ref":"#/components/schemas/DirectDebitDTOArray"},"example":[{"id":"string","name":"string","account":"string","isNational":true,"bicswift":"string","isDefault":true,"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string"}]},"text/html":{"schema":{"$ref":"#/components/schemas/DirectDebitDTOArray"},"example":"<DirectDebitDTOArray> <id>string</id> <name>string</name> <account>string</account> <isNational>true</isNational> <bicswift>string</bicswift> <isDefault>true</isDefault> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> </DirectDebitDTOArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/DirectDebitDTOArray"},"example":[{"id":"string","name":"string","account":"string","isNational":true,"bicswift":"string","isDefault":true,"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/DirectDebitDTOArray"},"example":"<DirectDebitDTOArray> <id>string</id> <name>string</name> <account>string</account> <isNational>true</isNational> <bicswift>string</bicswift> <isDefault>true</isDefault> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> </DirectDebitDTOArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/DirectDebitDTOArray"},"example":"<DirectDebitDTOArray> <id>string</id> <name>string</name> <account>string</account> <isNational>true</isNational> <bicswift>string</bicswift> <isDefault>true</isDefault> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> </DirectDebitDTOArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/customers/{id}/enable":{"post":{"tags":["customers"],"summary":"Enable customer","description":"Enable customer","operationId":"Customers_EnableCustomer","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/customers/{id}/disable":{"post":{"tags":["customers"],"summary":"Disable customer","description":"Disable customer","operationId":"Customers_DisableCustomer","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/customers/export":{"post":{"tags":["customers"],"summary":"Export all customers","description":"Export all customers","operationId":"Customers_Export","parameters":[{"name":"format","in":"query","description":"Export format","schema":{"enum":["Excel"],"type":"string"}},{"name":"headers","in":"query","description":"Headers","schema":{"type":"string"}},{"name":"title","in":"query","description":"Title","schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiCustomersExportPost200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiCustomersExportPost204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/customers/{id}/addresses/{addressId}":{"patch":{"tags":["customers"],"summary":"Update an address of a customer","description":"Update an address of a customer","operationId":"Customers_PatchAddress","parameters":[{"name":"id","in":"path","description":"Customer identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"addressId","in":"path","description":"Address identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Collection of {a3ERP.Public.Resources.V2.PatchOperation}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/html":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/customers/{id}/directdebits/{directDebitId}":{"delete":{"tags":["customers"],"summary":"Delete a direct debitting by identifier","description":"Delete a direct debitting by identifier","operationId":"Customers_DeleteDirectDebit","parameters":[{"name":"id","in":"path","description":"Customer identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"directDebitId","in":"path","description":"Direct debiting identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"patch":{"tags":["customers"],"summary":"Update specific properties of direct debit","description":"Update specific properties of direct debit","operationId":"Customers_PatchDirectDebit","parameters":[{"name":"id","in":"path","description":"Customer identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"directDebitId","in":"path","description":"Direct debit identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Collection of {a3ERP.Public.Resources.V2.PatchOperation}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/html":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/customschemas":{"get":{"tags":["customschemas"],"summary":"Get all company schemas","description":"Get all company schemas","operationId":"CustomSchemas_Get","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomSchemaDTOArray"},"example":[{"name":"string","description":"string","applicationId":0}]},"application/xml":{"schema":{"$ref":"#/components/schemas/CustomSchemaDTOArray"},"example":"<CustomSchemaDTOArray> <name>string</name> <description>string</description> <applicationId>0</applicationId> </CustomSchemaDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["customschemas"],"summary":"Add a new schema","description":"Add a new schema","operationId":"CustomSchemas_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Schema","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomSchemaCreateDTO"},"example":{"name":"string","description":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/CustomSchemaCreateDTO"},"example":{"name":"string","description":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/CustomSchemaCreateDTO"},"example":"<CustomSchemaCreateDTO> <name>string</name> <description>string</description> </CustomSchemaCreateDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/CustomSchemaCreateDTO"},"example":{"name":"string","description":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CustomSchemaCreateDTO"},"example":"<CustomSchemaCreateDTO> <name>string</name> <description>string</description> </CustomSchemaCreateDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/CustomSchemaCreateDTO"},"example":"<CustomSchemaCreateDTO> <name>string</name> <description>string</description> </CustomSchemaCreateDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/customschemas/{schema}":{"get":{"tags":["customschemas"],"summary":"Get a schema by name","description":"Get a schema by name","operationId":"CustomSchemas_GetByCode","parameters":[{"name":"schema","in":"path","description":"Schema name","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomSchemaDTO"},"example":{"name":"string","description":"string","applicationId":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/CustomSchemaDTO"},"example":"<CustomSchemaDTO> <name>string</name> <description>string</description> <applicationId>0</applicationId> </CustomSchemaDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["customschemas"],"summary":"Update a schema","description":"Update a schema","operationId":"CustomSchemas_Put","parameters":[{"name":"schema","in":"path","description":"Schema name","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Custom schema","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomSchemaUpdateDTO"},"example":{"description":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/CustomSchemaUpdateDTO"},"example":{"description":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/CustomSchemaUpdateDTO"},"example":"<CustomSchemaUpdateDTO> <description>string</description> </CustomSchemaUpdateDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/CustomSchemaUpdateDTO"},"example":{"description":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CustomSchemaUpdateDTO"},"example":"<CustomSchemaUpdateDTO> <description>string</description> </CustomSchemaUpdateDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/CustomSchemaUpdateDTO"},"example":"<CustomSchemaUpdateDTO> <description>string</description> </CustomSchemaUpdateDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/customschemas/{schema}/entities":{"get":{"tags":["customschemas"],"summary":"Get all entities","description":"Get all entities","operationId":"CustomSchemas_GetEntities","parameters":[{"name":"schema","in":"path","description":"Schema name","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityDTOArray"},"example":[{"name":"string","description":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/EntityDTOArray"},"example":"<EntityDTOArray> <name>string</name> <description>string</description> </EntityDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/customschemas/{schema}/entities/{entity}":{"get":{"tags":["customschemas"],"summary":"Get an entity","description":"Get an entity","operationId":"CustomSchemas_GetEntity","parameters":[{"name":"schema","in":"path","description":"Schema name","required":true,"schema":{"type":"string"}},{"name":"entity","in":"path","description":"Entity name","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityDTO"},"example":{"name":"string","description":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EntityDTO"},"example":"<EntityDTO> <name>string</name> <description>string</description> </EntityDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/customschemas/{schema}/entities/{entity}/properties":{"get":{"tags":["customschemas"],"summary":"Get all properties of an entity","description":"Get all properties of an entity","operationId":"CustomSchemas_GetProperties","parameters":[{"name":"schema","in":"path","description":"Schema name","required":true,"schema":{"type":"string"}},{"name":"entity","in":"path","description":"Entity name","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyDTOArray"},"example":[{"propertyName":"string","type":0,"values":"string","defaultValue":"string","isSystem":true,"label":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PropertyDTOArray"},"example":"<PropertyDTOArray> <propertyName>string</propertyName> <type>0</type> <values>string</values> <defaultValue>string</defaultValue> <isSystem>true</isSystem> <label>string</label> </PropertyDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["customschemas"],"summary":"Add a new property","description":"Add a new property","operationId":"CustomSchemas_PostProperty","parameters":[{"name":"schema","in":"path","description":"Schema","required":true,"schema":{"type":"string"}},{"name":"entity","in":"path","description":"Entity","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Property","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyDTO"},"example":{"propertyName":"string","type":0,"values":"string","defaultValue":"string","isSystem":true,"label":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/PropertyDTO"},"example":{"propertyName":"string","type":0,"values":"string","defaultValue":"string","isSystem":true,"label":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/PropertyDTO"},"example":"<PropertyDTO> <propertyName>string</propertyName> <type>0</type> <values>string</values> <defaultValue>string</defaultValue> <isSystem>true</isSystem> <label>string</label> </PropertyDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PropertyDTO"},"example":{"propertyName":"string","type":0,"values":"string","defaultValue":"string","isSystem":true,"label":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PropertyDTO"},"example":"<PropertyDTO> <propertyName>string</propertyName> <type>0</type> <values>string</values> <defaultValue>string</defaultValue> <isSystem>true</isSystem> <label>string</label> </PropertyDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PropertyDTO"},"example":"<PropertyDTO> <propertyName>string</propertyName> <type>0</type> <values>string</values> <defaultValue>string</defaultValue> <isSystem>true</isSystem> <label>string</label> </PropertyDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/customschemas/{schema}/entities/{entity}/properties/{property}":{"get":{"tags":["customschemas"],"summary":"Get a property","description":"Get a property","operationId":"CustomSchemas_GetProperty","parameters":[{"name":"schema","in":"path","description":"Schema name","required":true,"schema":{"type":"string"}},{"name":"entity","in":"path","description":"Entity name","required":true,"schema":{"type":"string"}},{"name":"property","in":"path","description":"Property name","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyDTO"},"example":{"propertyName":"string","type":0,"values":"string","defaultValue":"string","isSystem":true,"label":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PropertyDTO"},"example":"<PropertyDTO> <propertyName>string</propertyName> <type>0</type> <values>string</values> <defaultValue>string</defaultValue> <isSystem>true</isSystem> <label>string</label> </PropertyDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["customschemas"],"summary":"Update a property","description":"Update a property","operationId":"CustomSchemas_PutProperty","parameters":[{"name":"schema","in":"path","description":"Schema","required":true,"schema":{"type":"string"}},{"name":"entity","in":"path","description":"Entity","required":true,"schema":{"type":"string"}},{"name":"property","in":"path","description":"Property","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"propertyUpdateDTO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyUpdateDTO"},"example":{"values":"string","defaultValue":"string","isSystem":true,"label":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/PropertyUpdateDTO"},"example":{"values":"string","defaultValue":"string","isSystem":true,"label":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/PropertyUpdateDTO"},"example":"<PropertyUpdateDTO> <values>string</values> <defaultValue>string</defaultValue> <isSystem>true</isSystem> <label>string</label> </PropertyUpdateDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PropertyUpdateDTO"},"example":{"values":"string","defaultValue":"string","isSystem":true,"label":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PropertyUpdateDTO"},"example":"<PropertyUpdateDTO> <values>string</values> <defaultValue>string</defaultValue> <isSystem>true</isSystem> <label>string</label> </PropertyUpdateDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PropertyUpdateDTO"},"example":"<PropertyUpdateDTO> <values>string</values> <defaultValue>string</defaultValue> <isSystem>true</isSystem> <label>string</label> </PropertyUpdateDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["customschemas"],"summary":"Delete a property by name","description":"Delete a property by name","operationId":"CustomSchemas_DeleteProperty","parameters":[{"name":"schema","in":"path","description":"Schema name","required":true,"schema":{"type":"string"}},{"name":"entity","in":"path","description":"Entity name","required":true,"schema":{"type":"string"}},{"name":"property","in":"path","description":"Property","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/downloadFiles":{"get":{"tags":["downloadFiles"],"summary":"Get report file","description":"Get report file","operationId":"DownloadFiles_DownloadGeneratedFiles","parameters":[{"name":"id","in":"query","description":"Report identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiDownloadFilesGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}},"application/pdf":{"schema":{"$ref":"#/components/schemas/ApiDownloadFilesGet200ApplicationPdfResponse"},"examples":{"default":{"value":""}}},"application/vnd.ms-excel":{"schema":{"$ref":"#/components/schemas/ApiDownloadFilesGet200ApplicationVnd-ms-excelResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"No content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiDownloadFilesGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}},"application/pdf":{"schema":{"$ref":"#/components/schemas/ApiDownloadFilesGet204ApplicationPdfResponse"},"examples":{"default":{"value":""}}},"application/vnd.ms-excel":{"schema":{"$ref":"#/components/schemas/ApiDownloadFilesGet204ApplicationVnd-ms-excelResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{},"application/pdf":{},"application/vnd.ms-excel":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{},"application/pdf":{},"application/vnd.ms-excel":{}}},"404":{"description":"Not found","content":{"application/octet-stream":{},"application/pdf":{},"application/vnd.ms-excel":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{},"application/pdf":{},"application/vnd.ms-excel":{}}}}}},"/downloadinvoice/sale/{idCDA}/{id}":{"get":{"tags":["downloadinvoice"],"summary":"Gets the PDF file of a sale invoice","description":"Gets the PDF file of a sale invoice","operationId":"DownloadInvoice_DownloadSaleInvoicePdf","parameters":[{"name":"idCDA","in":"path","description":"","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"ApiKey","in":"header","description":"Api key","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/DownloadinvoiceSaleIdCDAIdGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}}}}},"/downloadinvoice/purchase/{idCDA}/{id}":{"get":{"tags":["downloadinvoice"],"summary":"Gets the PDF file of a purchase invoice","description":"Gets the PDF file of a purchase invoice","operationId":"DownloadInvoice_DownloadPurchaseInvoicePdf","parameters":[{"name":"idCDA","in":"path","description":"","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"ApiKey","in":"header","description":"Api key","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/DownloadinvoicePurchaseIdCDAIdGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}}}}},"/reports":{"get":{"tags":["downloadreports"],"summary":"Gets the result of a report (PDF)","description":"Gets the result of a report (PDF)","operationId":"DownloadReports_Download","parameters":[{"name":"report","in":"query","description":"Report identifier","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportsGet200ApplicationJsonResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ReportsGet200ApplicationXmlResponse"},"example":"<ReportsGet200ApplicationXmlResponse />"}}}}}},"/api/drafts/{id}":{"get":{"tags":["drafts"],"summary":"Get a draft by identifier","description":"Get a draft by identifier","operationId":"Drafts_GetById","parameters":[{"name":"id","in":"path","description":"Draft identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftDTO"},"example":{"id":"string","date":"string","type":"None","user":"string","processId":"string","status":"Active","draftNumber":0,"content":"string","massiveProcessId":"string","sourceType":"Unknown","documentNumber":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DraftDTO"},"example":"<DraftDTO> <id>string</id> <date>string</date> <type>None</type> <user>string</user> <processId>string</processId> <status>Active</status> <draftNumber>0</draftNumber> <content>string</content> <massiveProcessId>string</massiveProcessId> <sourceType>Unknown</sourceType> <documentNumber>string</documentNumber> </DraftDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["drafts"],"summary":"Delete a draft by identifier","description":"Delete a draft by identifier","operationId":"Drafts_Delete","parameters":[{"name":"id","in":"path","description":"Draft identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/drafts/{id}/pdf":{"get":{"tags":["drafts"],"summary":"Get the pdf of the draft using the invoice template with draft watermark","description":"Get the pdf of the draft using the invoice template with draft watermark","operationId":"Drafts_GetPdf","parameters":[{"name":"id","in":"path","description":"Draft identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"templateId","in":"query","description":"Template identifier","schema":{"type":"integer","format":"int32","default":0}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/Response"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"404":{"description":"Not found","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/drafts/new":{"get":{"tags":["drafts"],"summary":"Get a new draft by type","description":"Get a new draft by type","operationId":"Drafts_GetNew","parameters":[{"name":"type","in":"query","description":"Draft type","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"thirdPartyId","in":"query","description":"ThirdParty Id","schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftDTO"},"example":{"id":"string","date":"string","type":"None","user":"string","processId":"string","status":"Active","draftNumber":0,"content":"string","massiveProcessId":"string","sourceType":"Unknown","documentNumber":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DraftDTO"},"example":"<DraftDTO> <id>string</id> <date>string</date> <type>None</type> <user>string</user> <processId>string</processId> <status>Active</status> <draftNumber>0</draftNumber> <content>string</content> <massiveProcessId>string</massiveProcessId> <sourceType>Unknown</sourceType> <documentNumber>string</documentNumber> </DraftDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/drafts":{"get":{"tags":["drafts"],"summary":"Get drafts by filter","description":"Get drafts by filter","operationId":"Drafts_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftDTOArray"},"example":[{"id":"string","date":"string","type":"None","user":"string","processId":"string","status":"Active","draftNumber":0,"content":"string","massiveProcessId":"string","sourceType":"Unknown","documentNumber":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/DraftDTOArray"},"example":"<DraftDTOArray> <id>string</id> <date>string</date> <type>None</type> <user>string</user> <processId>string</processId> <status>Active</status> <draftNumber>0</draftNumber> <content>string</content> <massiveProcessId>string</massiveProcessId> <sourceType>Unknown</sourceType> <documentNumber>string</documentNumber> </DraftDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["drafts"],"summary":"Update draft","description":"Update draft","operationId":"Drafts_Put","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftDTO"},"example":{"id":"string","date":"string","type":"None","user":"string","processId":"string","status":"Active","draftNumber":0,"content":"string","massiveProcessId":"string","sourceType":"Unknown","documentNumber":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/DraftDTO"},"example":{"id":"string","date":"string","type":"None","user":"string","processId":"string","status":"Active","draftNumber":0,"content":"string","massiveProcessId":"string","sourceType":"Unknown","documentNumber":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/DraftDTO"},"example":"<DraftDTO> <id>string</id> <date>string</date> <type>None</type> <user>string</user> <processId>string</processId> <status>Active</status> <draftNumber>0</draftNumber> <content>string</content> <massiveProcessId>string</massiveProcessId> <sourceType>Unknown</sourceType> <documentNumber>string</documentNumber> </DraftDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/DraftDTO"},"example":{"id":"string","date":"string","type":"None","user":"string","processId":"string","status":"Active","draftNumber":0,"content":"string","massiveProcessId":"string","sourceType":"Unknown","documentNumber":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DraftDTO"},"example":"<DraftDTO> <id>string</id> <date>string</date> <type>None</type> <user>string</user> <processId>string</processId> <status>Active</status> <draftNumber>0</draftNumber> <content>string</content> <massiveProcessId>string</massiveProcessId> <sourceType>Unknown</sourceType> <documentNumber>string</documentNumber> </DraftDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/DraftDTO"},"example":"<DraftDTO> <id>string</id> <date>string</date> <type>None</type> <user>string</user> <processId>string</processId> <status>Active</status> <draftNumber>0</draftNumber> <content>string</content> <massiveProcessId>string</massiveProcessId> <sourceType>Unknown</sourceType> <documentNumber>string</documentNumber> </DraftDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["drafts"],"summary":"Add a new draft","description":"Add a new draft","operationId":"Drafts_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Draft","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftDTO"},"example":{"id":"string","date":"string","type":"None","user":"string","processId":"string","status":"Active","draftNumber":0,"content":"string","massiveProcessId":"string","sourceType":"Unknown","documentNumber":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/DraftDTO"},"example":{"id":"string","date":"string","type":"None","user":"string","processId":"string","status":"Active","draftNumber":0,"content":"string","massiveProcessId":"string","sourceType":"Unknown","documentNumber":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/DraftDTO"},"example":"<DraftDTO> <id>string</id> <date>string</date> <type>None</type> <user>string</user> <processId>string</processId> <status>Active</status> <draftNumber>0</draftNumber> <content>string</content> <massiveProcessId>string</massiveProcessId> <sourceType>Unknown</sourceType> <documentNumber>string</documentNumber> </DraftDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/DraftDTO"},"example":{"id":"string","date":"string","type":"None","user":"string","processId":"string","status":"Active","draftNumber":0,"content":"string","massiveProcessId":"string","sourceType":"Unknown","documentNumber":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DraftDTO"},"example":"<DraftDTO> <id>string</id> <date>string</date> <type>None</type> <user>string</user> <processId>string</processId> <status>Active</status> <draftNumber>0</draftNumber> <content>string</content> <massiveProcessId>string</massiveProcessId> <sourceType>Unknown</sourceType> <documentNumber>string</documentNumber> </DraftDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/DraftDTO"},"example":"<DraftDTO> <id>string</id> <date>string</date> <type>None</type> <user>string</user> <processId>string</processId> <status>Active</status> <draftNumber>0</draftNumber> <content>string</content> <massiveProcessId>string</massiveProcessId> <sourceType>Unknown</sourceType> <documentNumber>string</documentNumber> </DraftDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Created","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/drafts/pdf":{"post":{"tags":["drafts"],"summary":"Print a collection of drafts","description":"Print a collection of drafts","operationId":"Drafts_QueuePdfs","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":{"templateId":"string","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"text/json":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":{"templateId":"string","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"text/html":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":"<PrintCommand> <templateId>string</templateId> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </PrintCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":{"templateId":"string","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":"<PrintCommand> <templateId>string</templateId> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </PrintCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":"<PrintCommand> <templateId>string</templateId> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </PrintCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/drafts/deleteMassive":{"post":{"tags":["drafts"],"summary":"Delete massive drafts","description":"Delete massive drafts","operationId":"Drafts_DeleteMassive","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteDraftsCommand"},"example":{"type":"None","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"text/json":{"schema":{"$ref":"#/components/schemas/DeleteDraftsCommand"},"example":{"type":"None","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"text/html":{"schema":{"$ref":"#/components/schemas/DeleteDraftsCommand"},"example":"<DeleteDraftsCommand> <type>None</type> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </DeleteDraftsCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/DeleteDraftsCommand"},"example":{"type":"None","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/DeleteDraftsCommand"},"example":"<DeleteDraftsCommand> <type>None</type> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </DeleteDraftsCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/DeleteDraftsCommand"},"example":"<DeleteDraftsCommand> <type>None</type> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </DeleteDraftsCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/drafts/billmassiveDraft":{"post":{"tags":["drafts"],"summary":"Bill massive drafts","description":"Bill massive drafts","operationId":"Drafts_BillMassiveDrafts","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillDraftsCommand"},"example":{"invoiceDate":"string","transactionDateBehavior":0,"transactionDate":"string","type":"None","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"text/json":{"schema":{"$ref":"#/components/schemas/BillDraftsCommand"},"example":{"invoiceDate":"string","transactionDateBehavior":0,"transactionDate":"string","type":"None","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"text/html":{"schema":{"$ref":"#/components/schemas/BillDraftsCommand"},"example":"<BillDraftsCommand> <invoiceDate>string</invoiceDate> <transactionDateBehavior>0</transactionDateBehavior> <transactionDate>string</transactionDate> <type>None</type> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </BillDraftsCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/BillDraftsCommand"},"example":{"invoiceDate":"string","transactionDateBehavior":0,"transactionDate":"string","type":"None","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/BillDraftsCommand"},"example":"<BillDraftsCommand> <invoiceDate>string</invoiceDate> <transactionDateBehavior>0</transactionDateBehavior> <transactionDate>string</transactionDate> <type>None</type> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </BillDraftsCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/BillDraftsCommand"},"example":"<BillDraftsCommand> <invoiceDate>string</invoiceDate> <transactionDateBehavior>0</transactionDateBehavior> <transactionDate>string</transactionDate> <type>None</type> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </BillDraftsCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/dues/charges/{id}":{"get":{"tags":["dues"],"summary":"Get a charge by identifier","description":"Get a charge by identifier","operationId":"Char_GetById","parameters":[{"name":"id","in":"path","description":"The serie id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargeDTO"},"example":{"id":"string","date":"string","chargeDate":"string","returnDate":"string","invoiceDate":"string","amount":0,"currency":"string","bankId":"string","payDocumentId":"string","payDocumentDescription":"string","payDocumentRemittable":true,"directDebitId":"string","state":0,"customerName":"string","invoiceNumber":"string","directDebitBankAccount":"string","directDebitDescription":"string","directDebitSwift":"string","directDebitIsNacional":true,"bankDescription":"string","remitted":true,"remittanceNumber":"string","mandateType":"string","mandateReference":"string","bankStatementCorrelationId":"string","customerId":"string","invoiceId":"string","remittanceId":"string","isMigrated":true,"journala3InnuvaId":"string","returnJournala3InnuvaId":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ChargeDTO"},"example":"<ChargeDTO> <id>string</id> <date>string</date> <chargeDate>string</chargeDate> <returnDate>string</returnDate> <invoiceDate>string</invoiceDate> <amount>0</amount> <currency>string</currency> <bankId>string</bankId> <payDocumentId>string</payDocumentId> <payDocumentDescription>string</payDocumentDescription> <payDocumentRemittable>true</payDocumentRemittable> <directDebitId>string</directDebitId> <state>0</state> <customerName>string</customerName> <invoiceNumber>string</invoiceNumber> <directDebitBankAccount>string</directDebitBankAccount> <directDebitDescription>string</directDebitDescription> <directDebitSwift>string</directDebitSwift> <directDebitIsNacional>true</directDebitIsNacional> <bankDescription>string</bankDescription> <remitted>true</remitted> <remittanceNumber>string</remittanceNumber> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <bankStatementCorrelationId>string</bankStatementCorrelationId> <customerId>string</customerId> <invoiceId>string</invoiceId> <remittanceId>string</remittanceId> <isMigrated>true</isMigrated> <journala3InnuvaId>string</journala3InnuvaId> <returnJournala3InnuvaId>string</returnJournala3InnuvaId> </ChargeDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/dues/payments/{id}":{"get":{"tags":["dues"],"summary":"Get a payment by identifier","description":"Get a payment by identifier","operationId":"Paym_GetById","parameters":[{"name":"id","in":"path","description":"The serie id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentDTO"},"example":{"id":"string","date":"string","payDate":"string","invoiceDate":"string","amount":0,"currency":"string","bankId":"string","payDocumentId":"string","payDocumentDescription":"string","directDebitId":"string","state":0,"supplierName":"string","invoiceNumber":"string","supplierInvoiceNumber":"string","directDebitBankAccount":"string","directDebitDescription":"string","directDebitSwift":"string","directDebitIsNacional":true,"bankDescription":"string","supplierId":"string","invoiceId":"string","isInmediatePayment":true,"isMigrated":true,"journala3InnuvaId":"string","returnJournala3InnuvaId":"string","bankStatementCorrelationId":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PaymentDTO"},"example":"<PaymentDTO> <id>string</id> <date>string</date> <payDate>string</payDate> <invoiceDate>string</invoiceDate> <amount>0</amount> <currency>string</currency> <bankId>string</bankId> <payDocumentId>string</payDocumentId> <payDocumentDescription>string</payDocumentDescription> <directDebitId>string</directDebitId> <state>0</state> <supplierName>string</supplierName> <invoiceNumber>string</invoiceNumber> <supplierInvoiceNumber>string</supplierInvoiceNumber> <directDebitBankAccount>string</directDebitBankAccount> <directDebitDescription>string</directDebitDescription> <directDebitSwift>string</directDebitSwift> <directDebitIsNacional>true</directDebitIsNacional> <bankDescription>string</bankDescription> <supplierId>string</supplierId> <invoiceId>string</invoiceId> <isInmediatePayment>true</isInmediatePayment> <isMigrated>true</isMigrated> <journala3InnuvaId>string</journala3InnuvaId> <returnJournala3InnuvaId>string</returnJournala3InnuvaId> <bankStatementCorrelationId>string</bankStatementCorrelationId> </PaymentDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/dues":{"get":{"tags":["dues"],"summary":"Get all dues","description":"Get all dues","operationId":"Dues_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DueDTOArray"},"example":[{"id":"string","date":"string","chargeDate":"string","returnDate":"string","invoiceDate":"string","amount":0,"currency":"string","bankId":"string","payDocumentId":"string","payDocumentDescription":"string","payDocumentRemittable":true,"directDebitId":"string","state":0,"customerName":"string","customerDocument":"string","supplierDocument":"string","invoiceNumber":"string","directDebitBankAccount":"string","directDebitDescription":"string","directDebitSwift":"string","directDebitIsNacional":true,"customerTown":"string","customerCountry":"string","customerMainAddress":"string","customerPostalCode":"string","bankDescription":"string","remitted":true,"remittanceNumber":"string","mandateType":"string","mandateReference":"string","customerId":"string","invoiceId":"string","purchaseInvoiceId":"string","remittanceId":"string","parentDueId":"string","bankStatementCorrelationId":"string","purchaseReference":"string","journala3InnuvaId":"string","returnJournala3InnuvaId":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/DueDTOArray"},"example":"<DueDTOArray> <id>string</id> <date>string</date> <chargeDate>string</chargeDate> <returnDate>string</returnDate> <invoiceDate>string</invoiceDate> <amount>0</amount> <currency>string</currency> <bankId>string</bankId> <payDocumentId>string</payDocumentId> <payDocumentDescription>string</payDocumentDescription> <payDocumentRemittable>true</payDocumentRemittable> <directDebitId>string</directDebitId> <state>0</state> <customerName>string</customerName> <customerDocument>string</customerDocument> <supplierDocument>string</supplierDocument> <invoiceNumber>string</invoiceNumber> <directDebitBankAccount>string</directDebitBankAccount> <directDebitDescription>string</directDebitDescription> <directDebitSwift>string</directDebitSwift> <directDebitIsNacional>true</directDebitIsNacional> <customerTown>string</customerTown> <customerCountry>string</customerCountry> <customerMainAddress>string</customerMainAddress> <customerPostalCode>string</customerPostalCode> <bankDescription>string</bankDescription> <remitted>true</remitted> <remittanceNumber>string</remittanceNumber> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <customerId>string</customerId> <invoiceId>string</invoiceId> <purchaseInvoiceId>string</purchaseInvoiceId> <remittanceId>string</remittanceId> <parentDueId>string</parentDueId> <bankStatementCorrelationId>string</bankStatementCorrelationId> <purchaseReference>string</purchaseReference> <journala3InnuvaId>string</journala3InnuvaId> <returnJournala3InnuvaId>string</returnJournala3InnuvaId> </DueDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/dues/charges":{"get":{"tags":["dues"],"summary":"Get all charges","description":"Get all charges","operationId":"Char_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargeDTOArray"},"example":[{"id":"string","date":"string","chargeDate":"string","returnDate":"string","invoiceDate":"string","amount":0,"currency":"string","bankId":"string","payDocumentId":"string","payDocumentDescription":"string","payDocumentRemittable":true,"directDebitId":"string","state":0,"customerName":"string","invoiceNumber":"string","directDebitBankAccount":"string","directDebitDescription":"string","directDebitSwift":"string","directDebitIsNacional":true,"bankDescription":"string","remitted":true,"remittanceNumber":"string","mandateType":"string","mandateReference":"string","bankStatementCorrelationId":"string","customerId":"string","invoiceId":"string","remittanceId":"string","isMigrated":true,"journala3InnuvaId":"string","returnJournala3InnuvaId":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/ChargeDTOArray"},"example":"<ChargeDTOArray> <id>string</id> <date>string</date> <chargeDate>string</chargeDate> <returnDate>string</returnDate> <invoiceDate>string</invoiceDate> <amount>0</amount> <currency>string</currency> <bankId>string</bankId> <payDocumentId>string</payDocumentId> <payDocumentDescription>string</payDocumentDescription> <payDocumentRemittable>true</payDocumentRemittable> <directDebitId>string</directDebitId> <state>0</state> <customerName>string</customerName> <invoiceNumber>string</invoiceNumber> <directDebitBankAccount>string</directDebitBankAccount> <directDebitDescription>string</directDebitDescription> <directDebitSwift>string</directDebitSwift> <directDebitIsNacional>true</directDebitIsNacional> <bankDescription>string</bankDescription> <remitted>true</remitted> <remittanceNumber>string</remittanceNumber> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <bankStatementCorrelationId>string</bankStatementCorrelationId> <customerId>string</customerId> <invoiceId>string</invoiceId> <remittanceId>string</remittanceId> <isMigrated>true</isMigrated> <journala3InnuvaId>string</journala3InnuvaId> <returnJournala3InnuvaId>string</returnJournala3InnuvaId> </ChargeDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/dues/payments":{"get":{"tags":["dues"],"summary":"Get all payments","description":"Get all payments","operationId":"Paym_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentDTOArray"},"example":[{"id":"string","date":"string","payDate":"string","invoiceDate":"string","amount":0,"currency":"string","bankId":"string","payDocumentId":"string","payDocumentDescription":"string","directDebitId":"string","state":0,"supplierName":"string","invoiceNumber":"string","supplierInvoiceNumber":"string","directDebitBankAccount":"string","directDebitDescription":"string","directDebitSwift":"string","directDebitIsNacional":true,"bankDescription":"string","supplierId":"string","invoiceId":"string","isInmediatePayment":true,"isMigrated":true,"journala3InnuvaId":"string","returnJournala3InnuvaId":"string","bankStatementCorrelationId":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PaymentDTOArray"},"example":"<PaymentDTOArray> <id>string</id> <date>string</date> <payDate>string</payDate> <invoiceDate>string</invoiceDate> <amount>0</amount> <currency>string</currency> <bankId>string</bankId> <payDocumentId>string</payDocumentId> <payDocumentDescription>string</payDocumentDescription> <directDebitId>string</directDebitId> <state>0</state> <supplierName>string</supplierName> <invoiceNumber>string</invoiceNumber> <supplierInvoiceNumber>string</supplierInvoiceNumber> <directDebitBankAccount>string</directDebitBankAccount> <directDebitDescription>string</directDebitDescription> <directDebitSwift>string</directDebitSwift> <directDebitIsNacional>true</directDebitIsNacional> <bankDescription>string</bankDescription> <supplierId>string</supplierId> <invoiceId>string</invoiceId> <isInmediatePayment>true</isInmediatePayment> <isMigrated>true</isMigrated> <journala3InnuvaId>string</journala3InnuvaId> <returnJournala3InnuvaId>string</returnJournala3InnuvaId> <bankStatementCorrelationId>string</bankStatementCorrelationId> </PaymentDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/dues/bank/weighted-charges":{"get":{"tags":["dues"],"summary":"Get all banks payments","description":"Get all banks payments","operationId":"Dues_GetCategorizedByProximityCharges","parameters":[{"name":"amount","in":"query","schema":{"type":"number","format":"double"}},{"name":"statementDate","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"concept","in":"query","schema":{"type":"string"}},{"name":"pageNumber","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankPaymentDtoArray"},"example":[{"id":"string","invoiceId":"string","invoiceNumber":"string","date":"string","dateAsString":"string","effectiveDate":"string","effectiveDateAsString":"string","invoicePersonaDocument":"string","invoicePersonaName":"string","amount":0,"amountAsString":"string","state":0,"source":"string","bankStatementCorrelationId":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/BankPaymentDtoArray"},"example":"<BankPaymentDtoArray> <id>string</id> <invoiceId>string</invoiceId> <invoiceNumber>string</invoiceNumber> <date>string</date> <dateAsString>string</dateAsString> <effectiveDate>string</effectiveDate> <effectiveDateAsString>string</effectiveDateAsString> <invoicePersonaDocument>string</invoicePersonaDocument> <invoicePersonaName>string</invoicePersonaName> <amount>0</amount> <amountAsString>string</amountAsString> <state>0</state> <source>string</source> <bankStatementCorrelationId>string</bankStatementCorrelationId> </BankPaymentDtoArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/dues/bank/weighted-payments":{"get":{"tags":["dues"],"summary":"Get all banks payments","description":"Get all banks payments","operationId":"Dues_GetCategorizedByProximityPayments","parameters":[{"name":"amount","in":"query","schema":{"type":"number","format":"double"}},{"name":"statementDate","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"concept","in":"query","schema":{"type":"string"}},{"name":"pageNumber","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankChargeDtoArray"},"example":[{"id":"string","invoiceId":"string","invoiceNumber":"string","date":"string","effectiveDate":"string","dateAsString":"string","effectiveDateAsString":"string","invoicePersonaDocument":"string","invoicePersonaName":"string","amount":0,"amountAsString":"string","state":0,"source":"string","bankStatementCorrelationId":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/BankChargeDtoArray"},"example":"<BankChargeDtoArray> <id>string</id> <invoiceId>string</invoiceId> <invoiceNumber>string</invoiceNumber> <date>string</date> <effectiveDate>string</effectiveDate> <dateAsString>string</dateAsString> <effectiveDateAsString>string</effectiveDateAsString> <invoicePersonaDocument>string</invoicePersonaDocument> <invoicePersonaName>string</invoicePersonaName> <amount>0</amount> <amountAsString>string</amountAsString> <state>0</state> <source>string</source> <bankStatementCorrelationId>string</bankStatementCorrelationId> </BankChargeDtoArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/dues/bank/charges":{"get":{"tags":["dues"],"summary":"Get all banks charges","description":"Get all banks charges","operationId":"Dues_GetBankCharges","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankChargeDtoArray"},"example":[{"id":"string","invoiceId":"string","invoiceNumber":"string","date":"string","effectiveDate":"string","dateAsString":"string","effectiveDateAsString":"string","invoicePersonaDocument":"string","invoicePersonaName":"string","amount":0,"amountAsString":"string","state":0,"source":"string","bankStatementCorrelationId":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/BankChargeDtoArray"},"example":"<BankChargeDtoArray> <id>string</id> <invoiceId>string</invoiceId> <invoiceNumber>string</invoiceNumber> <date>string</date> <effectiveDate>string</effectiveDate> <dateAsString>string</dateAsString> <effectiveDateAsString>string</effectiveDateAsString> <invoicePersonaDocument>string</invoicePersonaDocument> <invoicePersonaName>string</invoicePersonaName> <amount>0</amount> <amountAsString>string</amountAsString> <state>0</state> <source>string</source> <bankStatementCorrelationId>string</bankStatementCorrelationId> </BankChargeDtoArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/dues/bank/payments":{"get":{"tags":["dues"],"summary":"Get all banks payments","description":"Get all banks payments","operationId":"Dues_GetBankPayments","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankPaymentDtoArray"},"example":[{"id":"string","invoiceId":"string","invoiceNumber":"string","date":"string","dateAsString":"string","effectiveDate":"string","effectiveDateAsString":"string","invoicePersonaDocument":"string","invoicePersonaName":"string","amount":0,"amountAsString":"string","state":0,"source":"string","bankStatementCorrelationId":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/BankPaymentDtoArray"},"example":"<BankPaymentDtoArray> <id>string</id> <invoiceId>string</invoiceId> <invoiceNumber>string</invoiceNumber> <date>string</date> <dateAsString>string</dateAsString> <effectiveDate>string</effectiveDate> <effectiveDateAsString>string</effectiveDateAsString> <invoicePersonaDocument>string</invoicePersonaDocument> <invoicePersonaName>string</invoicePersonaName> <amount>0</amount> <amountAsString>string</amountAsString> <state>0</state> <source>string</source> <bankStatementCorrelationId>string</bankStatementCorrelationId> </BankPaymentDtoArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/dues/charges/export":{"get":{"tags":["dues"],"summary":"Export all dues charges","description":"Export all dues charges","operationId":"Char_Export","parameters":[{"name":"format","in":"query","description":"Export format","schema":{"enum":["Excel"],"type":"string"}},{"name":"headers","in":"query","description":"Headers","schema":{"type":"string"}},{"name":"title","in":"query","description":"Title","schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiDuesChargesExportGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiDuesChargesExportGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/dues/payments/export":{"get":{"tags":["dues"],"summary":"Export all dues payments","description":"Export all dues payments","operationId":"Paym_Export","parameters":[{"name":"format","in":"query","description":"Export format","schema":{"enum":["Excel"],"type":"string"}},{"name":"headers","in":"query","description":"Headers","schema":{"type":"string"}},{"name":"title","in":"query","description":"Title","schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiDuesPaymentsExportGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiDuesPaymentsExportGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/dues/bank/charges/reconcile":{"post":{"tags":["dues"],"summary":"Concile BankStatement charges","description":"Concile BankStatement charges","operationId":"Dues_ReconcileCharges","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReconcileDto"},"example":{"difference":{"amount":0,"accountingAccount":"string"},"validation":{"date":"string","isBankStatementUnmanaged":true},"maturitiesIds":["string"],"bankStatement":{"id":"string","amount":0,"depositDate":"string","bankAccount":"string"}}},"text/json":{"schema":{"$ref":"#/components/schemas/ReconcileDto"},"example":{"difference":{"amount":0,"accountingAccount":"string"},"validation":{"date":"string","isBankStatementUnmanaged":true},"maturitiesIds":["string"],"bankStatement":{"id":"string","amount":0,"depositDate":"string","bankAccount":"string"}}},"text/html":{"schema":{"$ref":"#/components/schemas/ReconcileDto"},"example":"<ReconcileDto> <difference> <amount>0</amount> <accountingAccount>string</accountingAccount> </difference> <validation> <date>string</date> <isBankStatementUnmanaged>true</isBankStatementUnmanaged> </validation> <maturitiesIds>string</maturitiesIds> <bankStatement> <id>string</id> <amount>0</amount> <depositDate>string</depositDate> <bankAccount>string</bankAccount> </bankStatement> </ReconcileDto>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ReconcileDto"},"example":{"difference":{"amount":0,"accountingAccount":"string"},"validation":{"date":"string","isBankStatementUnmanaged":true},"maturitiesIds":["string"],"bankStatement":{"id":"string","amount":0,"depositDate":"string","bankAccount":"string"}}},"application/xml":{"schema":{"$ref":"#/components/schemas/ReconcileDto"},"example":"<ReconcileDto> <difference> <amount>0</amount> <accountingAccount>string</accountingAccount> </difference> <validation> <date>string</date> <isBankStatementUnmanaged>true</isBankStatementUnmanaged> </validation> <maturitiesIds>string</maturitiesIds> <bankStatement> <id>string</id> <amount>0</amount> <depositDate>string</depositDate> <bankAccount>string</bankAccount> </bankStatement> </ReconcileDto>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ReconcileDto"},"example":"<ReconcileDto> <difference> <amount>0</amount> <accountingAccount>string</accountingAccount> </difference> <validation> <date>string</date> <isBankStatementUnmanaged>true</isBankStatementUnmanaged> </validation> <maturitiesIds>string</maturitiesIds> <bankStatement> <id>string</id> <amount>0</amount> <depositDate>string</depositDate> <bankAccount>string</bankAccount> </bankStatement> </ReconcileDto>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/dues/bank/payments/reconcile":{"post":{"tags":["dues"],"summary":"Concile BankStatement payments","description":"Concile BankStatement payments","operationId":"Dues_ReconcilePayments","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReconcileDto"},"example":{"difference":{"amount":0,"accountingAccount":"string"},"validation":{"date":"string","isBankStatementUnmanaged":true},"maturitiesIds":["string"],"bankStatement":{"id":"string","amount":0,"depositDate":"string","bankAccount":"string"}}},"text/json":{"schema":{"$ref":"#/components/schemas/ReconcileDto"},"example":{"difference":{"amount":0,"accountingAccount":"string"},"validation":{"date":"string","isBankStatementUnmanaged":true},"maturitiesIds":["string"],"bankStatement":{"id":"string","amount":0,"depositDate":"string","bankAccount":"string"}}},"text/html":{"schema":{"$ref":"#/components/schemas/ReconcileDto"},"example":"<ReconcileDto> <difference> <amount>0</amount> <accountingAccount>string</accountingAccount> </difference> <validation> <date>string</date> <isBankStatementUnmanaged>true</isBankStatementUnmanaged> </validation> <maturitiesIds>string</maturitiesIds> <bankStatement> <id>string</id> <amount>0</amount> <depositDate>string</depositDate> <bankAccount>string</bankAccount> </bankStatement> </ReconcileDto>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ReconcileDto"},"example":{"difference":{"amount":0,"accountingAccount":"string"},"validation":{"date":"string","isBankStatementUnmanaged":true},"maturitiesIds":["string"],"bankStatement":{"id":"string","amount":0,"depositDate":"string","bankAccount":"string"}}},"application/xml":{"schema":{"$ref":"#/components/schemas/ReconcileDto"},"example":"<ReconcileDto> <difference> <amount>0</amount> <accountingAccount>string</accountingAccount> </difference> <validation> <date>string</date> <isBankStatementUnmanaged>true</isBankStatementUnmanaged> </validation> <maturitiesIds>string</maturitiesIds> <bankStatement> <id>string</id> <amount>0</amount> <depositDate>string</depositDate> <bankAccount>string</bankAccount> </bankStatement> </ReconcileDto>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ReconcileDto"},"example":"<ReconcileDto> <difference> <amount>0</amount> <accountingAccount>string</accountingAccount> </difference> <validation> <date>string</date> <isBankStatementUnmanaged>true</isBankStatementUnmanaged> </validation> <maturitiesIds>string</maturitiesIds> <bankStatement> <id>string</id> <amount>0</amount> <depositDate>string</depositDate> <bankAccount>string</bankAccount> </bankStatement> </ReconcileDto>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/dues/bank/charges/deconciliate":{"post":{"tags":["dues"],"summary":"Deconciliate BankStatement dues for charges","description":"Deconciliate BankStatement dues for charges","operationId":"Dues_DeconciliateCharges","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeconciliateDto"},"example":{"bankStatementCorrelationId":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/DeconciliateDto"},"example":{"bankStatementCorrelationId":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/DeconciliateDto"},"example":"<DeconciliateDto> <bankStatementCorrelationId>string</bankStatementCorrelationId> </DeconciliateDto>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/DeconciliateDto"},"example":{"bankStatementCorrelationId":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DeconciliateDto"},"example":"<DeconciliateDto> <bankStatementCorrelationId>string</bankStatementCorrelationId> </DeconciliateDto>"},"text/xml":{"schema":{"$ref":"#/components/schemas/DeconciliateDto"},"example":"<DeconciliateDto> <bankStatementCorrelationId>string</bankStatementCorrelationId> </DeconciliateDto>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/dues/bank/charges/reconciliate":{"post":{"tags":["dues"],"summary":"Conciliate BankStatement dues","description":"Conciliate BankStatement dues","operationId":"Dues_ReconciliateCharges","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReconciliateDto"},"example":{"bankStatementCorrelationId":"string","duesCorrelationIds":["string"],"totalAmount":0,"totalCommissionAmount":0,"commissionAccountCode":"string","bankCode":"string","depositeDate":"string","date":"string","document":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/ReconciliateDto"},"example":{"bankStatementCorrelationId":"string","duesCorrelationIds":["string"],"totalAmount":0,"totalCommissionAmount":0,"commissionAccountCode":"string","bankCode":"string","depositeDate":"string","date":"string","document":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/ReconciliateDto"},"example":"<ReconciliateDto> <bankStatementCorrelationId>string</bankStatementCorrelationId> <duesCorrelationIds>string</duesCorrelationIds> <totalAmount>0</totalAmount> <totalCommissionAmount>0</totalCommissionAmount> <commissionAccountCode>string</commissionAccountCode> <bankCode>string</bankCode> <depositeDate>string</depositeDate> <date>string</date> <document>string</document> </ReconciliateDto>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ReconciliateDto"},"example":{"bankStatementCorrelationId":"string","duesCorrelationIds":["string"],"totalAmount":0,"totalCommissionAmount":0,"commissionAccountCode":"string","bankCode":"string","depositeDate":"string","date":"string","document":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ReconciliateDto"},"example":"<ReconciliateDto> <bankStatementCorrelationId>string</bankStatementCorrelationId> <duesCorrelationIds>string</duesCorrelationIds> <totalAmount>0</totalAmount> <totalCommissionAmount>0</totalCommissionAmount> <commissionAccountCode>string</commissionAccountCode> <bankCode>string</bankCode> <depositeDate>string</depositeDate> <date>string</date> <document>string</document> </ReconciliateDto>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ReconciliateDto"},"example":"<ReconciliateDto> <bankStatementCorrelationId>string</bankStatementCorrelationId> <duesCorrelationIds>string</duesCorrelationIds> <totalAmount>0</totalAmount> <totalCommissionAmount>0</totalCommissionAmount> <commissionAccountCode>string</commissionAccountCode> <bankCode>string</bankCode> <depositeDate>string</depositeDate> <date>string</date> <document>string</document> </ReconciliateDto>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/dues/bank/payments/deconciliate":{"post":{"tags":["dues"],"summary":"Deconciliate BankStatement dues for payments","description":"Deconciliate BankStatement dues for payments","operationId":"Dues_DeconciliatePayments","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeconciliateDto"},"example":{"bankStatementCorrelationId":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/DeconciliateDto"},"example":{"bankStatementCorrelationId":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/DeconciliateDto"},"example":"<DeconciliateDto> <bankStatementCorrelationId>string</bankStatementCorrelationId> </DeconciliateDto>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/DeconciliateDto"},"example":{"bankStatementCorrelationId":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DeconciliateDto"},"example":"<DeconciliateDto> <bankStatementCorrelationId>string</bankStatementCorrelationId> </DeconciliateDto>"},"text/xml":{"schema":{"$ref":"#/components/schemas/DeconciliateDto"},"example":"<DeconciliateDto> <bankStatementCorrelationId>string</bankStatementCorrelationId> </DeconciliateDto>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/dues/bank/payments/reconciliate":{"post":{"tags":["dues"],"summary":"Conciliate BankStatement dues","description":"Conciliate BankStatement dues","operationId":"Dues_ReconciliatePayments","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReconciliateDto"},"example":{"bankStatementCorrelationId":"string","duesCorrelationIds":["string"],"totalAmount":0,"totalCommissionAmount":0,"commissionAccountCode":"string","bankCode":"string","depositeDate":"string","date":"string","document":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/ReconciliateDto"},"example":{"bankStatementCorrelationId":"string","duesCorrelationIds":["string"],"totalAmount":0,"totalCommissionAmount":0,"commissionAccountCode":"string","bankCode":"string","depositeDate":"string","date":"string","document":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/ReconciliateDto"},"example":"<ReconciliateDto> <bankStatementCorrelationId>string</bankStatementCorrelationId> <duesCorrelationIds>string</duesCorrelationIds> <totalAmount>0</totalAmount> <totalCommissionAmount>0</totalCommissionAmount> <commissionAccountCode>string</commissionAccountCode> <bankCode>string</bankCode> <depositeDate>string</depositeDate> <date>string</date> <document>string</document> </ReconciliateDto>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ReconciliateDto"},"example":{"bankStatementCorrelationId":"string","duesCorrelationIds":["string"],"totalAmount":0,"totalCommissionAmount":0,"commissionAccountCode":"string","bankCode":"string","depositeDate":"string","date":"string","document":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ReconciliateDto"},"example":"<ReconciliateDto> <bankStatementCorrelationId>string</bankStatementCorrelationId> <duesCorrelationIds>string</duesCorrelationIds> <totalAmount>0</totalAmount> <totalCommissionAmount>0</totalCommissionAmount> <commissionAccountCode>string</commissionAccountCode> <bankCode>string</bankCode> <depositeDate>string</depositeDate> <date>string</date> <document>string</document> </ReconciliateDto>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ReconciliateDto"},"example":"<ReconciliateDto> <bankStatementCorrelationId>string</bankStatementCorrelationId> <duesCorrelationIds>string</duesCorrelationIds> <totalAmount>0</totalAmount> <totalCommissionAmount>0</totalCommissionAmount> <commissionAccountCode>string</commissionAccountCode> <bankCode>string</bankCode> <depositeDate>string</depositeDate> <date>string</date> <document>string</document> </ReconciliateDto>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/epigraphs":{"get":{"tags":["epigraphs"],"summary":"Get all TicketBai Epigraph","description":"Get all TicketBai Epigraph","operationId":"Epigraphs_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EpigraphDTOArray"},"example":[{"id":0,"epigraphCode":"string","ticketBaiCode":"string","descriptionES":"string","descriptionEUS":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/EpigraphDTOArray"},"example":"<EpigraphDTOArray> <id>0</id> <epigraphCode>string</epigraphCode> <ticketBaiCode>string</ticketBaiCode> <descriptionES>string</descriptionES> <descriptionEUS>string</descriptionEUS> </EpigraphDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/expenseTypes":{"get":{"tags":["expenseTypes"],"summary":"Get all expense types","description":"Get all expense types","operationId":"ExpenseTypes_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseTypeDTOArray"},"example":[{"id":"string","description":"string","accountsGroupCode":"string","accountCode":"string","accountId":"string","creditAccountCode":"string","creditAccountId":"string","isSystem":true,"legacyId":0}]},"application/xml":{"schema":{"$ref":"#/components/schemas/ExpenseTypeDTOArray"},"example":"<ExpenseTypeDTOArray> <id>string</id> <description>string</description> <accountsGroupCode>string</accountsGroupCode> <accountCode>string</accountCode> <accountId>string</accountId> <creditAccountCode>string</creditAccountCode> <creditAccountId>string</creditAccountId> <isSystem>true</isSystem> <legacyId>0</legacyId> </ExpenseTypeDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["expenseTypes"],"summary":"Add an expense type","description":"Add an expense type","operationId":"ExpenseTypes_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Expense type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseTypeSaveDTO"},"example":{"id":"string","description":"string","accountsGroupCode":"string","accountId":"string","creditAccountId":"string","typeSaveMode":"ByLicense"}},"text/json":{"schema":{"$ref":"#/components/schemas/ExpenseTypeSaveDTO"},"example":{"id":"string","description":"string","accountsGroupCode":"string","accountId":"string","creditAccountId":"string","typeSaveMode":"ByLicense"}},"text/html":{"schema":{"$ref":"#/components/schemas/ExpenseTypeSaveDTO"},"example":"<ExpenseTypeSaveDTO> <id>string</id> <description>string</description> <accountsGroupCode>string</accountsGroupCode> <accountId>string</accountId> <creditAccountId>string</creditAccountId> <typeSaveMode>ByLicense</typeSaveMode> </ExpenseTypeSaveDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ExpenseTypeSaveDTO"},"example":{"id":"string","description":"string","accountsGroupCode":"string","accountId":"string","creditAccountId":"string","typeSaveMode":"ByLicense"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ExpenseTypeSaveDTO"},"example":"<ExpenseTypeSaveDTO> <id>string</id> <description>string</description> <accountsGroupCode>string</accountsGroupCode> <accountId>string</accountId> <creditAccountId>string</creditAccountId> <typeSaveMode>ByLicense</typeSaveMode> </ExpenseTypeSaveDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ExpenseTypeSaveDTO"},"example":"<ExpenseTypeSaveDTO> <id>string</id> <description>string</description> <accountsGroupCode>string</accountsGroupCode> <accountId>string</accountId> <creditAccountId>string</creditAccountId> <typeSaveMode>ByLicense</typeSaveMode> </ExpenseTypeSaveDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Created","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/expenseTypes/{id}":{"delete":{"tags":["expenseTypes"],"summary":"Delete an expense type by identifier","description":"Delete an expense type by identifier","operationId":"ExpenseTypes_Delete","parameters":[{"name":"id","in":"path","description":"Expense type identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"patch":{"tags":["expenseTypes"],"summary":"Update specific properties of expense type","description":"Update specific properties of expense type","operationId":"ExpenseTypes_Patch","parameters":[{"name":"id","in":"path","description":"Expense type identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Collection of {a3ERP.Public.Resources.V2.PatchOperation}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/html":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/export/json":{"post":{"tags":["export"],"summary":"Export JSON","description":"Export JSON","operationId":"Export_ExportJSON","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"ExportJSONCommand","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportJSONCommand"},"example":{"vatNumber":"string","accountCodeLength":0,"accountingPeriodStart":"string","year":0,"startMonth":0,"endMonth":0,"activity":"00000000-0000-0000-0000-000000000000","cashManagementLocation":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/ExportJSONCommand"},"example":{"vatNumber":"string","accountCodeLength":0,"accountingPeriodStart":"string","year":0,"startMonth":0,"endMonth":0,"activity":"00000000-0000-0000-0000-000000000000","cashManagementLocation":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/ExportJSONCommand"},"example":"<ExportJSONCommand> <vatNumber>string</vatNumber> <accountCodeLength>0</accountCodeLength> <accountingPeriodStart>string</accountingPeriodStart> <year>0</year> <startMonth>0</startMonth> <endMonth>0</endMonth> <activity>00000000-0000-0000-0000-000000000000</activity> <cashManagementLocation>string</cashManagementLocation> </ExportJSONCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ExportJSONCommand"},"example":{"vatNumber":"string","accountCodeLength":0,"accountingPeriodStart":"string","year":0,"startMonth":0,"endMonth":0,"activity":"00000000-0000-0000-0000-000000000000","cashManagementLocation":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ExportJSONCommand"},"example":"<ExportJSONCommand> <vatNumber>string</vatNumber> <accountCodeLength>0</accountCodeLength> <accountingPeriodStart>string</accountingPeriodStart> <year>0</year> <startMonth>0</startMonth> <endMonth>0</endMonth> <activity>00000000-0000-0000-0000-000000000000</activity> <cashManagementLocation>string</cashManagementLocation> </ExportJSONCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ExportJSONCommand"},"example":"<ExportJSONCommand> <vatNumber>string</vatNumber> <accountCodeLength>0</accountCodeLength> <accountingPeriodStart>string</accountingPeriodStart> <year>0</year> <startMonth>0</startMonth> <endMonth>0</endMonth> <activity>00000000-0000-0000-0000-000000000000</activity> <cashManagementLocation>string</cashManagementLocation> </ExportJSONCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/export/suenlace":{"post":{"tags":["export"],"summary":"Export SuEnlace","description":"Export SuEnlace","operationId":"Export_ExportSuEnlace","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"ExportSuEnlaceCommand","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportSuEnlaceCommand"},"example":{"companyECOCode":"string","startYear":0,"startMonth":0,"endYear":0,"endMonth":0,"activityId":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/ExportSuEnlaceCommand"},"example":{"companyECOCode":"string","startYear":0,"startMonth":0,"endYear":0,"endMonth":0,"activityId":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/ExportSuEnlaceCommand"},"example":"<ExportSuEnlaceCommand> <companyECOCode>string</companyECOCode> <startYear>0</startYear> <startMonth>0</startMonth> <endYear>0</endYear> <endMonth>0</endMonth> <activityId>string</activityId> </ExportSuEnlaceCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ExportSuEnlaceCommand"},"example":{"companyECOCode":"string","startYear":0,"startMonth":0,"endYear":0,"endMonth":0,"activityId":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ExportSuEnlaceCommand"},"example":"<ExportSuEnlaceCommand> <companyECOCode>string</companyECOCode> <startYear>0</startYear> <startMonth>0</startMonth> <endYear>0</endYear> <endMonth>0</endMonth> <activityId>string</activityId> </ExportSuEnlaceCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ExportSuEnlaceCommand"},"example":"<ExportSuEnlaceCommand> <companyECOCode>string</companyECOCode> <startYear>0</startYear> <startMonth>0</startMonth> <endYear>0</endYear> <endMonth>0</endMonth> <activityId>string</activityId> </ExportSuEnlaceCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/export/templateWithData/{entity}":{"post":{"tags":["export"],"summary":"Export template with data","description":"Export template with data","operationId":"Export_ExportTemplateWithData","parameters":[{"name":"entity","in":"path","description":"product, customer, supplier or fee","required":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/export/templateWithErrorData/{entity}":{"post":{"tags":["export"],"summary":"Export template with error data","description":"Export template with error data","operationId":"Export_ExportTemplateWithErrorData","parameters":[{"name":"entity","in":"path","description":"customer or supplier","required":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/facturae/generate":{"post":{"tags":["facturae"],"summary":"Generate facturae","description":"Generate facturae","operationId":"Facturae_Generate","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Invoice correlationId","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceCorrelationId"},"example":"00000000-0000-0000-0000-000000000000"},"text/json":{"schema":{"$ref":"#/components/schemas/InvoiceCorrelationId"},"example":"00000000-0000-0000-0000-000000000000"},"text/html":{"schema":{"$ref":"#/components/schemas/InvoiceCorrelationId"},"example":"00000000-0000-0000-0000-000000000000"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/InvoiceCorrelationId"},"example":"00000000-0000-0000-0000-000000000000"},"application/xml":{"schema":{"$ref":"#/components/schemas/InvoiceCorrelationId"},"example":"00000000-0000-0000-0000-000000000000"},"text/xml":{"schema":{"$ref":"#/components/schemas/InvoiceCorrelationId"},"example":"00000000-0000-0000-0000-000000000000"},"application/x-www-form-urlencoded":{}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/feedback":{"post":{"tags":["feedback"],"summary":"Create a new feedback","description":"Create a new feedback","operationId":"Feedback_PostFeedback","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"{a3ERP.Public.Resources.V2.DTO.Entities.FeedbackResource}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedbackResource"},"example":{"window":"string","windowTitle":"string","comment":"string","isPositive":true,"feedbackType":"string","ratio":0,"image":[]}},"text/json":{"schema":{"$ref":"#/components/schemas/FeedbackResource"},"example":{"window":"string","windowTitle":"string","comment":"string","isPositive":true,"feedbackType":"string","ratio":0,"image":[]}},"text/html":{"schema":{"$ref":"#/components/schemas/FeedbackResource"},"example":"<FeedbackResource> <window>string</window> <windowTitle>string</windowTitle> <comment>string</comment> <isPositive>true</isPositive> <feedbackType>string</feedbackType> <ratio>0</ratio> <image /> </FeedbackResource>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/FeedbackResource"},"example":{"window":"string","windowTitle":"string","comment":"string","isPositive":true,"feedbackType":"string","ratio":0,"image":[]}},"application/xml":{"schema":{"$ref":"#/components/schemas/FeedbackResource"},"example":"<FeedbackResource> <window>string</window> <windowTitle>string</windowTitle> <comment>string</comment> <isPositive>true</isPositive> <feedbackType>string</feedbackType> <ratio>0</ratio> <image /> </FeedbackResource>"},"text/xml":{"schema":{"$ref":"#/components/schemas/FeedbackResource"},"example":"<FeedbackResource> <window>string</window> <windowTitle>string</windowTitle> <comment>string</comment> <isPositive>true</isPositive> <feedbackType>string</feedbackType> <ratio>0</ratio> <image /> </FeedbackResource>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}}}}},"/api/fees/log/{id}":{"get":{"tags":["fees"],"summary":"Fees_GetFeePeriodLog","operationId":"Fees_GetFeePeriodLog","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeePeriodLogDTO"},"example":{"period":0,"year":0,"tags":[{"id":"string","tagId":"string","description":"string"}],"draftId":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/FeePeriodLogDTO"},"example":"<FeePeriodLogDTO> <period>0</period> <year>0</year> <tags> <id>string</id> <tagId>string</tagId> <description>string</description> </tags> <draftId>0</draftId> </FeePeriodLogDTO>"}}}}}},"/api/fees/{year}/{month}":{"get":{"tags":["fees"],"summary":"Get the fees of a specific time period {Year}/{Month}","description":"Get the fees of a specific time period {Year}/{Month}","operationId":"Fees_GetPeriodFees","parameters":[{"name":"year","in":"path","description":"Year","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"month","in":"path","description":"Month","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"tags","in":"query","description":"Tags description to filter","schema":{"type":"string"}},{"name":"activityId","in":"query","description":"Activity Id","schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeriodFeeDTOArray"},"example":[{"customerName":"string","feeTags":["string"],"id":"string","productId":"string","description":"string","price":0,"discountPercentage":0,"serieId":"string","invoiceType":"string","isIndependentInvoice":true,"taxTypeCode":"string","operationTypeCode":"string","incomeTypeId":"string","taxBase":0,"applyJanuary":true,"applyFebruary":true,"applyMarch":true,"applyApril":true,"applyMay":true,"applyJune":true,"applyJuly":true,"applyAugust":true,"applySeptember":true,"applyOctober":true,"applyNovember":true,"applyDecember":true,"lastEmission":"string","lastEmissionState":0,"nextEmission":"string","tags":[{"id":"string","tagId":"string","description":"string"}],"activityId":"string","lastEmissionIsDraft":true,"isObsolete":true}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PeriodFeeDTOArray"},"example":"<PeriodFeeDTOArray> <customerName>string</customerName> <feeTags>string</feeTags> <id>string</id> <productId>string</productId> <description>string</description> <price>0</price> <discountPercentage>0</discountPercentage> <serieId>string</serieId> <invoiceType>string</invoiceType> <isIndependentInvoice>true</isIndependentInvoice> <taxTypeCode>string</taxTypeCode> <operationTypeCode>string</operationTypeCode> <incomeTypeId>string</incomeTypeId> <taxBase>0</taxBase> <applyJanuary>true</applyJanuary> <applyFebruary>true</applyFebruary> <applyMarch>true</applyMarch> <applyApril>true</applyApril> <applyMay>true</applyMay> <applyJune>true</applyJune> <applyJuly>true</applyJuly> <applyAugust>true</applyAugust> <applySeptember>true</applySeptember> <applyOctober>true</applyOctober> <applyNovember>true</applyNovember> <applyDecember>true</applyDecember> <lastEmission>string</lastEmission> <lastEmissionState>0</lastEmissionState> <nextEmission>string</nextEmission> <tags> <id>string</id> <tagId>string</tagId> <description>string</description> </tags> <activityId>string</activityId> <lastEmissionIsDraft>true</lastEmissionIsDraft> <isObsolete>true</isObsolete> </PeriodFeeDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/fees/bill":{"post":{"tags":["fees"],"summary":"Bill fees","description":"Bill fees","operationId":"Fees_BillFees","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"BillFeesCommand","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillFeesCommand"},"example":{"feesId":["string"],"date":"string","operationDate":"string","generationYear":0,"generationPeriod":0}},"text/json":{"schema":{"$ref":"#/components/schemas/BillFeesCommand"},"example":{"feesId":["string"],"date":"string","operationDate":"string","generationYear":0,"generationPeriod":0}},"text/html":{"schema":{"$ref":"#/components/schemas/BillFeesCommand"},"example":"<BillFeesCommand> <feesId>string</feesId> <date>string</date> <operationDate>string</operationDate> <generationYear>0</generationYear> <generationPeriod>0</generationPeriod> </BillFeesCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/BillFeesCommand"},"example":{"feesId":["string"],"date":"string","operationDate":"string","generationYear":0,"generationPeriod":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/BillFeesCommand"},"example":"<BillFeesCommand> <feesId>string</feesId> <date>string</date> <operationDate>string</operationDate> <generationYear>0</generationYear> <generationPeriod>0</generationPeriod> </BillFeesCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/BillFeesCommand"},"example":"<BillFeesCommand> <feesId>string</feesId> <date>string</date> <operationDate>string</operationDate> <generationYear>0</generationYear> <generationPeriod>0</generationPeriod> </BillFeesCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/fees/feesBillToDraft":{"post":{"tags":["fees"],"summary":"Bill fees","description":"Bill fees","operationId":"Fees_FeesBillToDraft","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"BillFeesCommand","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillFeesCommand"},"example":{"feesId":["string"],"date":"string","operationDate":"string","generationYear":0,"generationPeriod":0}},"text/json":{"schema":{"$ref":"#/components/schemas/BillFeesCommand"},"example":{"feesId":["string"],"date":"string","operationDate":"string","generationYear":0,"generationPeriod":0}},"text/html":{"schema":{"$ref":"#/components/schemas/BillFeesCommand"},"example":"<BillFeesCommand> <feesId>string</feesId> <date>string</date> <operationDate>string</operationDate> <generationYear>0</generationYear> <generationPeriod>0</generationPeriod> </BillFeesCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/BillFeesCommand"},"example":{"feesId":["string"],"date":"string","operationDate":"string","generationYear":0,"generationPeriod":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/BillFeesCommand"},"example":"<BillFeesCommand> <feesId>string</feesId> <date>string</date> <operationDate>string</operationDate> <generationYear>0</generationYear> <generationPeriod>0</generationPeriod> </BillFeesCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/BillFeesCommand"},"example":"<BillFeesCommand> <feesId>string</feesId> <date>string</date> <operationDate>string</operationDate> <generationYear>0</generationYear> <generationPeriod>0</generationPeriod> </BillFeesCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/iban/swift":{"get":{"tags":["iban"],"summary":"Get a swift by iban","description":"Get a swift by iban","operationId":"IBAN_GetSWIFTByIBAN","parameters":[{"name":"iban","in":"query","description":"iban","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiIbanSwiftGet200ApplicationJsonResponse"},"example":"string"},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiIbanSwiftGet200ApplicationXmlResponse"},"example":"<ApiIbanSwiftGet200ApplicationXmlResponse>string</ApiIbanSwiftGet200ApplicationXmlResponse>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/import/downloadTemplate/{entity}":{"get":{"tags":["import"],"summary":"Download the template to import an entity","description":"Download the template to import an entity","operationId":"Import_DownloadTemplate","parameters":[{"name":"entity","in":"path","description":"product, customer or supplier","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiImportDownloadTemplateEntityGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiImportDownloadTemplateEntityGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"404":{"description":"Not found","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/import/suenlace":{"post":{"tags":["import"],"summary":"Import Suenlace","description":"Import Suenlace","operationId":"Import_ImportSuenlace","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["uploadedFile"],"properties":{"uploadedFile":{"type":"array","description":"File to upload"}}}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/import":{"post":{"tags":["import"],"summary":"Import of entities","description":"Import of entities","operationId":"Import_ImportData","parameters":[{"name":"entity","in":"query","description":"product, customer, supplier, fee, productprices or salerates","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["uploadedFile"],"properties":{"uploadedFile":{"type":"array","description":"File to upload"}}}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/import/template":{"post":{"tags":["import"],"summary":"Generate the template for updates","description":"Generate the template for updates","operationId":"Import_Template","parameters":[{"name":"entity","in":"query","description":"productprices or salerates","required":true,"schema":{"type":"string"}},{"name":"idSaleRate","in":"query","description":"","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/incomeTypes":{"get":{"tags":["incomeTypes"],"summary":"Get all income types","description":"Get all income types","operationId":"IncomeTypes_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncomeTypeDTOArray"},"example":[{"id":"string","description":"string","accountsGroupCode":"string","accountCode":"string","accountId":"string","creditAccountCode":"string","creditAccountId":"string","isSystem":true,"legacyId":0}]},"application/xml":{"schema":{"$ref":"#/components/schemas/IncomeTypeDTOArray"},"example":"<IncomeTypeDTOArray> <id>string</id> <description>string</description> <accountsGroupCode>string</accountsGroupCode> <accountCode>string</accountCode> <accountId>string</accountId> <creditAccountCode>string</creditAccountCode> <creditAccountId>string</creditAccountId> <isSystem>true</isSystem> <legacyId>0</legacyId> </IncomeTypeDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["incomeTypes"],"summary":"Add an income type","description":"Add an income type","operationId":"IncomeTypes_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Income type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncomeTypeSaveDTO"},"example":{"id":"string","description":"string","accountsGroupCode":"string","accountId":"string","creditAccountId":"string","typeSaveMode":"ByLicense"}},"text/json":{"schema":{"$ref":"#/components/schemas/IncomeTypeSaveDTO"},"example":{"id":"string","description":"string","accountsGroupCode":"string","accountId":"string","creditAccountId":"string","typeSaveMode":"ByLicense"}},"text/html":{"schema":{"$ref":"#/components/schemas/IncomeTypeSaveDTO"},"example":"<IncomeTypeSaveDTO> <id>string</id> <description>string</description> <accountsGroupCode>string</accountsGroupCode> <accountId>string</accountId> <creditAccountId>string</creditAccountId> <typeSaveMode>ByLicense</typeSaveMode> </IncomeTypeSaveDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/IncomeTypeSaveDTO"},"example":{"id":"string","description":"string","accountsGroupCode":"string","accountId":"string","creditAccountId":"string","typeSaveMode":"ByLicense"}},"application/xml":{"schema":{"$ref":"#/components/schemas/IncomeTypeSaveDTO"},"example":"<IncomeTypeSaveDTO> <id>string</id> <description>string</description> <accountsGroupCode>string</accountsGroupCode> <accountId>string</accountId> <creditAccountId>string</creditAccountId> <typeSaveMode>ByLicense</typeSaveMode> </IncomeTypeSaveDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/IncomeTypeSaveDTO"},"example":"<IncomeTypeSaveDTO> <id>string</id> <description>string</description> <accountsGroupCode>string</accountsGroupCode> <accountId>string</accountId> <creditAccountId>string</creditAccountId> <typeSaveMode>ByLicense</typeSaveMode> </IncomeTypeSaveDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Created","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/incomeTypes/{id}":{"delete":{"tags":["incomeTypes"],"summary":"Delete an income type by identifier","description":"Delete an income type by identifier","operationId":"IncomeTypes_Delete","parameters":[{"name":"id","in":"path","description":"Income type identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"patch":{"tags":["incomeTypes"],"summary":"Update specific properties of income type","description":"Update specific properties of income type","operationId":"IncomeTypes_Patch","parameters":[{"name":"id","in":"path","description":"Income type identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Collection of {a3ERP.Public.Resources.V2.PatchOperation}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/html":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/inventories/{id}":{"get":{"tags":["inventories"],"summary":"Get an inventory","description":"Get an inventory","operationId":"Inventories_GetById","parameters":[{"name":"id","in":"path","description":"Inventory correlationId","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryDtoWithWarehouse"},"example":{"warehouseCode":"string","warehouseDescription":"string","isEditable":true,"id":"string","date":"string","reason":"string","warehouseCorrelationId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/InventoryDtoWithWarehouse"},"example":"<InventoryDtoWithWarehouse> <warehouseCode>string</warehouseCode> <warehouseDescription>string</warehouseDescription> <isEditable>true</isEditable> <id>string</id> <date>string</date> <reason>string</reason> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> </InventoryDtoWithWarehouse>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["inventories"],"summary":"Delete an inventory by identifier","description":"Delete an inventory by identifier","operationId":"Inventories_Delete","parameters":[{"name":"id","in":"path","description":"Inventory identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"patch":{"tags":["inventories"],"summary":"Update specific properties of inventory","description":"Update specific properties of inventory","operationId":"Inventories_Patch","parameters":[{"name":"id","in":"path","description":"Inventory correlationId","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Collection of {a3ERP.Public.Resources.V2.PatchOperation}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/html":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/inventories":{"get":{"tags":["inventories"],"summary":"Get all inventory","description":"Get all inventory","operationId":"Inventories_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryDTOArray"},"example":[{"id":"string","date":"string","reason":"string","warehouseCorrelationId":"00000000-0000-0000-0000-000000000000"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/InventoryDTOArray"},"example":"<InventoryDTOArray> <id>string</id> <date>string</date> <reason>string</reason> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> </InventoryDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["inventories"],"summary":"Calculate a new inventory","description":"Calculate a new inventory","operationId":"Inventories_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Inventory","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryDTO"},"example":{"id":"string","date":"string","reason":"string","warehouseCorrelationId":"00000000-0000-0000-0000-000000000000"}},"text/json":{"schema":{"$ref":"#/components/schemas/InventoryDTO"},"example":{"id":"string","date":"string","reason":"string","warehouseCorrelationId":"00000000-0000-0000-0000-000000000000"}},"text/html":{"schema":{"$ref":"#/components/schemas/InventoryDTO"},"example":"<InventoryDTO> <id>string</id> <date>string</date> <reason>string</reason> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> </InventoryDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/InventoryDTO"},"example":{"id":"string","date":"string","reason":"string","warehouseCorrelationId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/InventoryDTO"},"example":"<InventoryDTO> <id>string</id> <date>string</date> <reason>string</reason> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> </InventoryDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/InventoryDTO"},"example":"<InventoryDTO> <id>string</id> <date>string</date> <reason>string</reason> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> </InventoryDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/inventories/{inventoryCorrelationId}/lines":{"get":{"tags":["inventories"],"summary":"Get inventory lines","description":"Get inventory lines","operationId":"Inventories_GetLines","parameters":[{"name":"inventoryCorrelationId","in":"path","description":"Inventory correlationId","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryLineDtoArray"},"example":[{"correlationId":"00000000-0000-0000-0000-000000000000","productId":0,"productCorrelationId":"00000000-0000-0000-0000-000000000000","productCode":"string","productDescription":"string","stockUnits":0,"stockUnitsCalculated":0,"traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}]}]},"application/xml":{"schema":{"$ref":"#/components/schemas/InventoryLineDtoArray"},"example":"<InventoryLineDtoArray> <correlationId>00000000-0000-0000-0000-000000000000</correlationId> <productId>0</productId> <productCorrelationId>00000000-0000-0000-0000-000000000000</productCorrelationId> <productCode>string</productCode> <productDescription>string</productDescription> <stockUnits>0</stockUnits> <stockUnitsCalculated>0</stockUnitsCalculated> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> </InventoryLineDtoArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["inventories"],"summary":"Create a new inventory line","description":"Create a new inventory line","operationId":"InventoryLi_Post","parameters":[{"name":"inventoryCorrelationId","in":"path","description":"Inventory CorrealtionId","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"InventoryLineDto","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryLineDto"},"example":{"correlationId":"00000000-0000-0000-0000-000000000000","productId":0,"productCorrelationId":"00000000-0000-0000-0000-000000000000","productCode":"string","productDescription":"string","stockUnits":0,"stockUnitsCalculated":0,"traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}]}},"text/json":{"schema":{"$ref":"#/components/schemas/InventoryLineDto"},"example":{"correlationId":"00000000-0000-0000-0000-000000000000","productId":0,"productCorrelationId":"00000000-0000-0000-0000-000000000000","productCode":"string","productDescription":"string","stockUnits":0,"stockUnitsCalculated":0,"traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}]}},"text/html":{"schema":{"$ref":"#/components/schemas/InventoryLineDto"},"example":"<InventoryLineDto> <correlationId>00000000-0000-0000-0000-000000000000</correlationId> <productId>0</productId> <productCorrelationId>00000000-0000-0000-0000-000000000000</productCorrelationId> <productCode>string</productCode> <productDescription>string</productDescription> <stockUnits>0</stockUnits> <stockUnitsCalculated>0</stockUnitsCalculated> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> </InventoryLineDto>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/InventoryLineDto"},"example":{"correlationId":"00000000-0000-0000-0000-000000000000","productId":0,"productCorrelationId":"00000000-0000-0000-0000-000000000000","productCode":"string","productDescription":"string","stockUnits":0,"stockUnitsCalculated":0,"traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/InventoryLineDto"},"example":"<InventoryLineDto> <correlationId>00000000-0000-0000-0000-000000000000</correlationId> <productId>0</productId> <productCorrelationId>00000000-0000-0000-0000-000000000000</productCorrelationId> <productCode>string</productCode> <productDescription>string</productDescription> <stockUnits>0</stockUnits> <stockUnitsCalculated>0</stockUnitsCalculated> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> </InventoryLineDto>"},"text/xml":{"schema":{"$ref":"#/components/schemas/InventoryLineDto"},"example":"<InventoryLineDto> <correlationId>00000000-0000-0000-0000-000000000000</correlationId> <productId>0</productId> <productCorrelationId>00000000-0000-0000-0000-000000000000</productCorrelationId> <productCode>string</productCode> <productDescription>string</productDescription> <stockUnits>0</stockUnits> <stockUnitsCalculated>0</stockUnitsCalculated> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> </InventoryLineDto>"},"application/x-www-form-urlencoded":{}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/inventories/{inventoryCorrelationId}/lines/{lineCorrelationId}":{"put":{"tags":["inventories"],"summary":"Update specific properties of an inventory line","description":"Update specific properties of an inventory line","operationId":"InventoryLi_PutLine","parameters":[{"name":"inventoryCorrelationId","in":"path","description":"Inventory CorrealtionId","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"lineCorrelationId","in":"path","description":"Inventory Line CorrealtionId","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"InventoryLineDto object{a3ERP.Public.Resources.V2.PatchOperation}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryLineDto"},"example":{"correlationId":"00000000-0000-0000-0000-000000000000","productId":0,"productCorrelationId":"00000000-0000-0000-0000-000000000000","productCode":"string","productDescription":"string","stockUnits":0,"stockUnitsCalculated":0,"traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}]}},"text/json":{"schema":{"$ref":"#/components/schemas/InventoryLineDto"},"example":{"correlationId":"00000000-0000-0000-0000-000000000000","productId":0,"productCorrelationId":"00000000-0000-0000-0000-000000000000","productCode":"string","productDescription":"string","stockUnits":0,"stockUnitsCalculated":0,"traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}]}},"text/html":{"schema":{"$ref":"#/components/schemas/InventoryLineDto"},"example":"<InventoryLineDto> <correlationId>00000000-0000-0000-0000-000000000000</correlationId> <productId>0</productId> <productCorrelationId>00000000-0000-0000-0000-000000000000</productCorrelationId> <productCode>string</productCode> <productDescription>string</productDescription> <stockUnits>0</stockUnits> <stockUnitsCalculated>0</stockUnitsCalculated> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> </InventoryLineDto>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/InventoryLineDto"},"example":{"correlationId":"00000000-0000-0000-0000-000000000000","productId":0,"productCorrelationId":"00000000-0000-0000-0000-000000000000","productCode":"string","productDescription":"string","stockUnits":0,"stockUnitsCalculated":0,"traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/InventoryLineDto"},"example":"<InventoryLineDto> <correlationId>00000000-0000-0000-0000-000000000000</correlationId> <productId>0</productId> <productCorrelationId>00000000-0000-0000-0000-000000000000</productCorrelationId> <productCode>string</productCode> <productDescription>string</productDescription> <stockUnits>0</stockUnits> <stockUnitsCalculated>0</stockUnitsCalculated> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> </InventoryLineDto>"},"text/xml":{"schema":{"$ref":"#/components/schemas/InventoryLineDto"},"example":"<InventoryLineDto> <correlationId>00000000-0000-0000-0000-000000000000</correlationId> <productId>0</productId> <productCorrelationId>00000000-0000-0000-0000-000000000000</productCorrelationId> <productCode>string</productCode> <productDescription>string</productDescription> <stockUnits>0</stockUnits> <stockUnitsCalculated>0</stockUnitsCalculated> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> </InventoryLineDto>"},"application/x-www-form-urlencoded":{}}},"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["inventories"],"summary":"Delete an inventory line by identifier","description":"Delete an inventory line by identifier","operationId":"InventoryLi_DeleteLine","parameters":[{"name":"inventoryCorrelationId","in":"path","description":"Inventory CorrealtionId","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"lineCorrelationId","in":"path","description":"Inventory Line CorrealtionId","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/inventories/import":{"post":{"tags":["inventories"],"summary":"Import Inventory","description":"Import Inventory","operationId":"Inventories_ImportInventory","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["uploadedFile"],"properties":{"uploadedFile":{"type":"array","description":"File to upload"}}}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/inventories/export/{id}":{"post":{"tags":["inventories"],"summary":"Generate the export for inventory","description":"Generate the export for inventory","operationId":"Inventories_GenerateExportInventory","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/inventories/import/validate":{"post":{"tags":["inventories"],"summary":"Validate Import Inventory","description":"Validate Import Inventory","operationId":"Inventories_ValidateImportInventory","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["uploadedFile"],"properties":{"uploadedFile":{"type":"array","description":"File to upload"}}}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/inventories/template":{"post":{"tags":["inventories"],"summary":"Generate the template for inventory","description":"Generate the template for inventory","operationId":"Inventories_DownloadInventoryTemplate","parameters":[{"name":"warehouseCorrelationId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/kpi":{"post":{"tags":["kpi"],"summary":"Get kpi","description":"Get kpi","operationId":"Kpi_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Collection of {a3ERP.Public.Resources.V2.DTO.Kpi.KpiDTO}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KpiDTOArray"},"example":[{"key":"string","value":"string"}]},"text/json":{"schema":{"$ref":"#/components/schemas/KpiDTOArray"},"example":[{"key":"string","value":"string"}]},"text/html":{"schema":{"$ref":"#/components/schemas/KpiDTOArray"},"example":"<KpiDTOArray> <key>string</key> <value>string</value> </KpiDTOArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/KpiDTOArray"},"example":[{"key":"string","value":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/KpiDTOArray"},"example":"<KpiDTOArray> <key>string</key> <value>string</value> </KpiDTOArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/KpiDTOArray"},"example":"<KpiDTOArray> <key>string</key> <value>string</value> </KpiDTOArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKpiPost200ApplicationJsonResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiKpiPost200ApplicationXmlResponse"},"example":"<ApiKpiPost200ApplicationXmlResponse />"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/legalRepresentative":{"get":{"tags":["LegalRepresentative"],"summary":"Obtener el represenante legal de la empresa logeada","description":"Obtener el represenante legal de la empresa logeada","operationId":"LegalRepresentative_Get","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiLegalRepresentativeGet200ApplicationJsonResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiLegalRepresentativeGet200ApplicationXmlResponse"},"example":"<ApiLegalRepresentativeGet200ApplicationXmlResponse />"}}}}},"post":{"tags":["LegalRepresentative"],"summary":"Crear representante legal","description":"Detalles:\r\nPersonType: 'E' para persona juridica\r\n            'P' Para persona fisica\r\n            \r\nNifImageFront y NifImageBack deben ser las imagenes codificadas en un string base64\r\n\r\nLos campos de Name, Nif, Town, Address son obligatorios para persona juridica\r\n\r\nEl campo IsLegalRepresentativeConfirmed debe ser true para expresar que los datos y \r\nlas imagenes son correctas al representante legal","operationId":"LegalRepresentative_Post","parameters":[{"name":"isPartial","in":"query","description":"indica si el registro es parcial","required":true,"schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"DTO del representante legal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalRepresentativeDTO"},"example":{"id":0,"name":"string","nif":"string","town":"string","address":"string","correlationId":"00000000-0000-0000-0000-000000000000","personType":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/LegalRepresentativeDTO"},"example":{"id":0,"name":"string","nif":"string","town":"string","address":"string","correlationId":"00000000-0000-0000-0000-000000000000","personType":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/LegalRepresentativeDTO"},"example":"<LegalRepresentativeDTO> <id>0</id> <name>string</name> <nif>string</nif> <town>string</town> <address>string</address> <correlationId>00000000-0000-0000-0000-000000000000</correlationId> <personType>string</personType> </LegalRepresentativeDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/LegalRepresentativeDTO"},"example":{"id":0,"name":"string","nif":"string","town":"string","address":"string","correlationId":"00000000-0000-0000-0000-000000000000","personType":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/LegalRepresentativeDTO"},"example":"<LegalRepresentativeDTO> <id>0</id> <name>string</name> <nif>string</nif> <town>string</town> <address>string</address> <correlationId>00000000-0000-0000-0000-000000000000</correlationId> <personType>string</personType> </LegalRepresentativeDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/LegalRepresentativeDTO"},"example":"<LegalRepresentativeDTO> <id>0</id> <name>string</name> <nif>string</nif> <town>string</town> <address>string</address> <correlationId>00000000-0000-0000-0000-000000000000</correlationId> <personType>string</personType> </LegalRepresentativeDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiLegalRepresentativePost204ApplicationJsonResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiLegalRepresentativePost204ApplicationXmlResponse"},"example":"<ApiLegalRepresentativePost204ApplicationXmlResponse />"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/legalRepresentative/pdf":{"get":{"tags":["LegalRepresentative"],"summary":"Get the pdf of the legal representation document","description":"Get the pdf of the legal representation document","operationId":"LegalRepresentative_GetPdf","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/legalRepresentative/{legalRepresentativeId}":{"put":{"tags":["LegalRepresentative"],"summary":"Crear representante legal","description":"Detalles:\r\nPersonType: 'E' para persona juridica\r\n            'P' Para persona fisica\r\n            \r\nNifImageFront y NifImageBack deben ser las imagenes codificadas en un string base64\r\n\r\nLos campos de Name, Nif, Town, Address son obligatorios para persona juridica\r\n\r\nEl campo IsLegalRepresentativeConfirmed debe ser true para expresar que los datos y \r\nlas imagenes son correctas al representante legal","operationId":"LegalRepresentative_Put","parameters":[{"name":"legalRepresentativeId","in":"path","description":"CorrelationId representante legal","required":true,"schema":{"type":"string"}},{"name":"isPartial","in":"query","description":"indica si el registro es parcial","required":true,"schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"DTO del representante legal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalRepresentativeDTO"},"example":{"id":0,"name":"string","nif":"string","town":"string","address":"string","correlationId":"00000000-0000-0000-0000-000000000000","personType":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/LegalRepresentativeDTO"},"example":{"id":0,"name":"string","nif":"string","town":"string","address":"string","correlationId":"00000000-0000-0000-0000-000000000000","personType":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/LegalRepresentativeDTO"},"example":"<LegalRepresentativeDTO> <id>0</id> <name>string</name> <nif>string</nif> <town>string</town> <address>string</address> <correlationId>00000000-0000-0000-0000-000000000000</correlationId> <personType>string</personType> </LegalRepresentativeDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/LegalRepresentativeDTO"},"example":{"id":0,"name":"string","nif":"string","town":"string","address":"string","correlationId":"00000000-0000-0000-0000-000000000000","personType":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/LegalRepresentativeDTO"},"example":"<LegalRepresentativeDTO> <id>0</id> <name>string</name> <nif>string</nif> <town>string</town> <address>string</address> <correlationId>00000000-0000-0000-0000-000000000000</correlationId> <personType>string</personType> </LegalRepresentativeDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/LegalRepresentativeDTO"},"example":"<LegalRepresentativeDTO> <id>0</id> <name>string</name> <nif>string</nif> <town>string</town> <address>string</address> <correlationId>00000000-0000-0000-0000-000000000000</correlationId> <personType>string</personType> </LegalRepresentativeDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiLegalRepresentativeLegalRepresentativeIdPut204ApplicationJsonResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiLegalRepresentativeLegalRepresentativeIdPut204ApplicationXmlResponse"},"example":"<ApiLegalRepresentativeLegalRepresentativeIdPut204ApplicationXmlResponse />"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/license":{"get":{"tags":["license"],"summary":"Get license","description":"Get license","operationId":"License_Get","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseDTO"},"example":{"licenses":0,"state":0,"gamma":0,"endDate":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/LicenseDTO"},"example":"<LicenseDTO> <licenses>0</licenses> <state>0</state> <gamma>0</gamma> <endDate>string</endDate> </LicenseDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/migrations/validateaccountsorigin":{"get":{"tags":["migrations"],"summary":"Validate data before start the migration in origin company.","description":"Validate data before start the migration in origin company.","operationId":"Migrations_ValidateAccountsOrigin","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/migrations/validatedocumentsorigin":{"get":{"tags":["migrations"],"summary":"Validate data before start the migration in origin company.","description":"Validate data before start the migration in origin company.","operationId":"Migrations_ValidateDocumentsOrigin","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/migrations/duration/{migrationScenario}":{"get":{"tags":["migrations"],"summary":"Obtiene la duración estimada de la migración según el escenario especificado.","description":"Obtiene la duración estimada de la migración según el escenario especificado.","operationId":"Migrations_CalculateMigrationDuration","parameters":[{"name":"migrationScenario","in":"path","description":"El escenario de migración:\r\n            1. a3factura con contabilidad\r\n            2. a3factura con ECO\r\n            3. a3factura con otra contabilidad\r\n            4. a3factura sin contabilidad","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}}}}},"/api/migrations/validations":{"post":{"tags":["migrations"],"summary":"Validate data before start the migration in destination company.","description":"Validate data before start the migration in destination company.","operationId":"Migrations_Validate","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/migrations/migratetoa3innuva":{"post":{"tags":["migrations"],"summary":"Force migration","description":"Force migration","operationId":"Migrations_MigrateToa3Innuva","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartMigrationCommand"},"example":{"TenantId":"string","ProcessId":"00000000-0000-0000-0000-000000000000","CorrelationId":"string","Id":"00000000-0000-0000-0000-000000000000","Emitted":"string","EmittedStamp":0,"Headers":{},"FromTenantId":"string","SyncItems":[{"Entity":"string","SourceCorrelationId":"string","TargetCorrelationId":"string"}],"MigrationScenario":0}},"text/json":{"schema":{"$ref":"#/components/schemas/StartMigrationCommand"},"example":{"TenantId":"string","ProcessId":"00000000-0000-0000-0000-000000000000","CorrelationId":"string","Id":"00000000-0000-0000-0000-000000000000","Emitted":"string","EmittedStamp":0,"Headers":{},"FromTenantId":"string","SyncItems":[{"Entity":"string","SourceCorrelationId":"string","TargetCorrelationId":"string"}],"MigrationScenario":0}},"text/html":{"schema":{"$ref":"#/components/schemas/StartMigrationCommand"},"example":"<StartMigrationCommand> <TenantId>string</TenantId> <ProcessId>00000000-0000-0000-0000-000000000000</ProcessId> <CorrelationId>string</CorrelationId> <Id>00000000-0000-0000-0000-000000000000</Id> <Emitted>string</Emitted> <EmittedStamp>0</EmittedStamp> <Headers /> <FromTenantId>string</FromTenantId> <SyncItems> <Entity>string</Entity> <SourceCorrelationId>string</SourceCorrelationId> <TargetCorrelationId>string</TargetCorrelationId> </SyncItems> <MigrationScenario>0</MigrationScenario> </StartMigrationCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/StartMigrationCommand"},"example":{"TenantId":"string","ProcessId":"00000000-0000-0000-0000-000000000000","CorrelationId":"string","Id":"00000000-0000-0000-0000-000000000000","Emitted":"string","EmittedStamp":0,"Headers":{},"FromTenantId":"string","SyncItems":[{"Entity":"string","SourceCorrelationId":"string","TargetCorrelationId":"string"}],"MigrationScenario":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/StartMigrationCommand"},"example":"<StartMigrationCommand> <TenantId>string</TenantId> <ProcessId>00000000-0000-0000-0000-000000000000</ProcessId> <CorrelationId>string</CorrelationId> <Id>00000000-0000-0000-0000-000000000000</Id> <Emitted>string</Emitted> <EmittedStamp>0</EmittedStamp> <Headers /> <FromTenantId>string</FromTenantId> <SyncItems> <Entity>string</Entity> <SourceCorrelationId>string</SourceCorrelationId> <TargetCorrelationId>string</TargetCorrelationId> </SyncItems> <MigrationScenario>0</MigrationScenario> </StartMigrationCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/StartMigrationCommand"},"example":"<StartMigrationCommand> <TenantId>string</TenantId> <ProcessId>00000000-0000-0000-0000-000000000000</ProcessId> <CorrelationId>string</CorrelationId> <Id>00000000-0000-0000-0000-000000000000</Id> <Emitted>string</Emitted> <EmittedStamp>0</EmittedStamp> <Headers /> <FromTenantId>string</FromTenantId> <SyncItems> <Entity>string</Entity> <SourceCorrelationId>string</SourceCorrelationId> <TargetCorrelationId>string</TargetCorrelationId> </SyncItems> <MigrationScenario>0</MigrationScenario> </StartMigrationCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}}}}},"/api/modules/{applicationName}":{"get":{"tags":["modules"],"summary":"Get the module","description":"Get the module","operationId":"Modules_Get","parameters":[{"name":"applicationName","in":"path","description":"The application name","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModuleTokenDTO"},"example":{"application":{"id":"string","name":"string","description":"string","eMail":"string"},"idcda":"string","companyName":"string","createdOn":"string","frontOfficeURL":"string","backOfficeURL":"string","price":0,"state":0,"changeStateInfo":"string","credentials":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ModuleTokenDTO"},"example":"<ModuleTokenDTO> <application> <id>string</id> <name>string</name> <description>string</description> <eMail>string</eMail> </application> <idcda>string</idcda> <companyName>string</companyName> <createdOn>string</createdOn> <frontOfficeURL>string</frontOfficeURL> <backOfficeURL>string</backOfficeURL> <price>0</price> <state>0</state> <changeStateInfo>string</changeStateInfo> <credentials>string</credentials> </ModuleTokenDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["modules"],"summary":"Update a module","description":"Update a module","operationId":"Modules_Put","parameters":[{"name":"applicationName","in":"path","description":"The application name","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"module to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModuleTokenPUTDTO"},"example":{"frontOfficeURL":"string","backOfficeURL":"string","price":0,"state":0,"changeStateInfo":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/ModuleTokenPUTDTO"},"example":{"frontOfficeURL":"string","backOfficeURL":"string","price":0,"state":0,"changeStateInfo":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/ModuleTokenPUTDTO"},"example":"<ModuleTokenPUTDTO> <frontOfficeURL>string</frontOfficeURL> <backOfficeURL>string</backOfficeURL> <price>0</price> <state>0</state> <changeStateInfo>string</changeStateInfo> </ModuleTokenPUTDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ModuleTokenPUTDTO"},"example":{"frontOfficeURL":"string","backOfficeURL":"string","price":0,"state":0,"changeStateInfo":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ModuleTokenPUTDTO"},"example":"<ModuleTokenPUTDTO> <frontOfficeURL>string</frontOfficeURL> <backOfficeURL>string</backOfficeURL> <price>0</price> <state>0</state> <changeStateInfo>string</changeStateInfo> </ModuleTokenPUTDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ModuleTokenPUTDTO"},"example":"<ModuleTokenPUTDTO> <frontOfficeURL>string</frontOfficeURL> <backOfficeURL>string</backOfficeURL> <price>0</price> <state>0</state> <changeStateInfo>string</changeStateInfo> </ModuleTokenPUTDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"204":{"description":"No content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["modules"],"summary":"Subscribe a module","description":"Subscribe a module","operationId":"Modules_Post","parameters":[{"name":"applicationName","in":"path","description":"The application name","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Price","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Price"},"example":0},"text/json":{"schema":{"$ref":"#/components/schemas/Price"},"example":0},"text/html":{"schema":{"$ref":"#/components/schemas/Price"},"example":"<Price>0</Price>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/Price"},"example":0},"application/xml":{"schema":{"$ref":"#/components/schemas/Price"},"example":"<Price>0</Price>"},"text/xml":{"schema":{"$ref":"#/components/schemas/Price"},"example":"<Price>0</Price>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/modules/registerToken/{applicationName}":{"get":{"tags":["modules"],"summary":"Get a token for register an application","description":"Get a token for register an application","operationId":"Modules_GetRegisterToken","parameters":[{"name":"applicationName","in":"path","description":"The application name","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiModulesRegisterTokenApplicationNameGet200ApplicationJsonResponse"},"example":"string"},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiModulesRegisterTokenApplicationNameGet200ApplicationXmlResponse"},"example":"<ApiModulesRegisterTokenApplicationNameGet200ApplicationXmlResponse>string</ApiModulesRegisterTokenApplicationNameGet200ApplicationXmlResponse>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/modules/unregisterToken/{applicationName}":{"get":{"tags":["modules"],"summary":"Get a token for unregister an application","description":"Get a token for unregister an application","operationId":"Modules_GetUnRegisterToken","parameters":[{"name":"applicationName","in":"path","description":"The application name","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiModulesUnregisterTokenApplicationNameGet200ApplicationJsonResponse"},"example":"string"},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiModulesUnregisterTokenApplicationNameGet200ApplicationXmlResponse"},"example":"<ApiModulesUnregisterTokenApplicationNameGet200ApplicationXmlResponse>string</ApiModulesUnregisterTokenApplicationNameGet200ApplicationXmlResponse>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/myapplications":{"get":{"tags":["myapplications"],"summary":"Get my applications","description":"Get my applications","operationId":"MyApplications_Get","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationDTOArray"},"example":[{"id":"string","name":"string","description":"string","eMail":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/ApplicationDTOArray"},"example":"<ApplicationDTOArray> <id>string</id> <name>string</name> <description>string</description> <eMail>string</eMail> </ApplicationDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/myapplications/{name}":{"get":{"tags":["myapplications"],"summary":"Get the application token","description":"Get the application token","operationId":"MyApplications_GetByName","parameters":[{"name":"name","in":"path","description":"The application name","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenDTO"},"example":{"access_token":"string","refresh_token":"string","expires_in":0,"token_type":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TokenDTO"},"example":"<TokenDTO> <access_token>string</access_token> <refresh_token>string</refresh_token> <expires_in>0</expires_in> <token_type>string</token_type> </TokenDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["myapplications"],"summary":"Subscribe application","description":"Subscribe application","operationId":"MyApplications_Subscribe","parameters":[{"name":"name","in":"path","description":"Application name","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"201":{"description":"Ok","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["myapplications"],"summary":"Unsubscribe application","description":"Unsubscribe application","operationId":"MyApplications_UnSubscribe","parameters":[{"name":"name","in":"path","description":"Application name","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/myapplications/application/{name}":{"get":{"tags":["myapplications"],"summary":"Get my application","description":"Get my application","operationId":"MyApplications_GetApplicationTokenByName","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationTokenDTO"},"example":{"id":"string","application":{"id":"string","name":"string","description":"string","eMail":"string"},"company":{"id":0,"name":"string","idCDA":"string","default":true,"companyStatus":"Updating"},"token":"string","refresh":"string","createdOn":"string","frontOfficeURL":"string","backOfficeURL":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ApplicationTokenDTO"},"example":"<ApplicationTokenDTO> <id>string</id> <application> <id>string</id> <name>string</name> <description>string</description> <eMail>string</eMail> </application> <company> <id>0</id> <name>string</name> <idCDA>string</idCDA> <default>true</default> <companyStatus>Updating</companyStatus> </company> <token>string</token> <refresh>string</refresh> <createdOn>string</createdOn> <frontOfficeURL>string</frontOfficeURL> <backOfficeURL>string</backOfficeURL> </ApplicationTokenDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/organizations/vatTypeNumber":{"get":{"tags":["organizations"],"summary":"Get a Vat number type from a vat number","description":"Get a Vat number type from a vat number","operationId":"Organizations_GetVatTypeNumber","parameters":[{"name":"vatNumber","in":"query","description":"Vat number","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiOrganizationsVatTypeNumberGet200ApplicationJsonResponse"},"example":0},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiOrganizationsVatTypeNumberGet200ApplicationXmlResponse"},"example":"<ApiOrganizationsVatTypeNumberGet200ApplicationXmlResponse>0</ApiOrganizationsVatTypeNumberGet200ApplicationXmlResponse>"}}}}}},"/api/organizations":{"get":{"tags":["organizations"],"summary":"Get all organizations","description":"Get all organizations","operationId":"Organizations_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationDTOArray"},"example":[{"id":"string","name":"string","vatNumber":"string","phone":"string","mail":"string","street":"string","town":"string","zipCode":"string","provinceCode":"string","countryCode":"string","vatNumberType":0,"addressCorrelationId":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/OrganizationDTOArray"},"example":"<OrganizationDTOArray> <id>string</id> <name>string</name> <vatNumber>string</vatNumber> <phone>string</phone> <mail>string</mail> <street>string</street> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <countryCode>string</countryCode> <vatNumberType>0</vatNumberType> <addressCorrelationId>string</addressCorrelationId> </OrganizationDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/organizations/validateVatNumber":{"post":{"tags":["organizations"],"summary":"Validate the vat number type with the vat number","description":"Validate the vat number type with the vat number","operationId":"Organizations_ValidateVatNumber","parameters":[{"name":"vatNumberType","in":"query","description":"vat number type\r\n             None = 0,\r\n             Cif = 1,\r\n             Nif = 2,\r\n             Nie = 3,\r\n             NifIntracom = 4,\r\n             Other = 5,\r\n             Passport = 6,\r\n             ResidenceCountryOfficialDocument = 7,\r\n             TaxResidenceCertificate = 8","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"vatNumber","in":"query","description":"vat number","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}}}}},"/api/paymentMethods/{id}":{"get":{"tags":["paymentMethods"],"summary":"Get a payment method by identifier","description":"Get a payment method by identifier","operationId":"PaymentMethods_GetById","parameters":[{"name":"id","in":"path","description":"Payment method id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethodDTO"},"example":{"id":"string","code":"string","description":"string","promptPaymentDiscountPercentage":0,"financialChargePercentage":0,"numberOfDues":0,"firstPeriod":0,"nextPeriod":0,"calculationMethod":0,"automaticPayment":true}},"application/xml":{"schema":{"$ref":"#/components/schemas/PaymentMethodDTO"},"example":"<PaymentMethodDTO> <id>string</id> <code>string</code> <description>string</description> <promptPaymentDiscountPercentage>0</promptPaymentDiscountPercentage> <financialChargePercentage>0</financialChargePercentage> <numberOfDues>0</numberOfDues> <firstPeriod>0</firstPeriod> <nextPeriod>0</nextPeriod> <calculationMethod>0</calculationMethod> <automaticPayment>true</automaticPayment> </PaymentMethodDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["paymentMethods"],"summary":"Delete a payment method by identifier","description":"Delete a payment method by identifier","operationId":"PaymentMethods_Delete","parameters":[{"name":"id","in":"path","description":"Payment method identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"patch":{"tags":["paymentMethods"],"summary":"Update specific properties of a payment method","description":"Update specific properties of a payment method","operationId":"PaymentMethods_Patch","parameters":[{"name":"id","in":"path","description":"Payment method id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Collection of {a3ERP.Public.Resources.V2.PatchOperation}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/html":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/paymentMethods":{"get":{"tags":["paymentMethods"],"summary":"Get all payment methods","description":"Get all payment methods","operationId":"PaymentMethods_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethodDTOArray"},"example":[{"id":"string","code":"string","description":"string","promptPaymentDiscountPercentage":0,"financialChargePercentage":0,"numberOfDues":0,"firstPeriod":0,"nextPeriod":0,"calculationMethod":0,"automaticPayment":true}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PaymentMethodDTOArray"},"example":"<PaymentMethodDTOArray> <id>string</id> <code>string</code> <description>string</description> <promptPaymentDiscountPercentage>0</promptPaymentDiscountPercentage> <financialChargePercentage>0</financialChargePercentage> <numberOfDues>0</numberOfDues> <firstPeriod>0</firstPeriod> <nextPeriod>0</nextPeriod> <calculationMethod>0</calculationMethod> <automaticPayment>true</automaticPayment> </PaymentMethodDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["paymentMethods"],"summary":"Create a payment method","description":"Create a payment method","operationId":"PaymentMethods_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Payment Method","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethodDTO"},"example":{"id":"string","code":"string","description":"string","promptPaymentDiscountPercentage":0,"financialChargePercentage":0,"numberOfDues":0,"firstPeriod":0,"nextPeriod":0,"calculationMethod":0,"automaticPayment":true}},"text/json":{"schema":{"$ref":"#/components/schemas/PaymentMethodDTO"},"example":{"id":"string","code":"string","description":"string","promptPaymentDiscountPercentage":0,"financialChargePercentage":0,"numberOfDues":0,"firstPeriod":0,"nextPeriod":0,"calculationMethod":0,"automaticPayment":true}},"text/html":{"schema":{"$ref":"#/components/schemas/PaymentMethodDTO"},"example":"<PaymentMethodDTO> <id>string</id> <code>string</code> <description>string</description> <promptPaymentDiscountPercentage>0</promptPaymentDiscountPercentage> <financialChargePercentage>0</financialChargePercentage> <numberOfDues>0</numberOfDues> <firstPeriod>0</firstPeriod> <nextPeriod>0</nextPeriod> <calculationMethod>0</calculationMethod> <automaticPayment>true</automaticPayment> </PaymentMethodDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PaymentMethodDTO"},"example":{"id":"string","code":"string","description":"string","promptPaymentDiscountPercentage":0,"financialChargePercentage":0,"numberOfDues":0,"firstPeriod":0,"nextPeriod":0,"calculationMethod":0,"automaticPayment":true}},"application/xml":{"schema":{"$ref":"#/components/schemas/PaymentMethodDTO"},"example":"<PaymentMethodDTO> <id>string</id> <code>string</code> <description>string</description> <promptPaymentDiscountPercentage>0</promptPaymentDiscountPercentage> <financialChargePercentage>0</financialChargePercentage> <numberOfDues>0</numberOfDues> <firstPeriod>0</firstPeriod> <nextPeriod>0</nextPeriod> <calculationMethod>0</calculationMethod> <automaticPayment>true</automaticPayment> </PaymentMethodDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PaymentMethodDTO"},"example":"<PaymentMethodDTO> <id>string</id> <code>string</code> <description>string</description> <promptPaymentDiscountPercentage>0</promptPaymentDiscountPercentage> <financialChargePercentage>0</financialChargePercentage> <numberOfDues>0</numberOfDues> <firstPeriod>0</firstPeriod> <nextPeriod>0</nextPeriod> <calculationMethod>0</calculationMethod> <automaticPayment>true</automaticPayment> </PaymentMethodDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/paymentTypes/{id}":{"get":{"tags":["paymentTypes"],"summary":"Get a payment type by identifier","description":"Get a payment type by identifier","operationId":"PaymentTypes_GetById","parameters":[{"name":"id","in":"path","description":"The payment type id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerieDTO"},"example":{"id":"string","code":"string","description":"string","a3InnuvaActivityId":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SerieDTO"},"example":"<SerieDTO> <id>string</id> <code>string</code> <description>string</description> <a3InnuvaActivityId>string</a3InnuvaActivityId> </SerieDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["paymentTypes"],"summary":"Delete a payment type by identifier","description":"Delete a payment type by identifier","operationId":"PaymentTypes_Delete","parameters":[{"name":"id","in":"path","description":"payment type identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"patch":{"tags":["paymentTypes"],"summary":"Update specific properties of payment type","description":"Update specific properties of payment type","operationId":"PaymentTypes_Patch","parameters":[{"name":"id","in":"path","description":"payment type id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Collection of {a3ERP.Public.Resources.V2.PatchOperation}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/html":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/paymentTypes":{"get":{"tags":["paymentTypes"],"summary":"Get all payment types","description":"Get all payment types","operationId":"PaymentTypes_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentTypeDTOArray"},"example":[{"id":"string","code":"string","description":"string","remittable":true}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PaymentTypeDTOArray"},"example":"<PaymentTypeDTOArray> <id>string</id> <code>string</code> <description>string</description> <remittable>true</remittable> </PaymentTypeDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["paymentTypes"],"summary":"Create a payment type","description":"Create a payment type","operationId":"PaymentTypes_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Payment Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentTypeDTO"},"example":{"id":"string","code":"string","description":"string","remittable":true}},"text/json":{"schema":{"$ref":"#/components/schemas/PaymentTypeDTO"},"example":{"id":"string","code":"string","description":"string","remittable":true}},"text/html":{"schema":{"$ref":"#/components/schemas/PaymentTypeDTO"},"example":"<PaymentTypeDTO> <id>string</id> <code>string</code> <description>string</description> <remittable>true</remittable> </PaymentTypeDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PaymentTypeDTO"},"example":{"id":"string","code":"string","description":"string","remittable":true}},"application/xml":{"schema":{"$ref":"#/components/schemas/PaymentTypeDTO"},"example":"<PaymentTypeDTO> <id>string</id> <code>string</code> <description>string</description> <remittable>true</remittable> </PaymentTypeDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PaymentTypeDTO"},"example":"<PaymentTypeDTO> <id>string</id> <code>string</code> <description>string</description> <remittable>true</remittable> </PaymentTypeDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/processLogs/{id}":{"get":{"tags":["processLogs"],"summary":"Get a process log by identifier","description":"Get a process log by identifier","operationId":"ProcessLogQ_GetById","parameters":[{"name":"id","in":"path","description":"Process log identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessLogDTO"},"example":{"processId":"00000000-0000-0000-0000-000000000000","correlationId":"string","id":"string","tenantId":"string","processType":0,"processStatus":0,"createdDate":"string","startDate":"string","endDate":"string","result":[{"errorCode":"string","errorMessage":"string"}],"processName":"string","params":"string","userName":"string","parentId":"00000000-0000-0000-0000-000000000000","processDescriptions":{}}},"application/xml":{"schema":{"$ref":"#/components/schemas/ProcessLogDTO"},"example":"<ProcessLogDTO> <processId>00000000-0000-0000-0000-000000000000</processId> <correlationId>string</correlationId> <id>string</id> <tenantId>string</tenantId> <processType>0</processType> <processStatus>0</processStatus> <createdDate>string</createdDate> <startDate>string</startDate> <endDate>string</endDate> <result> <errorCode>string</errorCode> <errorMessage>string</errorMessage> </result> <processName>string</processName> <params>string</params> <userName>string</userName> <parentId>00000000-0000-0000-0000-000000000000</parentId> <processDescriptions /> </ProcessLogDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["processLogs"],"summary":"Delete a sale delivery note","description":"Delete a sale delivery note","operationId":"ProcessLogW_Delete","parameters":[{"name":"id","in":"path","description":"Sale order identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiProcessLogsIdDelete204ApplicationJsonResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiProcessLogsIdDelete204ApplicationXmlResponse"},"example":"<ApiProcessLogsIdDelete204ApplicationXmlResponse />"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/processLogs/{id}/issues":{"get":{"tags":["processLogs"],"summary":"Get a list of issues from a parent log item","description":"Get a list of issues from a parent log item","operationId":"ProcessLogQ_GetIssuesByParentId","parameters":[{"name":"id","in":"path","description":"Process log parent identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessResultDTOArray"},"example":[{"errorCode":"string","errorMessage":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/ProcessResultDTOArray"},"example":"<ProcessResultDTOArray> <errorCode>string</errorCode> <errorMessage>string</errorMessage> </ProcessResultDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/processLogs":{"get":{"tags":["processLogs"],"summary":"Get all process logs","description":"Get all process logs","operationId":"ProcessLogQ_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessLogFlatDTOArray"},"example":[{"processId":"00000000-0000-0000-0000-000000000000","id":"string","tenantId":"string","processType":0,"processStatus":0,"createdDate":"string","startDate":"string","endDate":"string","processName":"string","params":"string","userName":"string","parentId":"00000000-0000-0000-0000-000000000000","processTypeDescription":"string","processStatusDescription":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/ProcessLogFlatDTOArray"},"example":"<ProcessLogFlatDTOArray> <processId>00000000-0000-0000-0000-000000000000</processId> <id>string</id> <tenantId>string</tenantId> <processType>0</processType> <processStatus>0</processStatus> <createdDate>string</createdDate> <startDate>string</startDate> <endDate>string</endDate> <processName>string</processName> <params>string</params> <userName>string</userName> <parentId>00000000-0000-0000-0000-000000000000</parentId> <processTypeDescription>string</processTypeDescription> <processStatusDescription>string</processStatusDescription> </ProcessLogFlatDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/processLogs/export":{"get":{"tags":["processLogs"],"summary":"Process log note export","description":"Process log note export","operationId":"ProcessLogE_Export","parameters":[{"name":"format","in":"query","description":"Export format","schema":{"enum":["Excel"],"type":"string"}},{"name":"headers","in":"query","description":"Headers","schema":{"type":"string"}},{"name":"title","in":"query","description":"Title","schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiProcessLogsExportGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiProcessLogsExportGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/processLogs/notification":{"post":{"tags":["processLogs"],"summary":"Inbox Process Notification","description":"Inbox Process Notification","operationId":"ProcessLogN_Notification","parameters":[{"name":"ApiKey","in":"header","description":"Api key","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxProcessNotification"},"example":{"ProcessId":"string","HasErrors":true,"ProcessName":"string","TenantId":"string","User":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/InboxProcessNotification"},"example":{"ProcessId":"string","HasErrors":true,"ProcessName":"string","TenantId":"string","User":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/InboxProcessNotification"},"example":"<InboxProcessNotification> <ProcessId>string</ProcessId> <HasErrors>true</HasErrors> <ProcessName>string</ProcessName> <TenantId>string</TenantId> <User>string</User> </InboxProcessNotification>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/InboxProcessNotification"},"example":{"ProcessId":"string","HasErrors":true,"ProcessName":"string","TenantId":"string","User":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/InboxProcessNotification"},"example":"<InboxProcessNotification> <ProcessId>string</ProcessId> <HasErrors>true</HasErrors> <ProcessName>string</ProcessName> <TenantId>string</TenantId> <User>string</User> </InboxProcessNotification>"},"text/xml":{"schema":{"$ref":"#/components/schemas/InboxProcessNotification"},"example":"<InboxProcessNotification> <ProcessId>string</ProcessId> <HasErrors>true</HasErrors> <ProcessName>string</ProcessName> <TenantId>string</TenantId> <User>string</User> </InboxProcessNotification>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/processLogs/deleteMassiveLogs":{"post":{"tags":["processLogs"],"summary":"Delete massive of processlogs","description":"Delete massive of processlogs","operationId":"ProcessLogW_DeleteMassiveProcessLog","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteProcessLogDto"},"example":{"filter":"string","searchBy":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"text/json":{"schema":{"$ref":"#/components/schemas/DeleteProcessLogDto"},"example":{"filter":"string","searchBy":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"text/html":{"schema":{"$ref":"#/components/schemas/DeleteProcessLogDto"},"example":"<DeleteProcessLogDto> <filter>string</filter> <searchBy>string</searchBy> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </DeleteProcessLogDto>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/DeleteProcessLogDto"},"example":{"filter":"string","searchBy":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/DeleteProcessLogDto"},"example":"<DeleteProcessLogDto> <filter>string</filter> <searchBy>string</searchBy> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </DeleteProcessLogDto>"},"text/xml":{"schema":{"$ref":"#/components/schemas/DeleteProcessLogDto"},"example":"<DeleteProcessLogDto> <filter>string</filter> <searchBy>string</searchBy> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </DeleteProcessLogDto>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/products/new":{"get":{"tags":["products"],"summary":"Get a new product with default values","description":"Get a new product with default values","operationId":"Products_GetNew","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDTO"},"example":{"id":"string","code":"string","description":"string","alternativeProductId":"string","supplierId":"string","supplierReference":"string","isSale":true,"incomeTypeId":"string","saleTaxCode":"string","isPurchase":true,"expenseTypeId":"string","purchaseTaxCode":"string","blocked":true,"blockedReason":"string","affectsStock":true,"stockUnits":0,"unitsInPackage":0,"packagesInBundle":0,"standardPrice":0,"lastPurchaseDate":"string","lastUnitPurchasePrice":0,"lastPurchaseDiscount":0,"lastNetPurchasePrice":0,"criteriaValuation":"string","unitValuation":0,"stockValuation":0,"salePrice":0,"saleCurrency":"string","purchasePrice":0,"purchaseCurrency":"string","annotations":"string","creationDate":"string","source":"string","sourceId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"confidentiality":true,"isKit":true,"excludedEquivalenceSurcharge":true,"batches":true,"expirationDates":true,"allowExpiredDates":true,"expiredFormat":0,"serialNumbers":true,"salesCriteria":0,"useDimensions":true,"variantsAffectStock":true,"parentProductId":"00000000-0000-0000-0000-000000000000","isInheritingFromParent":true}},"application/xml":{"schema":{"$ref":"#/components/schemas/ProductDTO"},"example":"<ProductDTO> <id>string</id> <code>string</code> <description>string</description> <alternativeProductId>string</alternativeProductId> <supplierId>string</supplierId> <supplierReference>string</supplierReference> <isSale>true</isSale> <incomeTypeId>string</incomeTypeId> <saleTaxCode>string</saleTaxCode> <isPurchase>true</isPurchase> <expenseTypeId>string</expenseTypeId> <purchaseTaxCode>string</purchaseTaxCode> <blocked>true</blocked> <blockedReason>string</blockedReason> <affectsStock>true</affectsStock> <stockUnits>0</stockUnits> <unitsInPackage>0</unitsInPackage> <packagesInBundle>0</packagesInBundle> <standardPrice>0</standardPrice> <lastPurchaseDate>string</lastPurchaseDate> <lastUnitPurchasePrice>0</lastUnitPurchasePrice> <lastPurchaseDiscount>0</lastPurchaseDiscount> <lastNetPurchasePrice>0</lastNetPurchasePrice> <criteriaValuation>string</criteriaValuation> <unitValuation>0</unitValuation> <stockValuation>0</stockValuation> <salePrice>0</salePrice> <saleCurrency>string</saleCurrency> <purchasePrice>0</purchasePrice> <purchaseCurrency>string</purchaseCurrency> <annotations>string</annotations> <creationDate>string</creationDate> <source>string</source> <sourceId>string</sourceId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <confidentiality>true</confidentiality> <isKit>true</isKit> <excludedEquivalenceSurcharge>true</excludedEquivalenceSurcharge> <batches>true</batches> <expirationDates>true</expirationDates> <allowExpiredDates>true</allowExpiredDates> <expiredFormat>0</expiredFormat> <serialNumbers>true</serialNumbers> <salesCriteria>0</salesCriteria> <useDimensions>true</useDimensions> <variantsAffectStock>true</variantsAffectStock> <parentProductId>00000000-0000-0000-0000-000000000000</parentProductId> <isInheritingFromParent>true</isInheritingFromParent> </ProductDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/products/{id}":{"get":{"tags":["products"],"summary":"Get a product  by identifier","description":"Get a product  by identifier","operationId":"Products_GetById","parameters":[{"name":"id","in":"path","description":"Product identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDTO"},"example":{"id":"string","code":"string","description":"string","alternativeProductId":"string","supplierId":"string","supplierReference":"string","isSale":true,"incomeTypeId":"string","saleTaxCode":"string","isPurchase":true,"expenseTypeId":"string","purchaseTaxCode":"string","blocked":true,"blockedReason":"string","affectsStock":true,"stockUnits":0,"unitsInPackage":0,"packagesInBundle":0,"standardPrice":0,"lastPurchaseDate":"string","lastUnitPurchasePrice":0,"lastPurchaseDiscount":0,"lastNetPurchasePrice":0,"criteriaValuation":"string","unitValuation":0,"stockValuation":0,"salePrice":0,"saleCurrency":"string","purchasePrice":0,"purchaseCurrency":"string","annotations":"string","creationDate":"string","source":"string","sourceId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"confidentiality":true,"isKit":true,"excludedEquivalenceSurcharge":true,"batches":true,"expirationDates":true,"allowExpiredDates":true,"expiredFormat":0,"serialNumbers":true,"salesCriteria":0,"useDimensions":true,"variantsAffectStock":true,"parentProductId":"00000000-0000-0000-0000-000000000000","isInheritingFromParent":true}},"application/xml":{"schema":{"$ref":"#/components/schemas/ProductDTO"},"example":"<ProductDTO> <id>string</id> <code>string</code> <description>string</description> <alternativeProductId>string</alternativeProductId> <supplierId>string</supplierId> <supplierReference>string</supplierReference> <isSale>true</isSale> <incomeTypeId>string</incomeTypeId> <saleTaxCode>string</saleTaxCode> <isPurchase>true</isPurchase> <expenseTypeId>string</expenseTypeId> <purchaseTaxCode>string</purchaseTaxCode> <blocked>true</blocked> <blockedReason>string</blockedReason> <affectsStock>true</affectsStock> <stockUnits>0</stockUnits> <unitsInPackage>0</unitsInPackage> <packagesInBundle>0</packagesInBundle> <standardPrice>0</standardPrice> <lastPurchaseDate>string</lastPurchaseDate> <lastUnitPurchasePrice>0</lastUnitPurchasePrice> <lastPurchaseDiscount>0</lastPurchaseDiscount> <lastNetPurchasePrice>0</lastNetPurchasePrice> <criteriaValuation>string</criteriaValuation> <unitValuation>0</unitValuation> <stockValuation>0</stockValuation> <salePrice>0</salePrice> <saleCurrency>string</saleCurrency> <purchasePrice>0</purchasePrice> <purchaseCurrency>string</purchaseCurrency> <annotations>string</annotations> <creationDate>string</creationDate> <source>string</source> <sourceId>string</sourceId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <confidentiality>true</confidentiality> <isKit>true</isKit> <excludedEquivalenceSurcharge>true</excludedEquivalenceSurcharge> <batches>true</batches> <expirationDates>true</expirationDates> <allowExpiredDates>true</allowExpiredDates> <expiredFormat>0</expiredFormat> <serialNumbers>true</serialNumbers> <salesCriteria>0</salesCriteria> <useDimensions>true</useDimensions> <variantsAffectStock>true</variantsAffectStock> <parentProductId>00000000-0000-0000-0000-000000000000</parentProductId> <isInheritingFromParent>true</isInheritingFromParent> </ProductDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["products"],"summary":"Delete a product by identifier","description":"Delete a product by identifier","operationId":"Products_Delete","parameters":[{"name":"id","in":"path","description":"Product identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"patch":{"tags":["products"],"summary":"Update specific properties of product","description":"Update specific properties of product","operationId":"Products_Patch","parameters":[{"name":"id","in":"path","description":"Product identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Collection changes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/html":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/products/{productId}/kits":{"get":{"tags":["products"],"summary":"Get configuration and components of a kit","description":"Get configuration and components of a kit","operationId":"KitProdu_Get","parameters":[{"name":"productId","in":"path","description":"Product productId","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KitProductConfigurationDto"},"example":{"useKitIncomeType":true,"useKitPrice":true,"components":[{"productId":"00000000-0000-0000-0000-000000000000","units":0}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/KitProductConfigurationDto"},"example":"<KitProductConfigurationDto> <useKitIncomeType>true</useKitIncomeType> <useKitPrice>true</useKitPrice> <components> <productId>00000000-0000-0000-0000-000000000000</productId> <units>0</units> </components> </KitProductConfigurationDto>"}}}}},"put":{"tags":["products"],"summary":"Update components and configuration of a kit","description":"Update components and configuration of a kit","operationId":"KitProdu_Put","parameters":[{"name":"productId","in":"path","description":"Product productId","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"KitProductConfigurationDto","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KitProductConfigurationDto"},"example":{"useKitIncomeType":true,"useKitPrice":true,"components":[{"productId":"00000000-0000-0000-0000-000000000000","units":0}]}},"text/json":{"schema":{"$ref":"#/components/schemas/KitProductConfigurationDto"},"example":{"useKitIncomeType":true,"useKitPrice":true,"components":[{"productId":"00000000-0000-0000-0000-000000000000","units":0}]}},"text/html":{"schema":{"$ref":"#/components/schemas/KitProductConfigurationDto"},"example":"<KitProductConfigurationDto> <useKitIncomeType>true</useKitIncomeType> <useKitPrice>true</useKitPrice> <components> <productId>00000000-0000-0000-0000-000000000000</productId> <units>0</units> </components> </KitProductConfigurationDto>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/KitProductConfigurationDto"},"example":{"useKitIncomeType":true,"useKitPrice":true,"components":[{"productId":"00000000-0000-0000-0000-000000000000","units":0}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/KitProductConfigurationDto"},"example":"<KitProductConfigurationDto> <useKitIncomeType>true</useKitIncomeType> <useKitPrice>true</useKitPrice> <components> <productId>00000000-0000-0000-0000-000000000000</productId> <units>0</units> </components> </KitProductConfigurationDto>"},"text/xml":{"schema":{"$ref":"#/components/schemas/KitProductConfigurationDto"},"example":"<KitProductConfigurationDto> <useKitIncomeType>true</useKitIncomeType> <useKitPrice>true</useKitPrice> <components> <productId>00000000-0000-0000-0000-000000000000</productId> <units>0</units> </components> </KitProductConfigurationDto>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}}}},"post":{"tags":["products"],"summary":"Add components and configure a kit. The product will be converted into a kit","description":"Add components and configure a kit. The product will be converted into a kit","operationId":"KitProdu_Post","parameters":[{"name":"productId","in":"path","description":"Product productId","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"KitProductConfigurationDto","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KitProductConfigurationDto"},"example":{"useKitIncomeType":true,"useKitPrice":true,"components":[{"productId":"00000000-0000-0000-0000-000000000000","units":0}]}},"text/json":{"schema":{"$ref":"#/components/schemas/KitProductConfigurationDto"},"example":{"useKitIncomeType":true,"useKitPrice":true,"components":[{"productId":"00000000-0000-0000-0000-000000000000","units":0}]}},"text/html":{"schema":{"$ref":"#/components/schemas/KitProductConfigurationDto"},"example":"<KitProductConfigurationDto> <useKitIncomeType>true</useKitIncomeType> <useKitPrice>true</useKitPrice> <components> <productId>00000000-0000-0000-0000-000000000000</productId> <units>0</units> </components> </KitProductConfigurationDto>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/KitProductConfigurationDto"},"example":{"useKitIncomeType":true,"useKitPrice":true,"components":[{"productId":"00000000-0000-0000-0000-000000000000","units":0}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/KitProductConfigurationDto"},"example":"<KitProductConfigurationDto> <useKitIncomeType>true</useKitIncomeType> <useKitPrice>true</useKitPrice> <components> <productId>00000000-0000-0000-0000-000000000000</productId> <units>0</units> </components> </KitProductConfigurationDto>"},"text/xml":{"schema":{"$ref":"#/components/schemas/KitProductConfigurationDto"},"example":"<KitProductConfigurationDto> <useKitIncomeType>true</useKitIncomeType> <useKitPrice>true</useKitPrice> <components> <productId>00000000-0000-0000-0000-000000000000</productId> <units>0</units> </components> </KitProductConfigurationDto>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}}}},"delete":{"tags":["products"],"summary":"Delete components and configuration of a kit. The product will no longer be a kit","description":"Delete components and configuration of a kit. The product will no longer be a kit","operationId":"KitProdu_Delete","parameters":[{"name":"productId","in":"path","description":"Product productId","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}}}}},"/api/products/{productId}/image":{"get":{"tags":["products"],"summary":"Get the products's image","description":"Get the products's image","operationId":"Products_GetImage","parameters":[{"name":"productId","in":"path","description":"Product identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"image/jpeg":{"schema":{"$ref":"#/components/schemas/ApiProductsProductIdImageGet200ImageJpegResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"image/jpeg":{}}},"401":{"description":"Unauthorized","content":{"image/jpeg":{}}},"404":{"description":"Unprocessable request","content":{"image/jpeg":{}}},"500":{"description":"Internal server error","content":{"image/jpeg":{}}}}},"put":{"tags":["products"],"summary":"Update the products's image","description":"Update the products's image","operationId":"Products_PutImage","parameters":[{"name":"productId","in":"path","description":"Product identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["uploadedFile"],"properties":{"uploadedFile":{"type":"array","description":"File to upload"}}}}}},"responses":{"204":{"description":"No content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["products"],"summary":"Deletes the product's image by product identifier","description":"Deletes the product's image by product identifier","operationId":"Products_DeleteImage","parameters":[{"name":"productId","in":"path","description":"Product identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/products/{productId}/rates":{"get":{"tags":["products"],"summary":"Get all sale rates of a product","description":"Get all sale rates of a product","operationId":"Products_GetRates","parameters":[{"name":"productId","in":"path","description":"Product","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleRateDTOArray"},"example":[{"id":"string","rateId":"string","price":0}]},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleRateDTOArray"},"example":"<SaleRateDTOArray> <id>string</id> <rateId>string</rateId> <price>0</price> </SaleRateDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["products"],"summary":"Add a new rate","description":"Add a new rate","operationId":"Products_PostRate","parameters":[{"name":"productId","in":"path","description":"Product id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Sale rate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleRateDTO"},"example":{"id":"string","rateId":"string","price":0}},"text/json":{"schema":{"$ref":"#/components/schemas/SaleRateDTO"},"example":{"id":"string","rateId":"string","price":0}},"text/html":{"schema":{"$ref":"#/components/schemas/SaleRateDTO"},"example":"<SaleRateDTO> <id>string</id> <rateId>string</rateId> <price>0</price> </SaleRateDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/SaleRateDTO"},"example":{"id":"string","rateId":"string","price":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleRateDTO"},"example":"<SaleRateDTO> <id>string</id> <rateId>string</rateId> <price>0</price> </SaleRateDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/SaleRateDTO"},"example":"<SaleRateDTO> <id>string</id> <rateId>string</rateId> <price>0</price> </SaleRateDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/products/{productId}/rates/{rateId}":{"get":{"tags":["products"],"summary":"Get a sale rate by identifier","description":"Get a sale rate by identifier","operationId":"Products_GetRateById","parameters":[{"name":"productId","in":"path","description":"Product identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"rateId","in":"path","description":"Sale rate id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleRateDTO"},"example":{"id":"string","rateId":"string","price":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleRateDTO"},"example":"<SaleRateDTO> <id>string</id> <rateId>string</rateId> <price>0</price> </SaleRateDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["products"],"summary":"Delete a sale rate by identifier","description":"Delete a sale rate by identifier","operationId":"Products_DeleteRate","parameters":[{"name":"productId","in":"path","description":"Product identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"rateId","in":"path","description":"Sale rate id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"patch":{"tags":["products"],"summary":"Update specific properties of a sale rate","description":"Update specific properties of a sale rate","operationId":"Products_PatchRate","parameters":[{"name":"productId","in":"path","description":"Product identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"rateId","in":"path","description":"Sale rate id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Collection of {a3ERP.Public.Resources.V2.PatchOperation}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/html":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/products/{productId}/stockinformation":{"get":{"tags":["products"],"summary":"Get stock information by product identifier","description":"Get stock information by product identifier","operationId":"Products_GetStockInformation","parameters":[{"name":"productId","in":"path","description":"Product identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockInformationDTO"},"example":{"stockUnits":0,"purchaseReservationUnits":0,"saleReservationUnits":0,"reservationUnits":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/StockInformationDTO"},"example":"<StockInformationDTO> <stockUnits>0</stockUnits> <purchaseReservationUnits>0</purchaseReservationUnits> <saleReservationUnits>0</saleReservationUnits> <reservationUnits>0</reservationUnits> </StockInformationDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/products":{"get":{"tags":["products"],"summary":"Get all products","description":"Get all products","operationId":"Products_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlatProductDTOArray"},"example":[{"id":"string","code":"string","description":"string","incomeTypeDescription":"string","salePrice":0,"saleCurrency":"string","purchaseTypeDescription":"string","purchasePrice":0,"purchaseCurrency":"string","creationDate":"string","affectsStock":true,"stockUnits":0,"unitsInPackage":0,"packagesInBundle":0,"source":"string","sourceId":"string","isKit":true,"hasTraceability":true,"salesCriteria":0,"useDimensions":true}]},"application/xml":{"schema":{"$ref":"#/components/schemas/FlatProductDTOArray"},"example":"<FlatProductDTOArray> <id>string</id> <code>string</code> <description>string</description> <incomeTypeDescription>string</incomeTypeDescription> <salePrice>0</salePrice> <saleCurrency>string</saleCurrency> <purchaseTypeDescription>string</purchaseTypeDescription> <purchasePrice>0</purchasePrice> <purchaseCurrency>string</purchaseCurrency> <creationDate>string</creationDate> <affectsStock>true</affectsStock> <stockUnits>0</stockUnits> <unitsInPackage>0</unitsInPackage> <packagesInBundle>0</packagesInBundle> <source>string</source> <sourceId>string</sourceId> <isKit>true</isKit> <hasTraceability>true</hasTraceability> <salesCriteria>0</salesCriteria> <useDimensions>true</useDimensions> </FlatProductDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["products"],"summary":"Add a new product","description":"Add a new product","operationId":"Products_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Product","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDTO"},"example":{"id":"string","code":"string","description":"string","alternativeProductId":"string","supplierId":"string","supplierReference":"string","isSale":true,"incomeTypeId":"string","saleTaxCode":"string","isPurchase":true,"expenseTypeId":"string","purchaseTaxCode":"string","blocked":true,"blockedReason":"string","affectsStock":true,"stockUnits":0,"unitsInPackage":0,"packagesInBundle":0,"standardPrice":0,"lastPurchaseDate":"string","lastUnitPurchasePrice":0,"lastPurchaseDiscount":0,"lastNetPurchasePrice":0,"criteriaValuation":"string","unitValuation":0,"stockValuation":0,"salePrice":0,"saleCurrency":"string","purchasePrice":0,"purchaseCurrency":"string","annotations":"string","creationDate":"string","source":"string","sourceId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"confidentiality":true,"isKit":true,"excludedEquivalenceSurcharge":true,"batches":true,"expirationDates":true,"allowExpiredDates":true,"expiredFormat":0,"serialNumbers":true,"salesCriteria":0,"useDimensions":true,"variantsAffectStock":true,"parentProductId":"00000000-0000-0000-0000-000000000000","isInheritingFromParent":true}},"text/json":{"schema":{"$ref":"#/components/schemas/ProductDTO"},"example":{"id":"string","code":"string","description":"string","alternativeProductId":"string","supplierId":"string","supplierReference":"string","isSale":true,"incomeTypeId":"string","saleTaxCode":"string","isPurchase":true,"expenseTypeId":"string","purchaseTaxCode":"string","blocked":true,"blockedReason":"string","affectsStock":true,"stockUnits":0,"unitsInPackage":0,"packagesInBundle":0,"standardPrice":0,"lastPurchaseDate":"string","lastUnitPurchasePrice":0,"lastPurchaseDiscount":0,"lastNetPurchasePrice":0,"criteriaValuation":"string","unitValuation":0,"stockValuation":0,"salePrice":0,"saleCurrency":"string","purchasePrice":0,"purchaseCurrency":"string","annotations":"string","creationDate":"string","source":"string","sourceId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"confidentiality":true,"isKit":true,"excludedEquivalenceSurcharge":true,"batches":true,"expirationDates":true,"allowExpiredDates":true,"expiredFormat":0,"serialNumbers":true,"salesCriteria":0,"useDimensions":true,"variantsAffectStock":true,"parentProductId":"00000000-0000-0000-0000-000000000000","isInheritingFromParent":true}},"text/html":{"schema":{"$ref":"#/components/schemas/ProductDTO"},"example":"<ProductDTO> <id>string</id> <code>string</code> <description>string</description> <alternativeProductId>string</alternativeProductId> <supplierId>string</supplierId> <supplierReference>string</supplierReference> <isSale>true</isSale> <incomeTypeId>string</incomeTypeId> <saleTaxCode>string</saleTaxCode> <isPurchase>true</isPurchase> <expenseTypeId>string</expenseTypeId> <purchaseTaxCode>string</purchaseTaxCode> <blocked>true</blocked> <blockedReason>string</blockedReason> <affectsStock>true</affectsStock> <stockUnits>0</stockUnits> <unitsInPackage>0</unitsInPackage> <packagesInBundle>0</packagesInBundle> <standardPrice>0</standardPrice> <lastPurchaseDate>string</lastPurchaseDate> <lastUnitPurchasePrice>0</lastUnitPurchasePrice> <lastPurchaseDiscount>0</lastPurchaseDiscount> <lastNetPurchasePrice>0</lastNetPurchasePrice> <criteriaValuation>string</criteriaValuation> <unitValuation>0</unitValuation> <stockValuation>0</stockValuation> <salePrice>0</salePrice> <saleCurrency>string</saleCurrency> <purchasePrice>0</purchasePrice> <purchaseCurrency>string</purchaseCurrency> <annotations>string</annotations> <creationDate>string</creationDate> <source>string</source> <sourceId>string</sourceId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <confidentiality>true</confidentiality> <isKit>true</isKit> <excludedEquivalenceSurcharge>true</excludedEquivalenceSurcharge> <batches>true</batches> <expirationDates>true</expirationDates> <allowExpiredDates>true</allowExpiredDates> <expiredFormat>0</expiredFormat> <serialNumbers>true</serialNumbers> <salesCriteria>0</salesCriteria> <useDimensions>true</useDimensions> <variantsAffectStock>true</variantsAffectStock> <parentProductId>00000000-0000-0000-0000-000000000000</parentProductId> <isInheritingFromParent>true</isInheritingFromParent> </ProductDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ProductDTO"},"example":{"id":"string","code":"string","description":"string","alternativeProductId":"string","supplierId":"string","supplierReference":"string","isSale":true,"incomeTypeId":"string","saleTaxCode":"string","isPurchase":true,"expenseTypeId":"string","purchaseTaxCode":"string","blocked":true,"blockedReason":"string","affectsStock":true,"stockUnits":0,"unitsInPackage":0,"packagesInBundle":0,"standardPrice":0,"lastPurchaseDate":"string","lastUnitPurchasePrice":0,"lastPurchaseDiscount":0,"lastNetPurchasePrice":0,"criteriaValuation":"string","unitValuation":0,"stockValuation":0,"salePrice":0,"saleCurrency":"string","purchasePrice":0,"purchaseCurrency":"string","annotations":"string","creationDate":"string","source":"string","sourceId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"confidentiality":true,"isKit":true,"excludedEquivalenceSurcharge":true,"batches":true,"expirationDates":true,"allowExpiredDates":true,"expiredFormat":0,"serialNumbers":true,"salesCriteria":0,"useDimensions":true,"variantsAffectStock":true,"parentProductId":"00000000-0000-0000-0000-000000000000","isInheritingFromParent":true}},"application/xml":{"schema":{"$ref":"#/components/schemas/ProductDTO"},"example":"<ProductDTO> <id>string</id> <code>string</code> <description>string</description> <alternativeProductId>string</alternativeProductId> <supplierId>string</supplierId> <supplierReference>string</supplierReference> <isSale>true</isSale> <incomeTypeId>string</incomeTypeId> <saleTaxCode>string</saleTaxCode> <isPurchase>true</isPurchase> <expenseTypeId>string</expenseTypeId> <purchaseTaxCode>string</purchaseTaxCode> <blocked>true</blocked> <blockedReason>string</blockedReason> <affectsStock>true</affectsStock> <stockUnits>0</stockUnits> <unitsInPackage>0</unitsInPackage> <packagesInBundle>0</packagesInBundle> <standardPrice>0</standardPrice> <lastPurchaseDate>string</lastPurchaseDate> <lastUnitPurchasePrice>0</lastUnitPurchasePrice> <lastPurchaseDiscount>0</lastPurchaseDiscount> <lastNetPurchasePrice>0</lastNetPurchasePrice> <criteriaValuation>string</criteriaValuation> <unitValuation>0</unitValuation> <stockValuation>0</stockValuation> <salePrice>0</salePrice> <saleCurrency>string</saleCurrency> <purchasePrice>0</purchasePrice> <purchaseCurrency>string</purchaseCurrency> <annotations>string</annotations> <creationDate>string</creationDate> <source>string</source> <sourceId>string</sourceId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <confidentiality>true</confidentiality> <isKit>true</isKit> <excludedEquivalenceSurcharge>true</excludedEquivalenceSurcharge> <batches>true</batches> <expirationDates>true</expirationDates> <allowExpiredDates>true</allowExpiredDates> <expiredFormat>0</expiredFormat> <serialNumbers>true</serialNumbers> <salesCriteria>0</salesCriteria> <useDimensions>true</useDimensions> <variantsAffectStock>true</variantsAffectStock> <parentProductId>00000000-0000-0000-0000-000000000000</parentProductId> <isInheritingFromParent>true</isInheritingFromParent> </ProductDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ProductDTO"},"example":"<ProductDTO> <id>string</id> <code>string</code> <description>string</description> <alternativeProductId>string</alternativeProductId> <supplierId>string</supplierId> <supplierReference>string</supplierReference> <isSale>true</isSale> <incomeTypeId>string</incomeTypeId> <saleTaxCode>string</saleTaxCode> <isPurchase>true</isPurchase> <expenseTypeId>string</expenseTypeId> <purchaseTaxCode>string</purchaseTaxCode> <blocked>true</blocked> <blockedReason>string</blockedReason> <affectsStock>true</affectsStock> <stockUnits>0</stockUnits> <unitsInPackage>0</unitsInPackage> <packagesInBundle>0</packagesInBundle> <standardPrice>0</standardPrice> <lastPurchaseDate>string</lastPurchaseDate> <lastUnitPurchasePrice>0</lastUnitPurchasePrice> <lastPurchaseDiscount>0</lastPurchaseDiscount> <lastNetPurchasePrice>0</lastNetPurchasePrice> <criteriaValuation>string</criteriaValuation> <unitValuation>0</unitValuation> <stockValuation>0</stockValuation> <salePrice>0</salePrice> <saleCurrency>string</saleCurrency> <purchasePrice>0</purchasePrice> <purchaseCurrency>string</purchaseCurrency> <annotations>string</annotations> <creationDate>string</creationDate> <source>string</source> <sourceId>string</sourceId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <confidentiality>true</confidentiality> <isKit>true</isKit> <excludedEquivalenceSurcharge>true</excludedEquivalenceSurcharge> <batches>true</batches> <expirationDates>true</expirationDates> <allowExpiredDates>true</allowExpiredDates> <expiredFormat>0</expiredFormat> <serialNumbers>true</serialNumbers> <salesCriteria>0</salesCriteria> <useDimensions>true</useDimensions> <variantsAffectStock>true</variantsAffectStock> <parentProductId>00000000-0000-0000-0000-000000000000</parentProductId> <isInheritingFromParent>true</isInheritingFromParent> </ProductDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/products/export":{"get":{"tags":["products"],"summary":"Export all products with filters","description":"Export all products with filters","operationId":"Products_Export","parameters":[{"name":"format","in":"query","description":"Export format","schema":{"enum":["Excel"],"type":"string"}},{"name":"headers","in":"query","description":"Headers","schema":{"type":"string"}},{"name":"title","in":"query","description":"Title","schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiProductsExportGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiProductsExportGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/products/{productId}/ratesCollection":{"put":{"tags":["products"],"summary":"Update rate collection","description":"Update rate collection","operationId":"Products_PutRates","parameters":[{"name":"productId","in":"path","description":"Product identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Rate list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleRateDTOArray"},"example":[{"id":"string","rateId":"string","price":0}]},"text/json":{"schema":{"$ref":"#/components/schemas/SaleRateDTOArray"},"example":[{"id":"string","rateId":"string","price":0}]},"text/html":{"schema":{"$ref":"#/components/schemas/SaleRateDTOArray"},"example":"<SaleRateDTOArray> <id>string</id> <rateId>string</rateId> <price>0</price> </SaleRateDTOArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/SaleRateDTOArray"},"example":[{"id":"string","rateId":"string","price":0}]},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleRateDTOArray"},"example":"<SaleRateDTOArray> <id>string</id> <rateId>string</rateId> <price>0</price> </SaleRateDTOArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/SaleRateDTOArray"},"example":"<SaleRateDTOArray> <id>string</id> <rateId>string</rateId> <price>0</price> </SaleRateDTOArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/products/{productId}/variants":{"post":{"tags":["products"],"summary":"Add components and configure a kit. The product will be converted into a kit","description":"Add components and configure a kit. The product will be converted into a kit","operationId":"ProductV_Post","parameters":[{"name":"productId","in":"path","description":"Product productId","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"KitProductConfigurationDto","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductVariantsDtoArray"},"example":[{"attributes":[{"dimensionId":"00000000-0000-0000-0000-000000000000","attributeId":"00000000-0000-0000-0000-000000000000"}]}]},"text/json":{"schema":{"$ref":"#/components/schemas/ProductVariantsDtoArray"},"example":[{"attributes":[{"dimensionId":"00000000-0000-0000-0000-000000000000","attributeId":"00000000-0000-0000-0000-000000000000"}]}]},"text/html":{"schema":{"$ref":"#/components/schemas/ProductVariantsDtoArray"},"example":"<ProductVariantsDtoArray> <attributes> <dimensionId>00000000-0000-0000-0000-000000000000</dimensionId> <attributeId>00000000-0000-0000-0000-000000000000</attributeId> </attributes> </ProductVariantsDtoArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ProductVariantsDtoArray"},"example":[{"attributes":[{"dimensionId":"00000000-0000-0000-0000-000000000000","attributeId":"00000000-0000-0000-0000-000000000000"}]}]},"application/xml":{"schema":{"$ref":"#/components/schemas/ProductVariantsDtoArray"},"example":"<ProductVariantsDtoArray> <attributes> <dimensionId>00000000-0000-0000-0000-000000000000</dimensionId> <attributeId>00000000-0000-0000-0000-000000000000</attributeId> </attributes> </ProductVariantsDtoArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ProductVariantsDtoArray"},"example":"<ProductVariantsDtoArray> <attributes> <dimensionId>00000000-0000-0000-0000-000000000000</dimensionId> <attributeId>00000000-0000-0000-0000-000000000000</attributeId> </attributes> </ProductVariantsDtoArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}}}}},"/api/provinces":{"get":{"tags":["provinces"],"summary":"Get all provinces","description":"Get all provinces","operationId":"Provinces_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProvinceDTOArray"},"example":[{"code":"string","description":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/ProvinceDTOArray"},"example":"<ProvinceDTOArray> <code>string</code> <description>string</description> </ProvinceDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseDeliveryNotes/{id}":{"get":{"tags":["purchaseDeliveryNotes"],"summary":"Get a purchase delivery note by Id","description":"Get a purchase delivery note by Id","operationId":"PurchaseDeliveryNotes_GetById","parameters":[{"name":"id","in":"path","description":"Purchase delivery note identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseDeliveryNoteDTO"},"example":{"id":"string","date":"string","receptionDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","operationTypeCode":"string","isTaxIncluded":true,"isTaxBaseAffected":true,"promptPaymentPercentage":0,"financialSurchargePercentage":0,"annotations":"string","taxBase":0,"totalTax":0,"total":0,"source":"string","sourceId":"string","version":"string","lines":[{"id":"string","description":"string","units":0,"servedUnits":0,"cancelledUnits":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","expenseTypeId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"billable":true,"situation":"string","totalPromptPayment":0,"totalFinancialSurcharge":0,"currency":"string","taxRetentionPercentage":0,"taxRetentionBase":0,"totalRetention":0,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseDeliveryNoteDTO"},"example":"<PurchaseDeliveryNoteDTO> <id>string</id> <date>string</date> <receptionDate>string</receptionDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <operationTypeCode>string</operationTypeCode> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <promptPaymentPercentage>0</promptPaymentPercentage> <financialSurchargePercentage>0</financialSurchargePercentage> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <total>0</total> <source>string</source> <sourceId>string</sourceId> <version>string</version> <lines> <id>string</id> <description>string</description> <units>0</units> <servedUnits>0</servedUnits> <cancelledUnits>0</cancelledUnits> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <expenseTypeId>string</expenseTypeId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <billable>true</billable> <situation>string</situation> <totalPromptPayment>0</totalPromptPayment> <totalFinancialSurcharge>0</totalFinancialSurcharge> <currency>string</currency> <taxRetentionPercentage>0</taxRetentionPercentage> <taxRetentionBase>0</taxRetentionBase> <totalRetention>0</totalRetention> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseDeliveryNoteDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["purchaseDeliveryNotes"],"summary":"Delete a purchase delivery note","description":"Delete a purchase delivery note","operationId":"PurchaseDeliveryNotes_Delete","parameters":[{"name":"id","in":"path","description":"purchase delivery note identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseDeliveryNotes/{id}/circuitinfo":{"get":{"tags":["purchaseDeliveryNotes"],"summary":"Get circuit info lines","description":"Get circuit info lines","operationId":"PurchaseDeliveryNotes_CircuitInfoLines","parameters":[{"name":"id","in":"path","description":"Circuit info lines","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CircuitInfoDTOArray"},"example":[{"lineId":"string","description":"string","units":0,"lineBase":0,"situation":0,"cancelledUnits":0,"pendingUnits":0,"confirmedUnits":0,"deliveredUnits":0,"billedUnits":0}]},"application/xml":{"schema":{"$ref":"#/components/schemas/CircuitInfoDTOArray"},"example":"<CircuitInfoDTOArray> <lineId>string</lineId> <description>string</description> <units>0</units> <lineBase>0</lineBase> <situation>0</situation> <cancelledUnits>0</cancelledUnits> <pendingUnits>0</pendingUnits> <confirmedUnits>0</confirmedUnits> <deliveredUnits>0</deliveredUnits> <billedUnits>0</billedUnits> </CircuitInfoDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseDeliveryNotes/new":{"get":{"tags":["purchaseDeliveryNotes"],"summary":"Get a new purchase delivery note with default values","description":"Get a new purchase delivery note with default values","operationId":"PurchaseDeliveryNotes_GetNew","parameters":[{"name":"supplierId","in":"query","description":"Supplier identifier","schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseDeliveryNoteDTO"},"example":{"id":"string","date":"string","receptionDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","operationTypeCode":"string","isTaxIncluded":true,"isTaxBaseAffected":true,"promptPaymentPercentage":0,"financialSurchargePercentage":0,"annotations":"string","taxBase":0,"totalTax":0,"total":0,"source":"string","sourceId":"string","version":"string","lines":[{"id":"string","description":"string","units":0,"servedUnits":0,"cancelledUnits":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","expenseTypeId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"billable":true,"situation":"string","totalPromptPayment":0,"totalFinancialSurcharge":0,"currency":"string","taxRetentionPercentage":0,"taxRetentionBase":0,"totalRetention":0,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseDeliveryNoteDTO"},"example":"<PurchaseDeliveryNoteDTO> <id>string</id> <date>string</date> <receptionDate>string</receptionDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <operationTypeCode>string</operationTypeCode> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <promptPaymentPercentage>0</promptPaymentPercentage> <financialSurchargePercentage>0</financialSurchargePercentage> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <total>0</total> <source>string</source> <sourceId>string</sourceId> <version>string</version> <lines> <id>string</id> <description>string</description> <units>0</units> <servedUnits>0</servedUnits> <cancelledUnits>0</cancelledUnits> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <expenseTypeId>string</expenseTypeId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <billable>true</billable> <situation>string</situation> <totalPromptPayment>0</totalPromptPayment> <totalFinancialSurcharge>0</totalFinancialSurcharge> <currency>string</currency> <taxRetentionPercentage>0</taxRetentionPercentage> <taxRetentionBase>0</taxRetentionBase> <totalRetention>0</totalRetention> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseDeliveryNoteDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseDeliveryNotes/{id}/pdf":{"get":{"tags":["purchaseDeliveryNotes"],"summary":"Get the pdf of the document","description":"Get the pdf of the document","operationId":"PurchaseDeliveryNotes_GetPdf","parameters":[{"name":"id","in":"path","description":"Document identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"templateId","in":"query","description":"Template identifier","schema":{"type":"integer","format":"int32","default":0}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/Response"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"404":{"description":"Not found","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/purchaseDeliveryNotes/{id}/line/{lineId}/documentlineinfo":{"get":{"tags":["purchaseDeliveryNotes"],"summary":"Get document line info","description":"Get document line info","operationId":"PurchaseDeliveryNotes_GetDocumentLineInfo","parameters":[{"name":"id","in":"path","description":"Document id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"lineId","in":"path","description":"Line id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentLineInfoDTOArray"},"example":[{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/DocumentLineInfoDTOArray"},"example":"<DocumentLineInfoDTOArray> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </DocumentLineInfoDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseDeliveryNotes/{id}/line/{lineId}/destinationdocumentscount":{"get":{"tags":["purchaseDeliveryNotes"],"summary":"Get destination documents count","description":"Get destination documents count","operationId":"PurchaseDeliveryNotes_DestinationDocumentsCount","parameters":[{"name":"id","in":"path","description":"Document id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"lineId","in":"path","description":"Line id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiPurchaseDeliveryNotesIdLineLineIdDestinationdocumentscountGet200Applicati"},"example":0},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiPurchaseDeliveryNotesIdLineLineIdDestinationdocumentscountGet200Applicati-2"},"example":"<ApiPurchaseDeliveryNotesIdLineLineIdDestinationdocumentscountGet200Applicati-2>0</ApiPurchaseDeliveryNotesIdLineLineIdDestinationdocumentscountGet200Applicati-2>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseDeliveryNotes/newLine":{"get":{"tags":["purchaseDeliveryNotes"],"summary":"Get a new purchase delivery note line with default values","description":"Get a new purchase delivery note line with default values","operationId":"PurchaseDeliveryNotes_GetNewLine","parameters":[{"name":"supplierId","in":"query","description":"Supplier identifier","schema":{"type":"string","format":"uuid"}},{"name":"productId","in":"query","description":"Product identifier","schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseDeliveryNoteDTO"},"example":{"id":"string","date":"string","receptionDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","operationTypeCode":"string","isTaxIncluded":true,"isTaxBaseAffected":true,"promptPaymentPercentage":0,"financialSurchargePercentage":0,"annotations":"string","taxBase":0,"totalTax":0,"total":0,"source":"string","sourceId":"string","version":"string","lines":[{"id":"string","description":"string","units":0,"servedUnits":0,"cancelledUnits":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","expenseTypeId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"billable":true,"situation":"string","totalPromptPayment":0,"totalFinancialSurcharge":0,"currency":"string","taxRetentionPercentage":0,"taxRetentionBase":0,"totalRetention":0,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseDeliveryNoteDTO"},"example":"<PurchaseDeliveryNoteDTO> <id>string</id> <date>string</date> <receptionDate>string</receptionDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <operationTypeCode>string</operationTypeCode> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <promptPaymentPercentage>0</promptPaymentPercentage> <financialSurchargePercentage>0</financialSurchargePercentage> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <total>0</total> <source>string</source> <sourceId>string</sourceId> <version>string</version> <lines> <id>string</id> <description>string</description> <units>0</units> <servedUnits>0</servedUnits> <cancelledUnits>0</cancelledUnits> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <expenseTypeId>string</expenseTypeId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <billable>true</billable> <situation>string</situation> <totalPromptPayment>0</totalPromptPayment> <totalFinancialSurcharge>0</totalFinancialSurcharge> <currency>string</currency> <taxRetentionPercentage>0</taxRetentionPercentage> <taxRetentionBase>0</taxRetentionBase> <totalRetention>0</totalRetention> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseDeliveryNoteDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseDeliveryNotes":{"get":{"tags":["purchaseDeliveryNotes"],"summary":"Get all purchase delivery notes","description":"Get all purchase delivery notes","operationId":"PurchaseDeliveryNotes_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlatPurchaseDeliveryNoteDTOArray"},"example":[{"id":"string","number":"string","date":"string","receptionDate":"string","reference":"string","supplierVATNumber":"string","supplierName":"string","email":"string","taxBase":0,"taxTotal":0,"total":0,"currency":"string","purchaseOperationTypeCode":"string","purchaseOperationTypeDescription":"string","situation":"string","billable":true,"source":"string","sourceId":"string","activityId":"string","activityDescription":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/FlatPurchaseDeliveryNoteDTOArray"},"example":"<FlatPurchaseDeliveryNoteDTOArray> <id>string</id> <number>string</number> <date>string</date> <receptionDate>string</receptionDate> <reference>string</reference> <supplierVATNumber>string</supplierVATNumber> <supplierName>string</supplierName> <email>string</email> <taxBase>0</taxBase> <taxTotal>0</taxTotal> <total>0</total> <currency>string</currency> <purchaseOperationTypeCode>string</purchaseOperationTypeCode> <purchaseOperationTypeDescription>string</purchaseOperationTypeDescription> <situation>string</situation> <billable>true</billable> <source>string</source> <sourceId>string</sourceId> <activityId>string</activityId> <activityDescription>string</activityDescription> </FlatPurchaseDeliveryNoteDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["purchaseDeliveryNotes"],"summary":"Update a purchase delivery note","description":"Update a purchase delivery note","operationId":"PurchaseDeliveryNotes_Put","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseDeliveryNoteDTO"},"example":{"id":"string","date":"string","receptionDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","operationTypeCode":"string","isTaxIncluded":true,"isTaxBaseAffected":true,"promptPaymentPercentage":0,"financialSurchargePercentage":0,"annotations":"string","taxBase":0,"totalTax":0,"total":0,"source":"string","sourceId":"string","version":"string","lines":[{"id":"string","description":"string","units":0,"servedUnits":0,"cancelledUnits":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","expenseTypeId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"billable":true,"situation":"string","totalPromptPayment":0,"totalFinancialSurcharge":0,"currency":"string","taxRetentionPercentage":0,"taxRetentionBase":0,"totalRetention":0,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"text/json":{"schema":{"$ref":"#/components/schemas/PurchaseDeliveryNoteDTO"},"example":{"id":"string","date":"string","receptionDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","operationTypeCode":"string","isTaxIncluded":true,"isTaxBaseAffected":true,"promptPaymentPercentage":0,"financialSurchargePercentage":0,"annotations":"string","taxBase":0,"totalTax":0,"total":0,"source":"string","sourceId":"string","version":"string","lines":[{"id":"string","description":"string","units":0,"servedUnits":0,"cancelledUnits":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","expenseTypeId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"billable":true,"situation":"string","totalPromptPayment":0,"totalFinancialSurcharge":0,"currency":"string","taxRetentionPercentage":0,"taxRetentionBase":0,"totalRetention":0,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"text/html":{"schema":{"$ref":"#/components/schemas/PurchaseDeliveryNoteDTO"},"example":"<PurchaseDeliveryNoteDTO> <id>string</id> <date>string</date> <receptionDate>string</receptionDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <operationTypeCode>string</operationTypeCode> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <promptPaymentPercentage>0</promptPaymentPercentage> <financialSurchargePercentage>0</financialSurchargePercentage> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <total>0</total> <source>string</source> <sourceId>string</sourceId> <version>string</version> <lines> <id>string</id> <description>string</description> <units>0</units> <servedUnits>0</servedUnits> <cancelledUnits>0</cancelledUnits> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <expenseTypeId>string</expenseTypeId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <billable>true</billable> <situation>string</situation> <totalPromptPayment>0</totalPromptPayment> <totalFinancialSurcharge>0</totalFinancialSurcharge> <currency>string</currency> <taxRetentionPercentage>0</taxRetentionPercentage> <taxRetentionBase>0</taxRetentionBase> <totalRetention>0</totalRetention> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseDeliveryNoteDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PurchaseDeliveryNoteDTO"},"example":{"id":"string","date":"string","receptionDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","operationTypeCode":"string","isTaxIncluded":true,"isTaxBaseAffected":true,"promptPaymentPercentage":0,"financialSurchargePercentage":0,"annotations":"string","taxBase":0,"totalTax":0,"total":0,"source":"string","sourceId":"string","version":"string","lines":[{"id":"string","description":"string","units":0,"servedUnits":0,"cancelledUnits":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","expenseTypeId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"billable":true,"situation":"string","totalPromptPayment":0,"totalFinancialSurcharge":0,"currency":"string","taxRetentionPercentage":0,"taxRetentionBase":0,"totalRetention":0,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseDeliveryNoteDTO"},"example":"<PurchaseDeliveryNoteDTO> <id>string</id> <date>string</date> <receptionDate>string</receptionDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <operationTypeCode>string</operationTypeCode> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <promptPaymentPercentage>0</promptPaymentPercentage> <financialSurchargePercentage>0</financialSurchargePercentage> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <total>0</total> <source>string</source> <sourceId>string</sourceId> <version>string</version> <lines> <id>string</id> <description>string</description> <units>0</units> <servedUnits>0</servedUnits> <cancelledUnits>0</cancelledUnits> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <expenseTypeId>string</expenseTypeId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <billable>true</billable> <situation>string</situation> <totalPromptPayment>0</totalPromptPayment> <totalFinancialSurcharge>0</totalFinancialSurcharge> <currency>string</currency> <taxRetentionPercentage>0</taxRetentionPercentage> <taxRetentionBase>0</taxRetentionBase> <totalRetention>0</totalRetention> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseDeliveryNoteDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PurchaseDeliveryNoteDTO"},"example":"<PurchaseDeliveryNoteDTO> <id>string</id> <date>string</date> <receptionDate>string</receptionDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <operationTypeCode>string</operationTypeCode> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <promptPaymentPercentage>0</promptPaymentPercentage> <financialSurchargePercentage>0</financialSurchargePercentage> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <total>0</total> <source>string</source> <sourceId>string</sourceId> <version>string</version> <lines> <id>string</id> <description>string</description> <units>0</units> <servedUnits>0</servedUnits> <cancelledUnits>0</cancelledUnits> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <expenseTypeId>string</expenseTypeId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <billable>true</billable> <situation>string</situation> <totalPromptPayment>0</totalPromptPayment> <totalFinancialSurcharge>0</totalFinancialSurcharge> <currency>string</currency> <taxRetentionPercentage>0</taxRetentionPercentage> <taxRetentionBase>0</taxRetentionBase> <totalRetention>0</totalRetention> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseDeliveryNoteDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["purchaseDeliveryNotes"],"summary":"Create a purchase delivery note","description":"Create a purchase delivery note","operationId":"PurchaseDeliveryNotes_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseDeliveryNoteDTO"},"example":{"id":"string","date":"string","receptionDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","operationTypeCode":"string","isTaxIncluded":true,"isTaxBaseAffected":true,"promptPaymentPercentage":0,"financialSurchargePercentage":0,"annotations":"string","taxBase":0,"totalTax":0,"total":0,"source":"string","sourceId":"string","version":"string","lines":[{"id":"string","description":"string","units":0,"servedUnits":0,"cancelledUnits":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","expenseTypeId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"billable":true,"situation":"string","totalPromptPayment":0,"totalFinancialSurcharge":0,"currency":"string","taxRetentionPercentage":0,"taxRetentionBase":0,"totalRetention":0,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"text/json":{"schema":{"$ref":"#/components/schemas/PurchaseDeliveryNoteDTO"},"example":{"id":"string","date":"string","receptionDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","operationTypeCode":"string","isTaxIncluded":true,"isTaxBaseAffected":true,"promptPaymentPercentage":0,"financialSurchargePercentage":0,"annotations":"string","taxBase":0,"totalTax":0,"total":0,"source":"string","sourceId":"string","version":"string","lines":[{"id":"string","description":"string","units":0,"servedUnits":0,"cancelledUnits":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","expenseTypeId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"billable":true,"situation":"string","totalPromptPayment":0,"totalFinancialSurcharge":0,"currency":"string","taxRetentionPercentage":0,"taxRetentionBase":0,"totalRetention":0,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"text/html":{"schema":{"$ref":"#/components/schemas/PurchaseDeliveryNoteDTO"},"example":"<PurchaseDeliveryNoteDTO> <id>string</id> <date>string</date> <receptionDate>string</receptionDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <operationTypeCode>string</operationTypeCode> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <promptPaymentPercentage>0</promptPaymentPercentage> <financialSurchargePercentage>0</financialSurchargePercentage> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <total>0</total> <source>string</source> <sourceId>string</sourceId> <version>string</version> <lines> <id>string</id> <description>string</description> <units>0</units> <servedUnits>0</servedUnits> <cancelledUnits>0</cancelledUnits> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <expenseTypeId>string</expenseTypeId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <billable>true</billable> <situation>string</situation> <totalPromptPayment>0</totalPromptPayment> <totalFinancialSurcharge>0</totalFinancialSurcharge> <currency>string</currency> <taxRetentionPercentage>0</taxRetentionPercentage> <taxRetentionBase>0</taxRetentionBase> <totalRetention>0</totalRetention> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseDeliveryNoteDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PurchaseDeliveryNoteDTO"},"example":{"id":"string","date":"string","receptionDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","operationTypeCode":"string","isTaxIncluded":true,"isTaxBaseAffected":true,"promptPaymentPercentage":0,"financialSurchargePercentage":0,"annotations":"string","taxBase":0,"totalTax":0,"total":0,"source":"string","sourceId":"string","version":"string","lines":[{"id":"string","description":"string","units":0,"servedUnits":0,"cancelledUnits":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","expenseTypeId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"billable":true,"situation":"string","totalPromptPayment":0,"totalFinancialSurcharge":0,"currency":"string","taxRetentionPercentage":0,"taxRetentionBase":0,"totalRetention":0,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseDeliveryNoteDTO"},"example":"<PurchaseDeliveryNoteDTO> <id>string</id> <date>string</date> <receptionDate>string</receptionDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <operationTypeCode>string</operationTypeCode> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <promptPaymentPercentage>0</promptPaymentPercentage> <financialSurchargePercentage>0</financialSurchargePercentage> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <total>0</total> <source>string</source> <sourceId>string</sourceId> <version>string</version> <lines> <id>string</id> <description>string</description> <units>0</units> <servedUnits>0</servedUnits> <cancelledUnits>0</cancelledUnits> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <expenseTypeId>string</expenseTypeId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <billable>true</billable> <situation>string</situation> <totalPromptPayment>0</totalPromptPayment> <totalFinancialSurcharge>0</totalFinancialSurcharge> <currency>string</currency> <taxRetentionPercentage>0</taxRetentionPercentage> <taxRetentionBase>0</taxRetentionBase> <totalRetention>0</totalRetention> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseDeliveryNoteDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PurchaseDeliveryNoteDTO"},"example":"<PurchaseDeliveryNoteDTO> <id>string</id> <date>string</date> <receptionDate>string</receptionDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <operationTypeCode>string</operationTypeCode> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <promptPaymentPercentage>0</promptPaymentPercentage> <financialSurchargePercentage>0</financialSurchargePercentage> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <total>0</total> <source>string</source> <sourceId>string</sourceId> <version>string</version> <lines> <id>string</id> <description>string</description> <units>0</units> <servedUnits>0</servedUnits> <cancelledUnits>0</cancelledUnits> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <expenseTypeId>string</expenseTypeId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <billable>true</billable> <situation>string</situation> <totalPromptPayment>0</totalPromptPayment> <totalFinancialSurcharge>0</totalFinancialSurcharge> <currency>string</currency> <taxRetentionPercentage>0</taxRetentionPercentage> <taxRetentionBase>0</taxRetentionBase> <totalRetention>0</totalRetention> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseDeliveryNoteDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseDeliveryNotes/export":{"get":{"tags":["purchaseDeliveryNotes"],"summary":"Export all purchase delivery notes with filters","description":"Export all purchase delivery notes with filters","operationId":"PurchaseDeliveryNotes_Export","parameters":[{"name":"format","in":"query","description":"Export format","schema":{"enum":["Excel"],"type":"string"}},{"name":"headers","in":"query","description":"Headers","schema":{"type":"string"}},{"name":"title","in":"query","description":"Title","schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiPurchaseDeliveryNotesExportGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiPurchaseDeliveryNotesExportGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/purchaseDeliveryNotes/pdf":{"post":{"tags":["purchaseDeliveryNotes"],"summary":"Print a collection of purchase delivery notes","description":"Print a collection of purchase delivery notes","operationId":"PurchaseDeliveryNotes_QueuePdfs","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":{"templateId":"string","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"text/json":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":{"templateId":"string","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"text/html":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":"<PrintCommand> <templateId>string</templateId> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </PrintCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":{"templateId":"string","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":"<PrintCommand> <templateId>string</templateId> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </PrintCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":"<PrintCommand> <templateId>string</templateId> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </PrintCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseDeliveryNotes/{id}/bill":{"post":{"tags":["purchaseDeliveryNotes"],"summary":"Bill purchase delivery note","description":"Bill purchase delivery note","operationId":"PurchaseDeliveryNotes_Bill","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"text/json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"text/html":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseDocuments/{id}":{"get":{"tags":["purchaseDocuments"],"summary":"Get a purchase document","description":"Get a purchase document","operationId":"PurchaseDocuments_GetById","parameters":[{"name":"id","in":"path","description":"purchase document identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseDocumentDTO"},"example":{"id":"string","documentType":0,"date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"source":"string","sourceId":"string","version":"string","isInmediatePayment":true,"hasAttachment":true,"isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","deductionDate":"string","duaNumber":"string","importSupplierId":"string","importTaxLines":[{"base":0,"taxType":"string","percentage":0,"total":0}],"lines":[{"id":"string","description":"string","units":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"annotations":"string","affectStock":true,"idFeePeriodLog":"string","additionalCost":0,"customProperties":[{"propertyName":"string","propertyValue":{}}],"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","rectifiedId":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","isMigrated":true,"hasPendingCostAllocationProcesses":true,"allocatedCostsDistributionCriteria":"string","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseDocumentDTO"},"example":"<PurchaseDocumentDTO> <id>string</id> <documentType>0</documentType> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isInmediatePayment>true</isInmediatePayment> <hasAttachment>true</hasAttachment> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <deductionDate>string</deductionDate> <duaNumber>string</duaNumber> <importSupplierId>string</importSupplierId> <importTaxLines> <base>0</base> <taxType>string</taxType> <percentage>0</percentage> <total>0</total> </importTaxLines> <lines> <id>string</id> <description>string</description> <units>0</units> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <annotations>string</annotations> <affectStock>true</affectStock> <idFeePeriodLog>string</idFeePeriodLog> <additionalCost>0</additionalCost> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <rectifiedId>string</rectifiedId> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <isMigrated>true</isMigrated> <hasPendingCostAllocationProcesses>true</hasPendingCostAllocationProcesses> <allocatedCostsDistributionCriteria>string</allocatedCostsDistributionCriteria> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseDocumentDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["purchaseDocuments"],"summary":"Delete a purchase document (supply or purchase)","description":"Delete a purchase document (supply or purchase)","operationId":"PurchaseDocuments_Delete","parameters":[{"name":"id","in":"path","description":"Purchase document identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseDocuments/{id}/dues":{"get":{"tags":["purchaseDocuments"],"summary":"Get the dues of a purchase document(supply or purchase)","description":"Get the dues of a purchase document(supply or purchase)","operationId":"PurchaseDocuments_GetDues","parameters":[{"name":"id","in":"path","description":"purchase document identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DueDTOArray"},"example":[{"id":"string","date":"string","chargeDate":"string","returnDate":"string","invoiceDate":"string","amount":0,"currency":"string","bankId":"string","payDocumentId":"string","payDocumentDescription":"string","payDocumentRemittable":true,"directDebitId":"string","state":0,"customerName":"string","customerDocument":"string","supplierDocument":"string","invoiceNumber":"string","directDebitBankAccount":"string","directDebitDescription":"string","directDebitSwift":"string","directDebitIsNacional":true,"customerTown":"string","customerCountry":"string","customerMainAddress":"string","customerPostalCode":"string","bankDescription":"string","remitted":true,"remittanceNumber":"string","mandateType":"string","mandateReference":"string","customerId":"string","invoiceId":"string","purchaseInvoiceId":"string","remittanceId":"string","parentDueId":"string","bankStatementCorrelationId":"string","purchaseReference":"string","journala3InnuvaId":"string","returnJournala3InnuvaId":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/DueDTOArray"},"example":"<DueDTOArray> <id>string</id> <date>string</date> <chargeDate>string</chargeDate> <returnDate>string</returnDate> <invoiceDate>string</invoiceDate> <amount>0</amount> <currency>string</currency> <bankId>string</bankId> <payDocumentId>string</payDocumentId> <payDocumentDescription>string</payDocumentDescription> <payDocumentRemittable>true</payDocumentRemittable> <directDebitId>string</directDebitId> <state>0</state> <customerName>string</customerName> <customerDocument>string</customerDocument> <supplierDocument>string</supplierDocument> <invoiceNumber>string</invoiceNumber> <directDebitBankAccount>string</directDebitBankAccount> <directDebitDescription>string</directDebitDescription> <directDebitSwift>string</directDebitSwift> <directDebitIsNacional>true</directDebitIsNacional> <customerTown>string</customerTown> <customerCountry>string</customerCountry> <customerMainAddress>string</customerMainAddress> <customerPostalCode>string</customerPostalCode> <bankDescription>string</bankDescription> <remitted>true</remitted> <remittanceNumber>string</remittanceNumber> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <customerId>string</customerId> <invoiceId>string</invoiceId> <purchaseInvoiceId>string</purchaseInvoiceId> <remittanceId>string</remittanceId> <parentDueId>string</parentDueId> <bankStatementCorrelationId>string</bankStatementCorrelationId> <purchaseReference>string</purchaseReference> <journala3InnuvaId>string</journala3InnuvaId> <returnJournala3InnuvaId>string</returnJournala3InnuvaId> </DueDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseDocuments/{id}/clone":{"get":{"tags":["purchaseDocuments"],"summary":"Get a clone of purchase document","description":"Get a clone of purchase document","operationId":"PurchaseDocuments_GetCloneById","parameters":[{"name":"id","in":"path","description":"Purchase document identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseDocumentDTO"},"example":{"id":"string","documentType":0,"date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"source":"string","sourceId":"string","version":"string","isInmediatePayment":true,"hasAttachment":true,"isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","deductionDate":"string","duaNumber":"string","importSupplierId":"string","importTaxLines":[{"base":0,"taxType":"string","percentage":0,"total":0}],"lines":[{"id":"string","description":"string","units":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"annotations":"string","affectStock":true,"idFeePeriodLog":"string","additionalCost":0,"customProperties":[{"propertyName":"string","propertyValue":{}}],"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","rectifiedId":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","isMigrated":true,"hasPendingCostAllocationProcesses":true,"allocatedCostsDistributionCriteria":"string","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseDocumentDTO"},"example":"<PurchaseDocumentDTO> <id>string</id> <documentType>0</documentType> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isInmediatePayment>true</isInmediatePayment> <hasAttachment>true</hasAttachment> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <deductionDate>string</deductionDate> <duaNumber>string</duaNumber> <importSupplierId>string</importSupplierId> <importTaxLines> <base>0</base> <taxType>string</taxType> <percentage>0</percentage> <total>0</total> </importTaxLines> <lines> <id>string</id> <description>string</description> <units>0</units> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <annotations>string</annotations> <affectStock>true</affectStock> <idFeePeriodLog>string</idFeePeriodLog> <additionalCost>0</additionalCost> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <rectifiedId>string</rectifiedId> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <isMigrated>true</isMigrated> <hasPendingCostAllocationProcesses>true</hasPendingCostAllocationProcesses> <allocatedCostsDistributionCriteria>string</allocatedCostsDistributionCriteria> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseDocumentDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseDocuments/{id}/rectify":{"get":{"tags":["purchaseDocuments"],"summary":"Get rectify invoice by purchase invoice","description":"Get rectify invoice by purchase invoice","operationId":"PurchaseDocuments_GetRectifyInvoiceById","parameters":[{"name":"id","in":"path","description":"Purchase invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseDocumentDTO"},"example":{"id":"string","documentType":0,"date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"source":"string","sourceId":"string","version":"string","isInmediatePayment":true,"hasAttachment":true,"isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","deductionDate":"string","duaNumber":"string","importSupplierId":"string","importTaxLines":[{"base":0,"taxType":"string","percentage":0,"total":0}],"lines":[{"id":"string","description":"string","units":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"annotations":"string","affectStock":true,"idFeePeriodLog":"string","additionalCost":0,"customProperties":[{"propertyName":"string","propertyValue":{}}],"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","rectifiedId":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","isMigrated":true,"hasPendingCostAllocationProcesses":true,"allocatedCostsDistributionCriteria":"string","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseDocumentDTO"},"example":"<PurchaseDocumentDTO> <id>string</id> <documentType>0</documentType> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isInmediatePayment>true</isInmediatePayment> <hasAttachment>true</hasAttachment> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <deductionDate>string</deductionDate> <duaNumber>string</duaNumber> <importSupplierId>string</importSupplierId> <importTaxLines> <base>0</base> <taxType>string</taxType> <percentage>0</percentage> <total>0</total> </importTaxLines> <lines> <id>string</id> <description>string</description> <units>0</units> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <annotations>string</annotations> <affectStock>true</affectStock> <idFeePeriodLog>string</idFeePeriodLog> <additionalCost>0</additionalCost> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <rectifiedId>string</rectifiedId> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <isMigrated>true</isMigrated> <hasPendingCostAllocationProcesses>true</hasPendingCostAllocationProcesses> <allocatedCostsDistributionCriteria>string</allocatedCostsDistributionCriteria> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseDocumentDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["purchaseDocuments"],"summary":"Rectify a purchase invoice","description":"Rectify a purchase invoice","operationId":"PurchaseDocuments_RectifyById","parameters":[{"name":"id","in":"path","description":"Purchase invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"201":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseDocuments/{id}/attachment":{"get":{"tags":["purchaseDocuments"],"summary":"Get purchase document file attachment","description":"Get purchase document file attachment","operationId":"PurchaseDocuments_GetAttachment","parameters":[{"name":"id","in":"path","description":"Purchase document identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiPurchaseDocumentsIdAttachmentGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"No content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiPurchaseDocumentsIdAttachmentGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"404":{"description":"Not found","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}},"post":{"tags":["purchaseDocuments"],"summary":"Post purchase document file attachment","description":"Post purchase document file attachment","operationId":"PurchaseDocuments_PostAttachment","parameters":[{"name":"id","in":"path","description":"Purchase document identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["uploadedFile"],"properties":{"uploadedFile":{"type":"array","description":"File to upload"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["purchaseDocuments"],"summary":"Deletes purchase document file attachment","description":"Deletes purchase document file attachment","operationId":"PurchaseDocuments_DeleteAttachment","parameters":[{"name":"id","in":"path","description":"Purchase document identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseDocuments/{id}/pdf":{"get":{"tags":["purchaseDocuments"],"summary":"Get the purchase invoice pdf","description":"Get the purchase invoice pdf","operationId":"PurchaseDocuments_GetPdf","parameters":[{"name":"id","in":"path","description":"Purchase invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"templateId","in":"query","description":"Template identifier","schema":{"type":"integer","format":"int32","default":0}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/Response"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/Response"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"404":{"description":"Not found","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/purchaseDocuments/newLine":{"get":{"tags":["purchaseDocuments"],"summary":"Get a new purchase document line with default values","description":"Get a new purchase document line with default values","operationId":"PurchaseDocuments_GetNewLine","parameters":[{"name":"supplierId","in":"query","description":"Supplier identifier","schema":{"type":"string","format":"uuid"}},{"name":"productId","in":"query","description":"Product identifier","schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseInvoiceLineDTO"},"example":{"id":"string","description":"string","units":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"annotations":"string","affectStock":true,"idFeePeriodLog":"string","additionalCost":0,"customProperties":[{"propertyName":"string","propertyValue":{}}],"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","rectifiedId":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseInvoiceLineDTO"},"example":"<PurchaseInvoiceLineDTO> <id>string</id> <description>string</description> <units>0</units> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <annotations>string</annotations> <affectStock>true</affectStock> <idFeePeriodLog>string</idFeePeriodLog> <additionalCost>0</additionalCost> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <rectifiedId>string</rectifiedId> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </PurchaseInvoiceLineDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseDocuments/new":{"get":{"tags":["purchaseDocuments"],"summary":"Get a new purchase document with default values","description":"Get a new purchase document with default values","operationId":"PurchaseDocuments_GetNew","parameters":[{"name":"documentType","in":"query","description":"Document Type: Invoice = 0, Supply = 1","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"supplierId","in":"query","description":"Supplier identifier","schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseDocumentDTO"},"example":{"id":"string","documentType":0,"date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"source":"string","sourceId":"string","version":"string","isInmediatePayment":true,"hasAttachment":true,"isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","deductionDate":"string","duaNumber":"string","importSupplierId":"string","importTaxLines":[{"base":0,"taxType":"string","percentage":0,"total":0}],"lines":[{"id":"string","description":"string","units":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"annotations":"string","affectStock":true,"idFeePeriodLog":"string","additionalCost":0,"customProperties":[{"propertyName":"string","propertyValue":{}}],"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","rectifiedId":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","isMigrated":true,"hasPendingCostAllocationProcesses":true,"allocatedCostsDistributionCriteria":"string","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseDocumentDTO"},"example":"<PurchaseDocumentDTO> <id>string</id> <documentType>0</documentType> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isInmediatePayment>true</isInmediatePayment> <hasAttachment>true</hasAttachment> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <deductionDate>string</deductionDate> <duaNumber>string</duaNumber> <importSupplierId>string</importSupplierId> <importTaxLines> <base>0</base> <taxType>string</taxType> <percentage>0</percentage> <total>0</total> </importTaxLines> <lines> <id>string</id> <description>string</description> <units>0</units> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <annotations>string</annotations> <affectStock>true</affectStock> <idFeePeriodLog>string</idFeePeriodLog> <additionalCost>0</additionalCost> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <rectifiedId>string</rectifiedId> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <isMigrated>true</isMigrated> <hasPendingCostAllocationProcesses>true</hasPendingCostAllocationProcesses> <allocatedCostsDistributionCriteria>string</allocatedCostsDistributionCriteria> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseDocumentDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseDocuments":{"get":{"tags":["purchaseDocuments"],"summary":"Get all purchase documents","description":"Get all purchase documents","operationId":"PurchaseDocuments_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlatPurchaseDocumentDTOArray"},"example":[{"id":"string","documentType":"string","purchaseKind":0,"number":"string","reference":"string","date":"string","accountingDate":"string","supplierId":"string","supplierVATNumber":"string","supplierName":"string","email":"string","taxBase":0,"taxTotal":0,"withholdingTotal":0,"total":0,"purchaseCurrency":"string","purchaseOperationTypeCode":"string","purchaseOperationTypeDescription":"string","invoiceType":"string","situation":0,"isInmediatePayment":true,"isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","hasAttachment":true,"hasAttachmentToExport":"string","activityId":"string","activityDescription":"string","isMigrated":true}]},"application/xml":{"schema":{"$ref":"#/components/schemas/FlatPurchaseDocumentDTOArray"},"example":"<FlatPurchaseDocumentDTOArray> <id>string</id> <documentType>string</documentType> <purchaseKind>0</purchaseKind> <number>string</number> <reference>string</reference> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <supplierVATNumber>string</supplierVATNumber> <supplierName>string</supplierName> <email>string</email> <taxBase>0</taxBase> <taxTotal>0</taxTotal> <withholdingTotal>0</withholdingTotal> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <purchaseOperationTypeCode>string</purchaseOperationTypeCode> <purchaseOperationTypeDescription>string</purchaseOperationTypeDescription> <invoiceType>string</invoiceType> <situation>0</situation> <isInmediatePayment>true</isInmediatePayment> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <hasAttachment>true</hasAttachment> <hasAttachmentToExport>string</hasAttachmentToExport> <activityId>string</activityId> <activityDescription>string</activityDescription> <isMigrated>true</isMigrated> </FlatPurchaseDocumentDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["purchaseDocuments"],"summary":"Update a purchase documents","description":"Update a purchase documents","operationId":"PurchaseDocuments_Put","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseDocumentDTO"},"example":{"id":"string","documentType":0,"date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"source":"string","sourceId":"string","version":"string","isInmediatePayment":true,"hasAttachment":true,"isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","deductionDate":"string","duaNumber":"string","importSupplierId":"string","importTaxLines":[{"base":0,"taxType":"string","percentage":0,"total":0}],"lines":[{"id":"string","description":"string","units":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"annotations":"string","affectStock":true,"idFeePeriodLog":"string","additionalCost":0,"customProperties":[{"propertyName":"string","propertyValue":{}}],"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","rectifiedId":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","isMigrated":true,"hasPendingCostAllocationProcesses":true,"allocatedCostsDistributionCriteria":"string","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"text/json":{"schema":{"$ref":"#/components/schemas/PurchaseDocumentDTO"},"example":{"id":"string","documentType":0,"date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"source":"string","sourceId":"string","version":"string","isInmediatePayment":true,"hasAttachment":true,"isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","deductionDate":"string","duaNumber":"string","importSupplierId":"string","importTaxLines":[{"base":0,"taxType":"string","percentage":0,"total":0}],"lines":[{"id":"string","description":"string","units":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"annotations":"string","affectStock":true,"idFeePeriodLog":"string","additionalCost":0,"customProperties":[{"propertyName":"string","propertyValue":{}}],"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","rectifiedId":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","isMigrated":true,"hasPendingCostAllocationProcesses":true,"allocatedCostsDistributionCriteria":"string","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"text/html":{"schema":{"$ref":"#/components/schemas/PurchaseDocumentDTO"},"example":"<PurchaseDocumentDTO> <id>string</id> <documentType>0</documentType> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isInmediatePayment>true</isInmediatePayment> <hasAttachment>true</hasAttachment> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <deductionDate>string</deductionDate> <duaNumber>string</duaNumber> <importSupplierId>string</importSupplierId> <importTaxLines> <base>0</base> <taxType>string</taxType> <percentage>0</percentage> <total>0</total> </importTaxLines> <lines> <id>string</id> <description>string</description> <units>0</units> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <annotations>string</annotations> <affectStock>true</affectStock> <idFeePeriodLog>string</idFeePeriodLog> <additionalCost>0</additionalCost> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <rectifiedId>string</rectifiedId> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <isMigrated>true</isMigrated> <hasPendingCostAllocationProcesses>true</hasPendingCostAllocationProcesses> <allocatedCostsDistributionCriteria>string</allocatedCostsDistributionCriteria> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseDocumentDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PurchaseDocumentDTO"},"example":{"id":"string","documentType":0,"date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"source":"string","sourceId":"string","version":"string","isInmediatePayment":true,"hasAttachment":true,"isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","deductionDate":"string","duaNumber":"string","importSupplierId":"string","importTaxLines":[{"base":0,"taxType":"string","percentage":0,"total":0}],"lines":[{"id":"string","description":"string","units":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"annotations":"string","affectStock":true,"idFeePeriodLog":"string","additionalCost":0,"customProperties":[{"propertyName":"string","propertyValue":{}}],"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","rectifiedId":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","isMigrated":true,"hasPendingCostAllocationProcesses":true,"allocatedCostsDistributionCriteria":"string","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseDocumentDTO"},"example":"<PurchaseDocumentDTO> <id>string</id> <documentType>0</documentType> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isInmediatePayment>true</isInmediatePayment> <hasAttachment>true</hasAttachment> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <deductionDate>string</deductionDate> <duaNumber>string</duaNumber> <importSupplierId>string</importSupplierId> <importTaxLines> <base>0</base> <taxType>string</taxType> <percentage>0</percentage> <total>0</total> </importTaxLines> <lines> <id>string</id> <description>string</description> <units>0</units> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <annotations>string</annotations> <affectStock>true</affectStock> <idFeePeriodLog>string</idFeePeriodLog> <additionalCost>0</additionalCost> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <rectifiedId>string</rectifiedId> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <isMigrated>true</isMigrated> <hasPendingCostAllocationProcesses>true</hasPendingCostAllocationProcesses> <allocatedCostsDistributionCriteria>string</allocatedCostsDistributionCriteria> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseDocumentDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PurchaseDocumentDTO"},"example":"<PurchaseDocumentDTO> <id>string</id> <documentType>0</documentType> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isInmediatePayment>true</isInmediatePayment> <hasAttachment>true</hasAttachment> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <deductionDate>string</deductionDate> <duaNumber>string</duaNumber> <importSupplierId>string</importSupplierId> <importTaxLines> <base>0</base> <taxType>string</taxType> <percentage>0</percentage> <total>0</total> </importTaxLines> <lines> <id>string</id> <description>string</description> <units>0</units> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <annotations>string</annotations> <affectStock>true</affectStock> <idFeePeriodLog>string</idFeePeriodLog> <additionalCost>0</additionalCost> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <rectifiedId>string</rectifiedId> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <isMigrated>true</isMigrated> <hasPendingCostAllocationProcesses>true</hasPendingCostAllocationProcesses> <allocatedCostsDistributionCriteria>string</allocatedCostsDistributionCriteria> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseDocumentDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["purchaseDocuments"],"summary":"Create a purchase invoice","description":"Create a purchase invoice","operationId":"PurchaseDocuments_Post","parameters":[{"name":"draftId","in":"query","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseDocumentDTO"},"example":{"id":"string","documentType":0,"date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"source":"string","sourceId":"string","version":"string","isInmediatePayment":true,"hasAttachment":true,"isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","deductionDate":"string","duaNumber":"string","importSupplierId":"string","importTaxLines":[{"base":0,"taxType":"string","percentage":0,"total":0}],"lines":[{"id":"string","description":"string","units":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"annotations":"string","affectStock":true,"idFeePeriodLog":"string","additionalCost":0,"customProperties":[{"propertyName":"string","propertyValue":{}}],"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","rectifiedId":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","isMigrated":true,"hasPendingCostAllocationProcesses":true,"allocatedCostsDistributionCriteria":"string","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"text/json":{"schema":{"$ref":"#/components/schemas/PurchaseDocumentDTO"},"example":{"id":"string","documentType":0,"date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"source":"string","sourceId":"string","version":"string","isInmediatePayment":true,"hasAttachment":true,"isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","deductionDate":"string","duaNumber":"string","importSupplierId":"string","importTaxLines":[{"base":0,"taxType":"string","percentage":0,"total":0}],"lines":[{"id":"string","description":"string","units":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"annotations":"string","affectStock":true,"idFeePeriodLog":"string","additionalCost":0,"customProperties":[{"propertyName":"string","propertyValue":{}}],"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","rectifiedId":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","isMigrated":true,"hasPendingCostAllocationProcesses":true,"allocatedCostsDistributionCriteria":"string","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"text/html":{"schema":{"$ref":"#/components/schemas/PurchaseDocumentDTO"},"example":"<PurchaseDocumentDTO> <id>string</id> <documentType>0</documentType> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isInmediatePayment>true</isInmediatePayment> <hasAttachment>true</hasAttachment> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <deductionDate>string</deductionDate> <duaNumber>string</duaNumber> <importSupplierId>string</importSupplierId> <importTaxLines> <base>0</base> <taxType>string</taxType> <percentage>0</percentage> <total>0</total> </importTaxLines> <lines> <id>string</id> <description>string</description> <units>0</units> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <annotations>string</annotations> <affectStock>true</affectStock> <idFeePeriodLog>string</idFeePeriodLog> <additionalCost>0</additionalCost> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <rectifiedId>string</rectifiedId> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <isMigrated>true</isMigrated> <hasPendingCostAllocationProcesses>true</hasPendingCostAllocationProcesses> <allocatedCostsDistributionCriteria>string</allocatedCostsDistributionCriteria> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseDocumentDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PurchaseDocumentDTO"},"example":{"id":"string","documentType":0,"date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"source":"string","sourceId":"string","version":"string","isInmediatePayment":true,"hasAttachment":true,"isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","deductionDate":"string","duaNumber":"string","importSupplierId":"string","importTaxLines":[{"base":0,"taxType":"string","percentage":0,"total":0}],"lines":[{"id":"string","description":"string","units":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"annotations":"string","affectStock":true,"idFeePeriodLog":"string","additionalCost":0,"customProperties":[{"propertyName":"string","propertyValue":{}}],"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","rectifiedId":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","isMigrated":true,"hasPendingCostAllocationProcesses":true,"allocatedCostsDistributionCriteria":"string","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseDocumentDTO"},"example":"<PurchaseDocumentDTO> <id>string</id> <documentType>0</documentType> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isInmediatePayment>true</isInmediatePayment> <hasAttachment>true</hasAttachment> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <deductionDate>string</deductionDate> <duaNumber>string</duaNumber> <importSupplierId>string</importSupplierId> <importTaxLines> <base>0</base> <taxType>string</taxType> <percentage>0</percentage> <total>0</total> </importTaxLines> <lines> <id>string</id> <description>string</description> <units>0</units> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <annotations>string</annotations> <affectStock>true</affectStock> <idFeePeriodLog>string</idFeePeriodLog> <additionalCost>0</additionalCost> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <rectifiedId>string</rectifiedId> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <isMigrated>true</isMigrated> <hasPendingCostAllocationProcesses>true</hasPendingCostAllocationProcesses> <allocatedCostsDistributionCriteria>string</allocatedCostsDistributionCriteria> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseDocumentDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PurchaseDocumentDTO"},"example":"<PurchaseDocumentDTO> <id>string</id> <documentType>0</documentType> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isInmediatePayment>true</isInmediatePayment> <hasAttachment>true</hasAttachment> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <deductionDate>string</deductionDate> <duaNumber>string</duaNumber> <importSupplierId>string</importSupplierId> <importTaxLines> <base>0</base> <taxType>string</taxType> <percentage>0</percentage> <total>0</total> </importTaxLines> <lines> <id>string</id> <description>string</description> <units>0</units> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <annotations>string</annotations> <affectStock>true</affectStock> <idFeePeriodLog>string</idFeePeriodLog> <additionalCost>0</additionalCost> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <rectifiedId>string</rectifiedId> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <isMigrated>true</isMigrated> <hasPendingCostAllocationProcesses>true</hasPendingCostAllocationProcesses> <allocatedCostsDistributionCriteria>string</allocatedCostsDistributionCriteria> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseDocumentDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseDocuments/export":{"get":{"tags":["purchaseDocuments"],"summary":"Purchase documents export","description":"Purchase documents export","operationId":"PurchaseDocuments_Export","parameters":[{"name":"format","in":"query","description":"Export format","schema":{"enum":["Excel"],"type":"string"}},{"name":"headers","in":"query","description":"Headers","schema":{"type":"string"}},{"name":"title","in":"query","description":"Title","schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiPurchaseDocumentsExportGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiPurchaseDocumentsExportGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/purchaseDocuments/extendedExport":{"get":{"tags":["purchaseDocuments"],"summary":"Export extended purchase documents","description":"Export extended purchase documents","operationId":"PurchaseDocuments_ExtendedExport","parameters":[{"name":"format","in":"query","description":"Export format","schema":{"enum":["Excel"],"type":"string"}},{"name":"headers","in":"query","description":"Headers","schema":{"type":"string"}},{"name":"title","in":"query","description":"Title","schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiPurchaseDocumentsExtendedExportGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiPurchaseDocumentsExtendedExportGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/purchaseDocuments/{id}/portfolio":{"put":{"tags":["purchaseDocuments"],"summary":"Update the portfolio of a purchase invoice","description":"Update the portfolio of a purchase invoice","operationId":"PurchaseDocuments_SavePortfolio","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioPurchaseInvoiceDTO"},"example":{"payments":[{"id":"string","date":"string","payDate":"string","invoiceDate":"string","amount":0,"currency":"string","bankId":"string","payDocumentId":"string","payDocumentDescription":"string","directDebitId":"string","state":0,"supplierName":"string","invoiceNumber":"string","supplierInvoiceNumber":"string","directDebitBankAccount":"string","directDebitDescription":"string","directDebitSwift":"string","directDebitIsNacional":true,"bankDescription":"string","supplierId":"string","invoiceId":"string","isInmediatePayment":true,"isMigrated":true,"journala3InnuvaId":"string","returnJournala3InnuvaId":"string","bankStatementCorrelationId":"string"}]}},"text/json":{"schema":{"$ref":"#/components/schemas/PortfolioPurchaseInvoiceDTO"},"example":{"payments":[{"id":"string","date":"string","payDate":"string","invoiceDate":"string","amount":0,"currency":"string","bankId":"string","payDocumentId":"string","payDocumentDescription":"string","directDebitId":"string","state":0,"supplierName":"string","invoiceNumber":"string","supplierInvoiceNumber":"string","directDebitBankAccount":"string","directDebitDescription":"string","directDebitSwift":"string","directDebitIsNacional":true,"bankDescription":"string","supplierId":"string","invoiceId":"string","isInmediatePayment":true,"isMigrated":true,"journala3InnuvaId":"string","returnJournala3InnuvaId":"string","bankStatementCorrelationId":"string"}]}},"text/html":{"schema":{"$ref":"#/components/schemas/PortfolioPurchaseInvoiceDTO"},"example":"<PortfolioPurchaseInvoiceDTO> <payments> <id>string</id> <date>string</date> <payDate>string</payDate> <invoiceDate>string</invoiceDate> <amount>0</amount> <currency>string</currency> <bankId>string</bankId> <payDocumentId>string</payDocumentId> <payDocumentDescription>string</payDocumentDescription> <directDebitId>string</directDebitId> <state>0</state> <supplierName>string</supplierName> <invoiceNumber>string</invoiceNumber> <supplierInvoiceNumber>string</supplierInvoiceNumber> <directDebitBankAccount>string</directDebitBankAccount> <directDebitDescription>string</directDebitDescription> <directDebitSwift>string</directDebitSwift> <directDebitIsNacional>true</directDebitIsNacional> <bankDescription>string</bankDescription> <supplierId>string</supplierId> <invoiceId>string</invoiceId> <isInmediatePayment>true</isInmediatePayment> <isMigrated>true</isMigrated> <journala3InnuvaId>string</journala3InnuvaId> <returnJournala3InnuvaId>string</returnJournala3InnuvaId> <bankStatementCorrelationId>string</bankStatementCorrelationId> </payments> </PortfolioPurchaseInvoiceDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PortfolioPurchaseInvoiceDTO"},"example":{"payments":[{"id":"string","date":"string","payDate":"string","invoiceDate":"string","amount":0,"currency":"string","bankId":"string","payDocumentId":"string","payDocumentDescription":"string","directDebitId":"string","state":0,"supplierName":"string","invoiceNumber":"string","supplierInvoiceNumber":"string","directDebitBankAccount":"string","directDebitDescription":"string","directDebitSwift":"string","directDebitIsNacional":true,"bankDescription":"string","supplierId":"string","invoiceId":"string","isInmediatePayment":true,"isMigrated":true,"journala3InnuvaId":"string","returnJournala3InnuvaId":"string","bankStatementCorrelationId":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/PortfolioPurchaseInvoiceDTO"},"example":"<PortfolioPurchaseInvoiceDTO> <payments> <id>string</id> <date>string</date> <payDate>string</payDate> <invoiceDate>string</invoiceDate> <amount>0</amount> <currency>string</currency> <bankId>string</bankId> <payDocumentId>string</payDocumentId> <payDocumentDescription>string</payDocumentDescription> <directDebitId>string</directDebitId> <state>0</state> <supplierName>string</supplierName> <invoiceNumber>string</invoiceNumber> <supplierInvoiceNumber>string</supplierInvoiceNumber> <directDebitBankAccount>string</directDebitBankAccount> <directDebitDescription>string</directDebitDescription> <directDebitSwift>string</directDebitSwift> <directDebitIsNacional>true</directDebitIsNacional> <bankDescription>string</bankDescription> <supplierId>string</supplierId> <invoiceId>string</invoiceId> <isInmediatePayment>true</isInmediatePayment> <isMigrated>true</isMigrated> <journala3InnuvaId>string</journala3InnuvaId> <returnJournala3InnuvaId>string</returnJournala3InnuvaId> <bankStatementCorrelationId>string</bankStatementCorrelationId> </payments> </PortfolioPurchaseInvoiceDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PortfolioPurchaseInvoiceDTO"},"example":"<PortfolioPurchaseInvoiceDTO> <payments> <id>string</id> <date>string</date> <payDate>string</payDate> <invoiceDate>string</invoiceDate> <amount>0</amount> <currency>string</currency> <bankId>string</bankId> <payDocumentId>string</payDocumentId> <payDocumentDescription>string</payDocumentDescription> <directDebitId>string</directDebitId> <state>0</state> <supplierName>string</supplierName> <invoiceNumber>string</invoiceNumber> <supplierInvoiceNumber>string</supplierInvoiceNumber> <directDebitBankAccount>string</directDebitBankAccount> <directDebitDescription>string</directDebitDescription> <directDebitSwift>string</directDebitSwift> <directDebitIsNacional>true</directDebitIsNacional> <bankDescription>string</bankDescription> <supplierId>string</supplierId> <invoiceId>string</invoiceId> <isInmediatePayment>true</isInmediatePayment> <isMigrated>true</isMigrated> <journala3InnuvaId>string</journala3InnuvaId> <returnJournala3InnuvaId>string</returnJournala3InnuvaId> <bankStatementCorrelationId>string</bankStatementCorrelationId> </payments> </PortfolioPurchaseInvoiceDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseDocuments/{id}/dues/{dueId}/pay":{"post":{"tags":["purchaseDocuments"],"summary":"Pay a due","description":"Pay a due","operationId":"PurchaseDocuments_Pay","parameters":[{"name":"id","in":"path","description":"purchase invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"dueId","in":"path","description":"due identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"payment command","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayCommand"},"example":{"date":"string","ammount":0,"bankId":"string","paymentDocumentId":"string","directDebitId":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/PayCommand"},"example":{"date":"string","ammount":0,"bankId":"string","paymentDocumentId":"string","directDebitId":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/PayCommand"},"example":"<PayCommand> <date>string</date> <ammount>0</ammount> <bankId>string</bankId> <paymentDocumentId>string</paymentDocumentId> <directDebitId>string</directDebitId> </PayCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PayCommand"},"example":{"date":"string","ammount":0,"bankId":"string","paymentDocumentId":"string","directDebitId":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PayCommand"},"example":"<PayCommand> <date>string</date> <ammount>0</ammount> <bankId>string</bankId> <paymentDocumentId>string</paymentDocumentId> <directDebitId>string</directDebitId> </PayCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PayCommand"},"example":"<PayCommand> <date>string</date> <ammount>0</ammount> <bankId>string</bankId> <paymentDocumentId>string</paymentDocumentId> <directDebitId>string</directDebitId> </PayCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseDocuments/{id}/dues/{dueId}/cancelPay":{"post":{"tags":["purchaseDocuments"],"summary":"Cancel a due payment","description":"Cancel a due payment","operationId":"PurchaseDocuments_CancelPay","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"dueId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseInvoices/{id}":{"get":{"tags":["purchaseInvoices"],"summary":"Get a purchase invoice","description":"Get a purchase invoice","operationId":"PurchaseInvoices_GetById","parameters":[{"name":"id","in":"path","description":"Purchase invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseInvoiceDTO"},"example":{"id":"string","date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"source":"string","sourceId":"string","version":"string","isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","deductionDate":"string","duaNumber":"string","importSupplierId":"string","importTaxLines":[{"base":0,"taxType":"string","percentage":0,"total":0}],"lines":[{"id":"string","description":"string","units":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"annotations":"string","affectStock":true,"idFeePeriodLog":"string","additionalCost":0,"customProperties":[{"propertyName":"string","propertyValue":{}}],"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","rectifiedId":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","isMigrated":true,"hasPendingCostAllocationProcesses":true,"allocatedCostsDistributionCriteria":"string","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseInvoiceDTO"},"example":"<PurchaseInvoiceDTO> <id>string</id> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <deductionDate>string</deductionDate> <duaNumber>string</duaNumber> <importSupplierId>string</importSupplierId> <importTaxLines> <base>0</base> <taxType>string</taxType> <percentage>0</percentage> <total>0</total> </importTaxLines> <lines> <id>string</id> <description>string</description> <units>0</units> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <annotations>string</annotations> <affectStock>true</affectStock> <idFeePeriodLog>string</idFeePeriodLog> <additionalCost>0</additionalCost> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <rectifiedId>string</rectifiedId> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <isMigrated>true</isMigrated> <hasPendingCostAllocationProcesses>true</hasPendingCostAllocationProcesses> <allocatedCostsDistributionCriteria>string</allocatedCostsDistributionCriteria> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseInvoiceDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["purchaseInvoices"],"summary":"Delete a purchase invoice","description":"Delete a purchase invoice","operationId":"PurchaseInvoices_Delete","parameters":[{"name":"id","in":"path","description":"Purchase invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseInvoices/{id}/dues":{"get":{"tags":["purchaseInvoices"],"summary":"Get the dues of a purchase invoice","description":"Get the dues of a purchase invoice","operationId":"PurchaseInvoices_GetDues","parameters":[{"name":"id","in":"path","description":"purchase invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentDTOArray"},"example":[{"id":"string","date":"string","payDate":"string","invoiceDate":"string","amount":0,"currency":"string","bankId":"string","payDocumentId":"string","payDocumentDescription":"string","directDebitId":"string","state":0,"supplierName":"string","invoiceNumber":"string","supplierInvoiceNumber":"string","directDebitBankAccount":"string","directDebitDescription":"string","directDebitSwift":"string","directDebitIsNacional":true,"bankDescription":"string","supplierId":"string","invoiceId":"string","isInmediatePayment":true,"isMigrated":true,"journala3InnuvaId":"string","returnJournala3InnuvaId":"string","bankStatementCorrelationId":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PaymentDTOArray"},"example":"<PaymentDTOArray> <id>string</id> <date>string</date> <payDate>string</payDate> <invoiceDate>string</invoiceDate> <amount>0</amount> <currency>string</currency> <bankId>string</bankId> <payDocumentId>string</payDocumentId> <payDocumentDescription>string</payDocumentDescription> <directDebitId>string</directDebitId> <state>0</state> <supplierName>string</supplierName> <invoiceNumber>string</invoiceNumber> <supplierInvoiceNumber>string</supplierInvoiceNumber> <directDebitBankAccount>string</directDebitBankAccount> <directDebitDescription>string</directDebitDescription> <directDebitSwift>string</directDebitSwift> <directDebitIsNacional>true</directDebitIsNacional> <bankDescription>string</bankDescription> <supplierId>string</supplierId> <invoiceId>string</invoiceId> <isInmediatePayment>true</isInmediatePayment> <isMigrated>true</isMigrated> <journala3InnuvaId>string</journala3InnuvaId> <returnJournala3InnuvaId>string</returnJournala3InnuvaId> <bankStatementCorrelationId>string</bankStatementCorrelationId> </PaymentDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseInvoices/{id}/rectify":{"get":{"tags":["purchaseInvoices"],"summary":"Get rectify invoice by purchase invoice","description":"Get rectify invoice by purchase invoice","operationId":"PurchaseInvoices_GetRectifyInvoiceById","parameters":[{"name":"id","in":"path","description":"Purchase invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseInvoiceDTO"},"example":{"id":"string","date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"source":"string","sourceId":"string","version":"string","isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","deductionDate":"string","duaNumber":"string","importSupplierId":"string","importTaxLines":[{"base":0,"taxType":"string","percentage":0,"total":0}],"lines":[{"id":"string","description":"string","units":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"annotations":"string","affectStock":true,"idFeePeriodLog":"string","additionalCost":0,"customProperties":[{"propertyName":"string","propertyValue":{}}],"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","rectifiedId":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","isMigrated":true,"hasPendingCostAllocationProcesses":true,"allocatedCostsDistributionCriteria":"string","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseInvoiceDTO"},"example":"<PurchaseInvoiceDTO> <id>string</id> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <deductionDate>string</deductionDate> <duaNumber>string</duaNumber> <importSupplierId>string</importSupplierId> <importTaxLines> <base>0</base> <taxType>string</taxType> <percentage>0</percentage> <total>0</total> </importTaxLines> <lines> <id>string</id> <description>string</description> <units>0</units> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <annotations>string</annotations> <affectStock>true</affectStock> <idFeePeriodLog>string</idFeePeriodLog> <additionalCost>0</additionalCost> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <rectifiedId>string</rectifiedId> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <isMigrated>true</isMigrated> <hasPendingCostAllocationProcesses>true</hasPendingCostAllocationProcesses> <allocatedCostsDistributionCriteria>string</allocatedCostsDistributionCriteria> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseInvoiceDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseInvoices/{id}/attachment":{"get":{"tags":["purchaseInvoices"],"summary":"Get purchase invoice file attachment","description":"Get purchase invoice file attachment","operationId":"PurchaseInvoices_GetAttachment","parameters":[{"name":"id","in":"path","description":"Purchase invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiPurchaseInvoicesIdAttachmentGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"No content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiPurchaseInvoicesIdAttachmentGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"404":{"description":"Not found","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}},"post":{"tags":["purchaseInvoices"],"summary":"Post purchase invoice file attachment","description":"Post purchase invoice file attachment","operationId":"PurchaseInvoices_PostAttachment","parameters":[{"name":"id","in":"path","description":"Purchase invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["uploadedFile"],"properties":{"uploadedFile":{"type":"array","description":"File to upload"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["purchaseInvoices"],"summary":"Deletes purchase invoice file attachment","description":"Deletes purchase invoice file attachment","operationId":"PurchaseInvoices_DeleteAttachment","parameters":[{"name":"id","in":"path","description":"Purchase invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseInvoices/additionaldata/regimes":{"get":{"tags":["purchaseInvoices"],"summary":"Get SII regimes types","description":"Get SII regimes types","operationId":"PurchaseInvoiceA_GetAllRegimeTypes","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiiRegimeTypeDTOArray"},"example":[{"code":"string","description":"string","orderUI":0,"correlationId":"00000000-0000-0000-0000-000000000000","isRectifying":true,"documentType":0}]},"application/xml":{"schema":{"$ref":"#/components/schemas/SiiRegimeTypeDTOArray"},"example":"<SiiRegimeTypeDTOArray> <code>string</code> <description>string</description> <orderUI>0</orderUI> <correlationId>00000000-0000-0000-0000-000000000000</correlationId> <isRectifying>true</isRectifying> <documentType>0</documentType> </SiiRegimeTypeDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseInvoices/additionaldata/invoices":{"get":{"tags":["purchaseInvoices"],"summary":"Get SII Invoice types","description":"Get SII Invoice types","operationId":"PurchaseInvoiceA_GetAllInvoiceType","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiiInvoiceTypeDTOArray"},"example":[{"code":"string","description":"string","orderUI":0,"correlationId":"00000000-0000-0000-0000-000000000000","isRectifying":true,"documentType":0}]},"application/xml":{"schema":{"$ref":"#/components/schemas/SiiInvoiceTypeDTOArray"},"example":"<SiiInvoiceTypeDTOArray> <code>string</code> <description>string</description> <orderUI>0</orderUI> <correlationId>00000000-0000-0000-0000-000000000000</correlationId> <isRectifying>true</isRectifying> <documentType>0</documentType> </SiiInvoiceTypeDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseInvoices/new":{"get":{"tags":["purchaseInvoices"],"summary":"Get a new purchase invoice with default values","description":"Get a new purchase invoice with default values","operationId":"PurchaseInvoices_GetNew","parameters":[{"name":"supplierId","in":"query","description":"Supplier identifier","schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseInvoiceDTO"},"example":{"id":"string","date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"source":"string","sourceId":"string","version":"string","isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","deductionDate":"string","duaNumber":"string","importSupplierId":"string","importTaxLines":[{"base":0,"taxType":"string","percentage":0,"total":0}],"lines":[{"id":"string","description":"string","units":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"annotations":"string","affectStock":true,"idFeePeriodLog":"string","additionalCost":0,"customProperties":[{"propertyName":"string","propertyValue":{}}],"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","rectifiedId":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","isMigrated":true,"hasPendingCostAllocationProcesses":true,"allocatedCostsDistributionCriteria":"string","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseInvoiceDTO"},"example":"<PurchaseInvoiceDTO> <id>string</id> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <deductionDate>string</deductionDate> <duaNumber>string</duaNumber> <importSupplierId>string</importSupplierId> <importTaxLines> <base>0</base> <taxType>string</taxType> <percentage>0</percentage> <total>0</total> </importTaxLines> <lines> <id>string</id> <description>string</description> <units>0</units> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <annotations>string</annotations> <affectStock>true</affectStock> <idFeePeriodLog>string</idFeePeriodLog> <additionalCost>0</additionalCost> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <rectifiedId>string</rectifiedId> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <isMigrated>true</isMigrated> <hasPendingCostAllocationProcesses>true</hasPendingCostAllocationProcesses> <allocatedCostsDistributionCriteria>string</allocatedCostsDistributionCriteria> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseInvoiceDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseInvoices/{id}/pdf":{"get":{"tags":["purchaseInvoices"],"summary":"Get the purchase invoice pdf","description":"Get the purchase invoice pdf","operationId":"PurchaseInvoices_GetPdf","parameters":[{"name":"id","in":"path","description":"Purchase invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"templateId","in":"query","description":"Template identifier","schema":{"type":"integer","format":"int32","default":0}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/Response"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/Response"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"404":{"description":"Not found","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/purchaseInvoices/newLine":{"get":{"tags":["purchaseInvoices"],"summary":"Get a new purchase invoice line with default values","description":"Get a new purchase invoice line with default values","operationId":"PurchaseInvoices_GetNewLine","parameters":[{"name":"supplierId","in":"query","description":"Supplier identifier","schema":{"type":"string","format":"uuid"}},{"name":"productId","in":"query","description":"Product identifier","schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseInvoiceLineDTO"},"example":{"id":"string","description":"string","units":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"annotations":"string","affectStock":true,"idFeePeriodLog":"string","additionalCost":0,"customProperties":[{"propertyName":"string","propertyValue":{}}],"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","rectifiedId":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseInvoiceLineDTO"},"example":"<PurchaseInvoiceLineDTO> <id>string</id> <description>string</description> <units>0</units> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <annotations>string</annotations> <affectStock>true</affectStock> <idFeePeriodLog>string</idFeePeriodLog> <additionalCost>0</additionalCost> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <rectifiedId>string</rectifiedId> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </PurchaseInvoiceLineDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseInvoices":{"get":{"tags":["purchaseInvoices"],"summary":"Get all purchase invoices","description":"Get all purchase invoices","operationId":"PurchaseInvoices_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlatPurchaseInvoiceDTOArray"},"example":[{"id":"string","number":"string","date":"string","accountingDate":"string","reference":"string","supplierId":"string","supplierVATNumber":"string","supplierName":"string","email":"string","taxBase":0,"taxTotal":0,"total":0,"purchaseCurrency":"string","purchaseOperationTypeCode":"string","purchaseOperationTypeDescription":"string","invoiceType":"string","situation":0,"isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","source":"string","sourceId":"string","isMigrated":true}]},"application/xml":{"schema":{"$ref":"#/components/schemas/FlatPurchaseInvoiceDTOArray"},"example":"<FlatPurchaseInvoiceDTOArray> <id>string</id> <number>string</number> <date>string</date> <accountingDate>string</accountingDate> <reference>string</reference> <supplierId>string</supplierId> <supplierVATNumber>string</supplierVATNumber> <supplierName>string</supplierName> <email>string</email> <taxBase>0</taxBase> <taxTotal>0</taxTotal> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <purchaseOperationTypeCode>string</purchaseOperationTypeCode> <purchaseOperationTypeDescription>string</purchaseOperationTypeDescription> <invoiceType>string</invoiceType> <situation>0</situation> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <source>string</source> <sourceId>string</sourceId> <isMigrated>true</isMigrated> </FlatPurchaseInvoiceDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["purchaseInvoices"],"summary":"Update a purchase invoice","description":"Update a purchase invoice","operationId":"PurchaseInvoices_Put","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseInvoiceDTO"},"example":{"id":"string","date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"source":"string","sourceId":"string","version":"string","isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","deductionDate":"string","duaNumber":"string","importSupplierId":"string","importTaxLines":[{"base":0,"taxType":"string","percentage":0,"total":0}],"lines":[{"id":"string","description":"string","units":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"annotations":"string","affectStock":true,"idFeePeriodLog":"string","additionalCost":0,"customProperties":[{"propertyName":"string","propertyValue":{}}],"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","rectifiedId":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","isMigrated":true,"hasPendingCostAllocationProcesses":true,"allocatedCostsDistributionCriteria":"string","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"text/json":{"schema":{"$ref":"#/components/schemas/PurchaseInvoiceDTO"},"example":{"id":"string","date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"source":"string","sourceId":"string","version":"string","isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","deductionDate":"string","duaNumber":"string","importSupplierId":"string","importTaxLines":[{"base":0,"taxType":"string","percentage":0,"total":0}],"lines":[{"id":"string","description":"string","units":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"annotations":"string","affectStock":true,"idFeePeriodLog":"string","additionalCost":0,"customProperties":[{"propertyName":"string","propertyValue":{}}],"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","rectifiedId":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","isMigrated":true,"hasPendingCostAllocationProcesses":true,"allocatedCostsDistributionCriteria":"string","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"text/html":{"schema":{"$ref":"#/components/schemas/PurchaseInvoiceDTO"},"example":"<PurchaseInvoiceDTO> <id>string</id> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <deductionDate>string</deductionDate> <duaNumber>string</duaNumber> <importSupplierId>string</importSupplierId> <importTaxLines> <base>0</base> <taxType>string</taxType> <percentage>0</percentage> <total>0</total> </importTaxLines> <lines> <id>string</id> <description>string</description> <units>0</units> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <annotations>string</annotations> <affectStock>true</affectStock> <idFeePeriodLog>string</idFeePeriodLog> <additionalCost>0</additionalCost> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <rectifiedId>string</rectifiedId> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <isMigrated>true</isMigrated> <hasPendingCostAllocationProcesses>true</hasPendingCostAllocationProcesses> <allocatedCostsDistributionCriteria>string</allocatedCostsDistributionCriteria> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseInvoiceDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PurchaseInvoiceDTO"},"example":{"id":"string","date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"source":"string","sourceId":"string","version":"string","isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","deductionDate":"string","duaNumber":"string","importSupplierId":"string","importTaxLines":[{"base":0,"taxType":"string","percentage":0,"total":0}],"lines":[{"id":"string","description":"string","units":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"annotations":"string","affectStock":true,"idFeePeriodLog":"string","additionalCost":0,"customProperties":[{"propertyName":"string","propertyValue":{}}],"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","rectifiedId":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","isMigrated":true,"hasPendingCostAllocationProcesses":true,"allocatedCostsDistributionCriteria":"string","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseInvoiceDTO"},"example":"<PurchaseInvoiceDTO> <id>string</id> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <deductionDate>string</deductionDate> <duaNumber>string</duaNumber> <importSupplierId>string</importSupplierId> <importTaxLines> <base>0</base> <taxType>string</taxType> <percentage>0</percentage> <total>0</total> </importTaxLines> <lines> <id>string</id> <description>string</description> <units>0</units> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <annotations>string</annotations> <affectStock>true</affectStock> <idFeePeriodLog>string</idFeePeriodLog> <additionalCost>0</additionalCost> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <rectifiedId>string</rectifiedId> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <isMigrated>true</isMigrated> <hasPendingCostAllocationProcesses>true</hasPendingCostAllocationProcesses> <allocatedCostsDistributionCriteria>string</allocatedCostsDistributionCriteria> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseInvoiceDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PurchaseInvoiceDTO"},"example":"<PurchaseInvoiceDTO> <id>string</id> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <deductionDate>string</deductionDate> <duaNumber>string</duaNumber> <importSupplierId>string</importSupplierId> <importTaxLines> <base>0</base> <taxType>string</taxType> <percentage>0</percentage> <total>0</total> </importTaxLines> <lines> <id>string</id> <description>string</description> <units>0</units> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <annotations>string</annotations> <affectStock>true</affectStock> <idFeePeriodLog>string</idFeePeriodLog> <additionalCost>0</additionalCost> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <rectifiedId>string</rectifiedId> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <isMigrated>true</isMigrated> <hasPendingCostAllocationProcesses>true</hasPendingCostAllocationProcesses> <allocatedCostsDistributionCriteria>string</allocatedCostsDistributionCriteria> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseInvoiceDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["purchaseInvoices"],"summary":"Create a purchase invoice","description":"Create a purchase invoice","operationId":"PurchaseInvoices_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseInvoiceDTO"},"example":{"id":"string","date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"source":"string","sourceId":"string","version":"string","isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","deductionDate":"string","duaNumber":"string","importSupplierId":"string","importTaxLines":[{"base":0,"taxType":"string","percentage":0,"total":0}],"lines":[{"id":"string","description":"string","units":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"annotations":"string","affectStock":true,"idFeePeriodLog":"string","additionalCost":0,"customProperties":[{"propertyName":"string","propertyValue":{}}],"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","rectifiedId":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","isMigrated":true,"hasPendingCostAllocationProcesses":true,"allocatedCostsDistributionCriteria":"string","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"text/json":{"schema":{"$ref":"#/components/schemas/PurchaseInvoiceDTO"},"example":{"id":"string","date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"source":"string","sourceId":"string","version":"string","isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","deductionDate":"string","duaNumber":"string","importSupplierId":"string","importTaxLines":[{"base":0,"taxType":"string","percentage":0,"total":0}],"lines":[{"id":"string","description":"string","units":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"annotations":"string","affectStock":true,"idFeePeriodLog":"string","additionalCost":0,"customProperties":[{"propertyName":"string","propertyValue":{}}],"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","rectifiedId":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","isMigrated":true,"hasPendingCostAllocationProcesses":true,"allocatedCostsDistributionCriteria":"string","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"text/html":{"schema":{"$ref":"#/components/schemas/PurchaseInvoiceDTO"},"example":"<PurchaseInvoiceDTO> <id>string</id> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <deductionDate>string</deductionDate> <duaNumber>string</duaNumber> <importSupplierId>string</importSupplierId> <importTaxLines> <base>0</base> <taxType>string</taxType> <percentage>0</percentage> <total>0</total> </importTaxLines> <lines> <id>string</id> <description>string</description> <units>0</units> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <annotations>string</annotations> <affectStock>true</affectStock> <idFeePeriodLog>string</idFeePeriodLog> <additionalCost>0</additionalCost> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <rectifiedId>string</rectifiedId> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <isMigrated>true</isMigrated> <hasPendingCostAllocationProcesses>true</hasPendingCostAllocationProcesses> <allocatedCostsDistributionCriteria>string</allocatedCostsDistributionCriteria> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseInvoiceDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PurchaseInvoiceDTO"},"example":{"id":"string","date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"source":"string","sourceId":"string","version":"string","isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","deductionDate":"string","duaNumber":"string","importSupplierId":"string","importTaxLines":[{"base":0,"taxType":"string","percentage":0,"total":0}],"lines":[{"id":"string","description":"string","units":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"annotations":"string","affectStock":true,"idFeePeriodLog":"string","additionalCost":0,"customProperties":[{"propertyName":"string","propertyValue":{}}],"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","packages":0,"bundles":0}],"priceOrigin":"string","discountOrigin":"string","rectifiedId":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","isMigrated":true,"hasPendingCostAllocationProcesses":true,"allocatedCostsDistributionCriteria":"string","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseInvoiceDTO"},"example":"<PurchaseInvoiceDTO> <id>string</id> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <deductionDate>string</deductionDate> <duaNumber>string</duaNumber> <importSupplierId>string</importSupplierId> <importTaxLines> <base>0</base> <taxType>string</taxType> <percentage>0</percentage> <total>0</total> </importTaxLines> <lines> <id>string</id> <description>string</description> <units>0</units> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <annotations>string</annotations> <affectStock>true</affectStock> <idFeePeriodLog>string</idFeePeriodLog> <additionalCost>0</additionalCost> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <rectifiedId>string</rectifiedId> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <isMigrated>true</isMigrated> <hasPendingCostAllocationProcesses>true</hasPendingCostAllocationProcesses> <allocatedCostsDistributionCriteria>string</allocatedCostsDistributionCriteria> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseInvoiceDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PurchaseInvoiceDTO"},"example":"<PurchaseInvoiceDTO> <id>string</id> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <deductionDate>string</deductionDate> <duaNumber>string</duaNumber> <importSupplierId>string</importSupplierId> <importTaxLines> <base>0</base> <taxType>string</taxType> <percentage>0</percentage> <total>0</total> </importTaxLines> <lines> <id>string</id> <description>string</description> <units>0</units> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <annotations>string</annotations> <affectStock>true</affectStock> <idFeePeriodLog>string</idFeePeriodLog> <additionalCost>0</additionalCost> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <traceabilityDetails> <id>string</id> <batch>string</batch> <expirationDate>string</expirationDate> <serialNumber>string</serialNumber> <units>0</units> <entryDate>string</entryDate> <packages>0</packages> <bundles>0</bundles> </traceabilityDetails> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <rectifiedId>string</rectifiedId> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <isMigrated>true</isMigrated> <hasPendingCostAllocationProcesses>true</hasPendingCostAllocationProcesses> <allocatedCostsDistributionCriteria>string</allocatedCostsDistributionCriteria> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseInvoiceDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseInvoices/{id}/portfolio":{"put":{"tags":["purchaseInvoices"],"summary":"Update the portfolio of a purchase invoice","description":"Update the portfolio of a purchase invoice","operationId":"PurchaseInvoices_SavePortfolio","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioPurchaseInvoiceDTO"},"example":{"payments":[{"id":"string","date":"string","payDate":"string","invoiceDate":"string","amount":0,"currency":"string","bankId":"string","payDocumentId":"string","payDocumentDescription":"string","directDebitId":"string","state":0,"supplierName":"string","invoiceNumber":"string","supplierInvoiceNumber":"string","directDebitBankAccount":"string","directDebitDescription":"string","directDebitSwift":"string","directDebitIsNacional":true,"bankDescription":"string","supplierId":"string","invoiceId":"string","isInmediatePayment":true,"isMigrated":true,"journala3InnuvaId":"string","returnJournala3InnuvaId":"string","bankStatementCorrelationId":"string"}]}},"text/json":{"schema":{"$ref":"#/components/schemas/PortfolioPurchaseInvoiceDTO"},"example":{"payments":[{"id":"string","date":"string","payDate":"string","invoiceDate":"string","amount":0,"currency":"string","bankId":"string","payDocumentId":"string","payDocumentDescription":"string","directDebitId":"string","state":0,"supplierName":"string","invoiceNumber":"string","supplierInvoiceNumber":"string","directDebitBankAccount":"string","directDebitDescription":"string","directDebitSwift":"string","directDebitIsNacional":true,"bankDescription":"string","supplierId":"string","invoiceId":"string","isInmediatePayment":true,"isMigrated":true,"journala3InnuvaId":"string","returnJournala3InnuvaId":"string","bankStatementCorrelationId":"string"}]}},"text/html":{"schema":{"$ref":"#/components/schemas/PortfolioPurchaseInvoiceDTO"},"example":"<PortfolioPurchaseInvoiceDTO> <payments> <id>string</id> <date>string</date> <payDate>string</payDate> <invoiceDate>string</invoiceDate> <amount>0</amount> <currency>string</currency> <bankId>string</bankId> <payDocumentId>string</payDocumentId> <payDocumentDescription>string</payDocumentDescription> <directDebitId>string</directDebitId> <state>0</state> <supplierName>string</supplierName> <invoiceNumber>string</invoiceNumber> <supplierInvoiceNumber>string</supplierInvoiceNumber> <directDebitBankAccount>string</directDebitBankAccount> <directDebitDescription>string</directDebitDescription> <directDebitSwift>string</directDebitSwift> <directDebitIsNacional>true</directDebitIsNacional> <bankDescription>string</bankDescription> <supplierId>string</supplierId> <invoiceId>string</invoiceId> <isInmediatePayment>true</isInmediatePayment> <isMigrated>true</isMigrated> <journala3InnuvaId>string</journala3InnuvaId> <returnJournala3InnuvaId>string</returnJournala3InnuvaId> <bankStatementCorrelationId>string</bankStatementCorrelationId> </payments> </PortfolioPurchaseInvoiceDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PortfolioPurchaseInvoiceDTO"},"example":{"payments":[{"id":"string","date":"string","payDate":"string","invoiceDate":"string","amount":0,"currency":"string","bankId":"string","payDocumentId":"string","payDocumentDescription":"string","directDebitId":"string","state":0,"supplierName":"string","invoiceNumber":"string","supplierInvoiceNumber":"string","directDebitBankAccount":"string","directDebitDescription":"string","directDebitSwift":"string","directDebitIsNacional":true,"bankDescription":"string","supplierId":"string","invoiceId":"string","isInmediatePayment":true,"isMigrated":true,"journala3InnuvaId":"string","returnJournala3InnuvaId":"string","bankStatementCorrelationId":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/PortfolioPurchaseInvoiceDTO"},"example":"<PortfolioPurchaseInvoiceDTO> <payments> <id>string</id> <date>string</date> <payDate>string</payDate> <invoiceDate>string</invoiceDate> <amount>0</amount> <currency>string</currency> <bankId>string</bankId> <payDocumentId>string</payDocumentId> <payDocumentDescription>string</payDocumentDescription> <directDebitId>string</directDebitId> <state>0</state> <supplierName>string</supplierName> <invoiceNumber>string</invoiceNumber> <supplierInvoiceNumber>string</supplierInvoiceNumber> <directDebitBankAccount>string</directDebitBankAccount> <directDebitDescription>string</directDebitDescription> <directDebitSwift>string</directDebitSwift> <directDebitIsNacional>true</directDebitIsNacional> <bankDescription>string</bankDescription> <supplierId>string</supplierId> <invoiceId>string</invoiceId> <isInmediatePayment>true</isInmediatePayment> <isMigrated>true</isMigrated> <journala3InnuvaId>string</journala3InnuvaId> <returnJournala3InnuvaId>string</returnJournala3InnuvaId> <bankStatementCorrelationId>string</bankStatementCorrelationId> </payments> </PortfolioPurchaseInvoiceDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PortfolioPurchaseInvoiceDTO"},"example":"<PortfolioPurchaseInvoiceDTO> <payments> <id>string</id> <date>string</date> <payDate>string</payDate> <invoiceDate>string</invoiceDate> <amount>0</amount> <currency>string</currency> <bankId>string</bankId> <payDocumentId>string</payDocumentId> <payDocumentDescription>string</payDocumentDescription> <directDebitId>string</directDebitId> <state>0</state> <supplierName>string</supplierName> <invoiceNumber>string</invoiceNumber> <supplierInvoiceNumber>string</supplierInvoiceNumber> <directDebitBankAccount>string</directDebitBankAccount> <directDebitDescription>string</directDebitDescription> <directDebitSwift>string</directDebitSwift> <directDebitIsNacional>true</directDebitIsNacional> <bankDescription>string</bankDescription> <supplierId>string</supplierId> <invoiceId>string</invoiceId> <isInmediatePayment>true</isInmediatePayment> <isMigrated>true</isMigrated> <journala3InnuvaId>string</journala3InnuvaId> <returnJournala3InnuvaId>string</returnJournala3InnuvaId> <bankStatementCorrelationId>string</bankStatementCorrelationId> </payments> </PortfolioPurchaseInvoiceDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseInvoices/{id}/dues/{dueId}/pay":{"post":{"tags":["purchaseInvoices"],"summary":"Pay a due","description":"Pay a due","operationId":"PurchaseInvoices_Pay","parameters":[{"name":"id","in":"path","description":"purchase invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"dueId","in":"path","description":"due identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"payment command","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayCommand"},"example":{"date":"string","ammount":0,"bankId":"string","paymentDocumentId":"string","directDebitId":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/PayCommand"},"example":{"date":"string","ammount":0,"bankId":"string","paymentDocumentId":"string","directDebitId":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/PayCommand"},"example":"<PayCommand> <date>string</date> <ammount>0</ammount> <bankId>string</bankId> <paymentDocumentId>string</paymentDocumentId> <directDebitId>string</directDebitId> </PayCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PayCommand"},"example":{"date":"string","ammount":0,"bankId":"string","paymentDocumentId":"string","directDebitId":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PayCommand"},"example":"<PayCommand> <date>string</date> <ammount>0</ammount> <bankId>string</bankId> <paymentDocumentId>string</paymentDocumentId> <directDebitId>string</directDebitId> </PayCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PayCommand"},"example":"<PayCommand> <date>string</date> <ammount>0</ammount> <bankId>string</bankId> <paymentDocumentId>string</paymentDocumentId> <directDebitId>string</directDebitId> </PayCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseInvoices/{id}/dues/{dueId}/cancelPay":{"post":{"tags":["purchaseInvoices"],"summary":"Cancel a due pay","description":"Cancel a due pay","operationId":"PurchaseInvoices_CancelPay","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"dueId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseOperationTypes":{"get":{"tags":["purchaseOperationTypes"],"summary":"Get all purchase operation types","description":"Get all purchase operation types","operationId":"PurchaseOperationTypes_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOperationTypeDTOArray"},"example":[{"code":"string","description":"string","applyTax":true,"applyEquivalenceSurcharge":true,"applyWithholdingAlsoOverTax":true,"addTaxToTotal":true}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseOperationTypeDTOArray"},"example":"<PurchaseOperationTypeDTOArray> <code>string</code> <description>string</description> <applyTax>true</applyTax> <applyEquivalenceSurcharge>true</applyEquivalenceSurcharge> <applyWithholdingAlsoOverTax>true</applyWithholdingAlsoOverTax> <addTaxToTotal>true</addTaxToTotal> </PurchaseOperationTypeDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseOrders/{id}":{"get":{"tags":["purchaseOrders"],"summary":"Get a purchase order by Id","description":"Get a purchase order by Id","operationId":"PurchaseOrders_GetById","parameters":[{"name":"id","in":"path","description":"Purchase order identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderDTO"},"example":{"id":"string","date":"string","deliveryDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","operationTypeCode":"string","isTaxIncluded":true,"isTaxBaseAffected":true,"promptPaymentPercentage":0,"financialSurchargePercentage":0,"annotations":"string","taxBase":0,"totalTax":0,"total":0,"source":"string","sourceId":"string","version":"string","lines":[{"id":"string","description":"string","units":0,"servedUnits":0,"cancelledUnits":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","expenseTypeId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","priceOrigin":"string","discountOrigin":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","totalPromptPayment":0,"totalFinancialSurcharge":0,"purchaseCurrency":"string","taxRetentionPercentage":0,"taxRetentionBase":0,"totalRetention":0,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseOrderDTO"},"example":"<PurchaseOrderDTO> <id>string</id> <date>string</date> <deliveryDate>string</deliveryDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <operationTypeCode>string</operationTypeCode> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <promptPaymentPercentage>0</promptPaymentPercentage> <financialSurchargePercentage>0</financialSurchargePercentage> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <total>0</total> <source>string</source> <sourceId>string</sourceId> <version>string</version> <lines> <id>string</id> <description>string</description> <units>0</units> <servedUnits>0</servedUnits> <cancelledUnits>0</cancelledUnits> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <expenseTypeId>string</expenseTypeId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <totalPromptPayment>0</totalPromptPayment> <totalFinancialSurcharge>0</totalFinancialSurcharge> <purchaseCurrency>string</purchaseCurrency> <taxRetentionPercentage>0</taxRetentionPercentage> <taxRetentionBase>0</taxRetentionBase> <totalRetention>0</totalRetention> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseOrderDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["purchaseOrders"],"summary":"Delete a purchase order","description":"Delete a purchase order","operationId":"PurchaseOrders_Delete","parameters":[{"name":"id","in":"path","description":"Purchase order identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseOrders/{id}/circuitinfo":{"get":{"tags":["purchaseOrders"],"summary":"Get circuit info lines","description":"Get circuit info lines","operationId":"PurchaseOrders_CircuitInfoLines","parameters":[{"name":"id","in":"path","description":"Circuit info lines","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CircuitInfoDTOArray"},"example":[{"lineId":"string","description":"string","units":0,"lineBase":0,"situation":0,"cancelledUnits":0,"pendingUnits":0,"confirmedUnits":0,"deliveredUnits":0,"billedUnits":0}]},"application/xml":{"schema":{"$ref":"#/components/schemas/CircuitInfoDTOArray"},"example":"<CircuitInfoDTOArray> <lineId>string</lineId> <description>string</description> <units>0</units> <lineBase>0</lineBase> <situation>0</situation> <cancelledUnits>0</cancelledUnits> <pendingUnits>0</pendingUnits> <confirmedUnits>0</confirmedUnits> <deliveredUnits>0</deliveredUnits> <billedUnits>0</billedUnits> </CircuitInfoDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseOrders/new":{"get":{"tags":["purchaseOrders"],"summary":"Get a new purchase order with default values","description":"Get a new purchase order with default values","operationId":"PurchaseOrders_GetNew","parameters":[{"name":"supplierId","in":"query","description":"Supplier identifier","schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderDTO"},"example":{"id":"string","date":"string","deliveryDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","operationTypeCode":"string","isTaxIncluded":true,"isTaxBaseAffected":true,"promptPaymentPercentage":0,"financialSurchargePercentage":0,"annotations":"string","taxBase":0,"totalTax":0,"total":0,"source":"string","sourceId":"string","version":"string","lines":[{"id":"string","description":"string","units":0,"servedUnits":0,"cancelledUnits":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","expenseTypeId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","priceOrigin":"string","discountOrigin":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","totalPromptPayment":0,"totalFinancialSurcharge":0,"purchaseCurrency":"string","taxRetentionPercentage":0,"taxRetentionBase":0,"totalRetention":0,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseOrderDTO"},"example":"<PurchaseOrderDTO> <id>string</id> <date>string</date> <deliveryDate>string</deliveryDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <operationTypeCode>string</operationTypeCode> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <promptPaymentPercentage>0</promptPaymentPercentage> <financialSurchargePercentage>0</financialSurchargePercentage> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <total>0</total> <source>string</source> <sourceId>string</sourceId> <version>string</version> <lines> <id>string</id> <description>string</description> <units>0</units> <servedUnits>0</servedUnits> <cancelledUnits>0</cancelledUnits> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <expenseTypeId>string</expenseTypeId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <totalPromptPayment>0</totalPromptPayment> <totalFinancialSurcharge>0</totalFinancialSurcharge> <purchaseCurrency>string</purchaseCurrency> <taxRetentionPercentage>0</taxRetentionPercentage> <taxRetentionBase>0</taxRetentionBase> <totalRetention>0</totalRetention> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseOrderDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseOrders/{id}/pdf":{"get":{"tags":["purchaseOrders"],"summary":"Get the pdf of the document","description":"Get the pdf of the document","operationId":"PurchaseOrders_GetPdf","parameters":[{"name":"id","in":"path","description":"Document identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"templateId","in":"query","description":"Template identifier","schema":{"type":"integer","format":"int32","default":0}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/Response"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"404":{"description":"Not found","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/purchaseOrders/{id}/line/{lineId}/documentlineinfo":{"get":{"tags":["purchaseOrders"],"summary":"Get document line info","description":"Get document line info","operationId":"PurchaseOrders_GetDocumentLineInfo","parameters":[{"name":"id","in":"path","description":"Document id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"lineId","in":"path","description":"Line id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentLineInfoDTOArray"},"example":[{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/DocumentLineInfoDTOArray"},"example":"<DocumentLineInfoDTOArray> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </DocumentLineInfoDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseOrders/{id}/line/{lineId}/destinationdocumentscount":{"get":{"tags":["purchaseOrders"],"summary":"Get destination documents count","description":"Get destination documents count","operationId":"PurchaseOrders_DestinationDocumentsCount","parameters":[{"name":"id","in":"path","description":"Document id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"lineId","in":"path","description":"Line id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiPurchaseOrdersIdLineLineIdDestinationdocumentscountGet200ApplicationJsonR"},"example":0},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiPurchaseOrdersIdLineLineIdDestinationdocumentscountGet200ApplicationXmlRe"},"example":"<ApiPurchaseOrdersIdLineLineIdDestinationdocumentscountGet200ApplicationXmlRe>0</ApiPurchaseOrdersIdLineLineIdDestinationdocumentscountGet200ApplicationXmlRe>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseOrders/newLine":{"get":{"tags":["purchaseOrders"],"summary":"Get a new purchase order line with default values","description":"Get a new purchase order line with default values","operationId":"PurchaseOrders_GetNewLine","parameters":[{"name":"supplierId","in":"query","description":"Supplier identifier","schema":{"type":"string","format":"uuid"}},{"name":"productId","in":"query","description":"Product identifier","schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderLineDTO"},"example":{"id":"string","description":"string","units":0,"servedUnits":0,"cancelledUnits":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","expenseTypeId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","priceOrigin":"string","discountOrigin":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseOrderLineDTO"},"example":"<PurchaseOrderLineDTO> <id>string</id> <description>string</description> <units>0</units> <servedUnits>0</servedUnits> <cancelledUnits>0</cancelledUnits> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <expenseTypeId>string</expenseTypeId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </PurchaseOrderLineDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseOrders":{"get":{"tags":["purchaseOrders"],"summary":"Get all purchase orders","description":"Get all purchase orders","operationId":"PurchaseOrders_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlatPurchaseOrderDTOArray"},"example":[{"id":"string","number":"string","date":"string","deliveryDate":"string","reference":"string","supplierVATNumber":"string","supplierName":"string","email":"string","taxBase":0,"taxTotal":0,"total":0,"currency":"string","purchaseOperationTypeCode":"string","purchaseOperationTypeDescription":"string","situation":"string","source":"string","sourceId":"string","activityId":"string","activityDescription":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/FlatPurchaseOrderDTOArray"},"example":"<FlatPurchaseOrderDTOArray> <id>string</id> <number>string</number> <date>string</date> <deliveryDate>string</deliveryDate> <reference>string</reference> <supplierVATNumber>string</supplierVATNumber> <supplierName>string</supplierName> <email>string</email> <taxBase>0</taxBase> <taxTotal>0</taxTotal> <total>0</total> <currency>string</currency> <purchaseOperationTypeCode>string</purchaseOperationTypeCode> <purchaseOperationTypeDescription>string</purchaseOperationTypeDescription> <situation>string</situation> <source>string</source> <sourceId>string</sourceId> <activityId>string</activityId> <activityDescription>string</activityDescription> </FlatPurchaseOrderDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["purchaseOrders"],"summary":"Update a purchase order","description":"Update a purchase order","operationId":"PurchaseOrders_Put","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderDTO"},"example":{"id":"string","date":"string","deliveryDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","operationTypeCode":"string","isTaxIncluded":true,"isTaxBaseAffected":true,"promptPaymentPercentage":0,"financialSurchargePercentage":0,"annotations":"string","taxBase":0,"totalTax":0,"total":0,"source":"string","sourceId":"string","version":"string","lines":[{"id":"string","description":"string","units":0,"servedUnits":0,"cancelledUnits":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","expenseTypeId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","priceOrigin":"string","discountOrigin":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","totalPromptPayment":0,"totalFinancialSurcharge":0,"purchaseCurrency":"string","taxRetentionPercentage":0,"taxRetentionBase":0,"totalRetention":0,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"text/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderDTO"},"example":{"id":"string","date":"string","deliveryDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","operationTypeCode":"string","isTaxIncluded":true,"isTaxBaseAffected":true,"promptPaymentPercentage":0,"financialSurchargePercentage":0,"annotations":"string","taxBase":0,"totalTax":0,"total":0,"source":"string","sourceId":"string","version":"string","lines":[{"id":"string","description":"string","units":0,"servedUnits":0,"cancelledUnits":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","expenseTypeId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","priceOrigin":"string","discountOrigin":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","totalPromptPayment":0,"totalFinancialSurcharge":0,"purchaseCurrency":"string","taxRetentionPercentage":0,"taxRetentionBase":0,"totalRetention":0,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"text/html":{"schema":{"$ref":"#/components/schemas/PurchaseOrderDTO"},"example":"<PurchaseOrderDTO> <id>string</id> <date>string</date> <deliveryDate>string</deliveryDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <operationTypeCode>string</operationTypeCode> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <promptPaymentPercentage>0</promptPaymentPercentage> <financialSurchargePercentage>0</financialSurchargePercentage> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <total>0</total> <source>string</source> <sourceId>string</sourceId> <version>string</version> <lines> <id>string</id> <description>string</description> <units>0</units> <servedUnits>0</servedUnits> <cancelledUnits>0</cancelledUnits> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <expenseTypeId>string</expenseTypeId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <totalPromptPayment>0</totalPromptPayment> <totalFinancialSurcharge>0</totalFinancialSurcharge> <purchaseCurrency>string</purchaseCurrency> <taxRetentionPercentage>0</taxRetentionPercentage> <taxRetentionBase>0</taxRetentionBase> <totalRetention>0</totalRetention> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseOrderDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderDTO"},"example":{"id":"string","date":"string","deliveryDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","operationTypeCode":"string","isTaxIncluded":true,"isTaxBaseAffected":true,"promptPaymentPercentage":0,"financialSurchargePercentage":0,"annotations":"string","taxBase":0,"totalTax":0,"total":0,"source":"string","sourceId":"string","version":"string","lines":[{"id":"string","description":"string","units":0,"servedUnits":0,"cancelledUnits":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","expenseTypeId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","priceOrigin":"string","discountOrigin":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","totalPromptPayment":0,"totalFinancialSurcharge":0,"purchaseCurrency":"string","taxRetentionPercentage":0,"taxRetentionBase":0,"totalRetention":0,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseOrderDTO"},"example":"<PurchaseOrderDTO> <id>string</id> <date>string</date> <deliveryDate>string</deliveryDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <operationTypeCode>string</operationTypeCode> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <promptPaymentPercentage>0</promptPaymentPercentage> <financialSurchargePercentage>0</financialSurchargePercentage> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <total>0</total> <source>string</source> <sourceId>string</sourceId> <version>string</version> <lines> <id>string</id> <description>string</description> <units>0</units> <servedUnits>0</servedUnits> <cancelledUnits>0</cancelledUnits> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <expenseTypeId>string</expenseTypeId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <totalPromptPayment>0</totalPromptPayment> <totalFinancialSurcharge>0</totalFinancialSurcharge> <purchaseCurrency>string</purchaseCurrency> <taxRetentionPercentage>0</taxRetentionPercentage> <taxRetentionBase>0</taxRetentionBase> <totalRetention>0</totalRetention> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseOrderDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PurchaseOrderDTO"},"example":"<PurchaseOrderDTO> <id>string</id> <date>string</date> <deliveryDate>string</deliveryDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <operationTypeCode>string</operationTypeCode> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <promptPaymentPercentage>0</promptPaymentPercentage> <financialSurchargePercentage>0</financialSurchargePercentage> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <total>0</total> <source>string</source> <sourceId>string</sourceId> <version>string</version> <lines> <id>string</id> <description>string</description> <units>0</units> <servedUnits>0</servedUnits> <cancelledUnits>0</cancelledUnits> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <expenseTypeId>string</expenseTypeId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <totalPromptPayment>0</totalPromptPayment> <totalFinancialSurcharge>0</totalFinancialSurcharge> <purchaseCurrency>string</purchaseCurrency> <taxRetentionPercentage>0</taxRetentionPercentage> <taxRetentionBase>0</taxRetentionBase> <totalRetention>0</totalRetention> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseOrderDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["purchaseOrders"],"summary":"Create a purchase order","description":"Create a purchase order","operationId":"PurchaseOrders_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderDTO"},"example":{"id":"string","date":"string","deliveryDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","operationTypeCode":"string","isTaxIncluded":true,"isTaxBaseAffected":true,"promptPaymentPercentage":0,"financialSurchargePercentage":0,"annotations":"string","taxBase":0,"totalTax":0,"total":0,"source":"string","sourceId":"string","version":"string","lines":[{"id":"string","description":"string","units":0,"servedUnits":0,"cancelledUnits":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","expenseTypeId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","priceOrigin":"string","discountOrigin":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","totalPromptPayment":0,"totalFinancialSurcharge":0,"purchaseCurrency":"string","taxRetentionPercentage":0,"taxRetentionBase":0,"totalRetention":0,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"text/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderDTO"},"example":{"id":"string","date":"string","deliveryDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","operationTypeCode":"string","isTaxIncluded":true,"isTaxBaseAffected":true,"promptPaymentPercentage":0,"financialSurchargePercentage":0,"annotations":"string","taxBase":0,"totalTax":0,"total":0,"source":"string","sourceId":"string","version":"string","lines":[{"id":"string","description":"string","units":0,"servedUnits":0,"cancelledUnits":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","expenseTypeId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","priceOrigin":"string","discountOrigin":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","totalPromptPayment":0,"totalFinancialSurcharge":0,"purchaseCurrency":"string","taxRetentionPercentage":0,"taxRetentionBase":0,"totalRetention":0,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"text/html":{"schema":{"$ref":"#/components/schemas/PurchaseOrderDTO"},"example":"<PurchaseOrderDTO> <id>string</id> <date>string</date> <deliveryDate>string</deliveryDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <operationTypeCode>string</operationTypeCode> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <promptPaymentPercentage>0</promptPaymentPercentage> <financialSurchargePercentage>0</financialSurchargePercentage> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <total>0</total> <source>string</source> <sourceId>string</sourceId> <version>string</version> <lines> <id>string</id> <description>string</description> <units>0</units> <servedUnits>0</servedUnits> <cancelledUnits>0</cancelledUnits> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <expenseTypeId>string</expenseTypeId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <totalPromptPayment>0</totalPromptPayment> <totalFinancialSurcharge>0</totalFinancialSurcharge> <purchaseCurrency>string</purchaseCurrency> <taxRetentionPercentage>0</taxRetentionPercentage> <taxRetentionBase>0</taxRetentionBase> <totalRetention>0</totalRetention> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseOrderDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderDTO"},"example":{"id":"string","date":"string","deliveryDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","operationTypeCode":"string","isTaxIncluded":true,"isTaxBaseAffected":true,"promptPaymentPercentage":0,"financialSurchargePercentage":0,"annotations":"string","taxBase":0,"totalTax":0,"total":0,"source":"string","sourceId":"string","version":"string","lines":[{"id":"string","description":"string","units":0,"servedUnits":0,"cancelledUnits":0,"price":0,"discountRate1":0,"productId":"string","productCode":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","expenseTypeId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","sourceDocument":{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"},"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","priceOrigin":"string","discountOrigin":"string","supplierProductReferenceCode":"string","supplierProductReferenceDescription":"string"}],"customProperties":[{"propertyName":"string","propertyValue":{}}],"situation":"string","totalPromptPayment":0,"totalFinancialSurcharge":0,"purchaseCurrency":"string","taxRetentionPercentage":0,"taxRetentionBase":0,"totalRetention":0,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","rateId":"00000000-0000-0000-0000-000000000000","discountId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseOrderDTO"},"example":"<PurchaseOrderDTO> <id>string</id> <date>string</date> <deliveryDate>string</deliveryDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <operationTypeCode>string</operationTypeCode> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <promptPaymentPercentage>0</promptPaymentPercentage> <financialSurchargePercentage>0</financialSurchargePercentage> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <total>0</total> <source>string</source> <sourceId>string</sourceId> <version>string</version> <lines> <id>string</id> <description>string</description> <units>0</units> <servedUnits>0</servedUnits> <cancelledUnits>0</cancelledUnits> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <expenseTypeId>string</expenseTypeId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <totalPromptPayment>0</totalPromptPayment> <totalFinancialSurcharge>0</totalFinancialSurcharge> <purchaseCurrency>string</purchaseCurrency> <taxRetentionPercentage>0</taxRetentionPercentage> <taxRetentionBase>0</taxRetentionBase> <totalRetention>0</totalRetention> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseOrderDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PurchaseOrderDTO"},"example":"<PurchaseOrderDTO> <id>string</id> <date>string</date> <deliveryDate>string</deliveryDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <operationTypeCode>string</operationTypeCode> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <promptPaymentPercentage>0</promptPaymentPercentage> <financialSurchargePercentage>0</financialSurchargePercentage> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <total>0</total> <source>string</source> <sourceId>string</sourceId> <version>string</version> <lines> <id>string</id> <description>string</description> <units>0</units> <servedUnits>0</servedUnits> <cancelledUnits>0</cancelledUnits> <price>0</price> <discountRate1>0</discountRate1> <productId>string</productId> <productCode>string</productCode> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <expenseTypeId>string</expenseTypeId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <sourceDocument> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </sourceDocument> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <priceOrigin>string</priceOrigin> <discountOrigin>string</discountOrigin> <supplierProductReferenceCode>string</supplierProductReferenceCode> <supplierProductReferenceDescription>string</supplierProductReferenceDescription> </lines> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <situation>string</situation> <totalPromptPayment>0</totalPromptPayment> <totalFinancialSurcharge>0</totalFinancialSurcharge> <purchaseCurrency>string</purchaseCurrency> <taxRetentionPercentage>0</taxRetentionPercentage> <taxRetentionBase>0</taxRetentionBase> <totalRetention>0</totalRetention> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <rateId>00000000-0000-0000-0000-000000000000</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </PurchaseOrderDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseOrders/export":{"get":{"tags":["purchaseOrders"],"summary":"Purchase orders export","description":"Purchase orders export","operationId":"PurchaseOrders_Export","parameters":[{"name":"format","in":"query","description":"Export format","schema":{"enum":["Excel"],"type":"string"}},{"name":"headers","in":"query","description":"Headers","schema":{"type":"string"}},{"name":"title","in":"query","description":"Title","schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiPurchaseOrdersExportGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiPurchaseOrdersExportGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/purchaseOrders/pdf":{"post":{"tags":["purchaseOrders"],"summary":"Print a collection of purchase orders","description":"Print a collection of purchase orders","operationId":"PurchaseOrders_QueuePdfs","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":{"templateId":"string","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"text/json":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":{"templateId":"string","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"text/html":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":"<PrintCommand> <templateId>string</templateId> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </PrintCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":{"templateId":"string","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":"<PrintCommand> <templateId>string</templateId> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </PrintCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":"<PrintCommand> <templateId>string</templateId> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </PrintCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/purchaseOrders/{id}/receive":{"post":{"tags":["purchaseOrders"],"summary":"Receive purchase order","description":"Receive purchase order","operationId":"PurchaseOrders_Receive","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"text/json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"text/html":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/queuedReports/generate":{"post":{"tags":["queuedReports"],"summary":"Generate Report","description":"Generate Report","operationId":"QueuedReports_GenerateReport","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"List of parameters to configure the report","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportRequest"},"example":{"template":"string","parameters":[{"name":"string","value":{}}]}},"text/json":{"schema":{"$ref":"#/components/schemas/ReportRequest"},"example":{"template":"string","parameters":[{"name":"string","value":{}}]}},"text/html":{"schema":{"$ref":"#/components/schemas/ReportRequest"},"example":"<ReportRequest> <template>string</template> <parameters> <name>string</name> <value /> </parameters> </ReportRequest>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ReportRequest"},"example":{"template":"string","parameters":[{"name":"string","value":{}}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/ReportRequest"},"example":"<ReportRequest> <template>string</template> <parameters> <name>string</name> <value /> </parameters> </ReportRequest>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ReportRequest"},"example":"<ReportRequest> <template>string</template> <parameters> <name>string</name> <value /> </parameters> </ReportRequest>"},"application/x-www-form-urlencoded":{}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/queueProcess/processmigration":{"get":{"tags":["queueProcess"],"summary":"QueueProcess_GetProcessMigration","operationId":"QueueProcess_GetProcessMigration","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MigrationMonitoringDtoArray"},"example":[{"description":"string","current":"string","total":"string","state":0}]},"application/xml":{"schema":{"$ref":"#/components/schemas/MigrationMonitoringDtoArray"},"example":"<MigrationMonitoringDtoArray> <description>string</description> <current>string</current> <total>string</total> <state>0</state> </MigrationMonitoringDtoArray>"}}}}}},"/api/rates/{id}":{"get":{"tags":["rates"],"summary":"Get a rate by identifier","description":"Get a rate by identifier","operationId":"Rates_GetById","parameters":[{"name":"id","in":"path","description":"Rate identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateDTO"},"example":{"id":"string","code":"string","description":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RateDTO"},"example":"<RateDTO> <id>string</id> <code>string</code> <description>string</description> </RateDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["rates"],"summary":"Delete a rate by identifier","description":"Delete a rate by identifier","operationId":"Rates_Delete","parameters":[{"name":"id","in":"path","description":"Rate identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"patch":{"tags":["rates"],"summary":"Update a rate by identifier","description":"Update a rate by identifier","operationId":"Rates_Patch","parameters":[{"name":"id","in":"path","description":"Rate identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Collection of {a3ERP.Public.Resources.V2.PatchOperation}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/html":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/rates":{"get":{"tags":["rates"],"summary":"Get all rates","description":"Get all rates","operationId":"Rates_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateDTOArray"},"example":[{"id":"string","code":"string","description":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/RateDTOArray"},"example":"<RateDTOArray> <id>string</id> <code>string</code> <description>string</description> </RateDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["rates"],"summary":"Add a new rate","description":"Add a new rate","operationId":"Rates_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Rate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateDTO"},"example":{"id":"string","code":"string","description":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/RateDTO"},"example":{"id":"string","code":"string","description":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/RateDTO"},"example":"<RateDTO> <id>string</id> <code>string</code> <description>string</description> </RateDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/RateDTO"},"example":{"id":"string","code":"string","description":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RateDTO"},"example":"<RateDTO> <id>string</id> <code>string</code> <description>string</description> </RateDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/RateDTO"},"example":"<RateDTO> <id>string</id> <code>string</code> <description>string</description> </RateDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Created","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/registeredInvoices/{id}/xml":{"get":{"tags":["registeredInvoices"],"summary":"Get the xml of the registered invoice","description":"Get the xml of the registered invoice","operationId":"RegisteredInvoices_GetXml","parameters":[{"name":"id","in":"path","description":"Registered invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/Response"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"404":{"description":"Not found","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/registeredInvoices/{id}/footPrint":{"get":{"tags":["registeredInvoices"],"summary":"Get Qr of a resgistered invoice","description":"Get Qr of a resgistered invoice","operationId":"RegisteredInvoices_GetAntifraudLawFootPrintById","parameters":[{"name":"id","in":"path","description":"Antifraud identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AntifraudLawFootPrintDTO"},"example":{"identifier":"string","qrImage":[],"qrCode":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AntifraudLawFootPrintDTO"},"example":"<AntifraudLawFootPrintDTO> <identifier>string</identifier> <qrImage /> <qrCode>string</qrCode> </AntifraudLawFootPrintDTO>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AntifraudLawFootPrintDTO"},"example":{"identifier":"string","qrImage":[],"qrCode":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AntifraudLawFootPrintDTO"},"example":"<AntifraudLawFootPrintDTO> <identifier>string</identifier> <qrImage /> <qrCode>string</qrCode> </AntifraudLawFootPrintDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/registeredInvoices/{id}/sendResponse":{"get":{"tags":["registeredInvoices"],"summary":"Get the response obtained when sending a registered invoice","description":"Get the response obtained when sending a registered invoice","operationId":"RegisteredInvoices_GetSendResponseById","parameters":[{"name":"id","in":"path","description":"Antifraud identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRegisteredInvoicesIdSendResponseGet200ApplicationJsonResponse"},"example":"string"},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiRegisteredInvoicesIdSendResponseGet200ApplicationXmlResponse"},"example":"<ApiRegisteredInvoicesIdSendResponseGet200ApplicationXmlResponse>string</ApiRegisteredInvoicesIdSendResponseGet200ApplicationXmlResponse>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRegisteredInvoicesIdSendResponseGet204ApplicationJsonResponse"},"example":"string"},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiRegisteredInvoicesIdSendResponseGet204ApplicationXmlResponse"},"example":"<ApiRegisteredInvoicesIdSendResponseGet204ApplicationXmlResponse>string</ApiRegisteredInvoicesIdSendResponseGet204ApplicationXmlResponse>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/registeredInvoices":{"get":{"tags":["registeredInvoices"],"summary":"Get all registered invoices","description":"Get all registered invoices","operationId":"RegisteredInvoices_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AntifraudLawInvoiceLogDTOArray"},"example":[{"id":"string","operationDescription":"string","logDate":"string","invoiceDate":"string","invoiceNumber":"string","customerName":"string","invoiceAmount":0,"logStatus":0,"logStatusDescription":"string","invoiceType":0,"sentDate":"string","eInvoiceLogAnomalies":[{"correlationId":"string","anomalyDate":"string","anomaliesEventType":0,"description":"string","eInvoiceLogId":0}],"customerVATCode":"string","aeatResponseCode":"string","aeatResponseDescription":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/AntifraudLawInvoiceLogDTOArray"},"example":"<AntifraudLawInvoiceLogDTOArray> <id>string</id> <operationDescription>string</operationDescription> <logDate>string</logDate> <invoiceDate>string</invoiceDate> <invoiceNumber>string</invoiceNumber> <customerName>string</customerName> <invoiceAmount>0</invoiceAmount> <logStatus>0</logStatus> <logStatusDescription>string</logStatusDescription> <invoiceType>0</invoiceType> <sentDate>string</sentDate> <eInvoiceLogAnomalies> <correlationId>string</correlationId> <anomalyDate>string</anomalyDate> <anomaliesEventType>0</anomaliesEventType> <description>string</description> <eInvoiceLogId>0</eInvoiceLogId> </eInvoiceLogAnomalies> <customerVATCode>string</customerVATCode> <aeatResponseCode>string</aeatResponseCode> <aeatResponseDescription>string</aeatResponseDescription> </AntifraudLawInvoiceLogDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/registeredInvoices/export":{"get":{"tags":["registeredInvoices"],"summary":"Export all registered invoices","description":"Export all registered invoices","operationId":"RegisteredInvoices_Export","parameters":[{"name":"format","in":"query","description":"Export format","schema":{"enum":["Excel"],"type":"string"}},{"name":"headers","in":"query","description":"Headers","schema":{"type":"string"}},{"name":"title","in":"query","description":"Title","schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiRegisteredInvoicesExportGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiRegisteredInvoicesExportGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/regularizations/{id}":{"get":{"tags":["regularizations"],"summary":"Get a Regularization by identifier","description":"Get a Regularization by identifier","operationId":"Regularizations_GetById","parameters":[{"name":"id","in":"path","description":"regularization identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegularizationDTO"},"example":{"id":"string","productId":"string","units":0,"date":"string","reason":"string","annotations":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RegularizationDTO"},"example":"<RegularizationDTO> <id>string</id> <productId>string</productId> <units>0</units> <date>string</date> <reason>string</reason> <annotations>string</annotations> </RegularizationDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["regularizations"],"summary":"Delete a regularization of a product by identifier","description":"Delete a regularization of a product by identifier","operationId":"Regularizations_Delete","parameters":[{"name":"id","in":"path","description":"Regularization identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/regularizations":{"get":{"tags":["regularizations"],"summary":"Get all Regularizations","description":"Get all Regularizations","operationId":"Regularizations_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegularizationDTOArray"},"example":[{"id":"string","productId":"string","units":0,"date":"string","reason":"string","annotations":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/RegularizationDTOArray"},"example":"<RegularizationDTOArray> <id>string</id> <productId>string</productId> <units>0</units> <date>string</date> <reason>string</reason> <annotations>string</annotations> </RegularizationDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["regularizations"],"summary":"Regularize a product","description":"Regularize a product","operationId":"Regularizations_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Regularization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegularizationDTO"},"example":{"id":"string","productId":"string","units":0,"date":"string","reason":"string","annotations":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/RegularizationDTO"},"example":{"id":"string","productId":"string","units":0,"date":"string","reason":"string","annotations":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/RegularizationDTO"},"example":"<RegularizationDTO> <id>string</id> <productId>string</productId> <units>0</units> <date>string</date> <reason>string</reason> <annotations>string</annotations> </RegularizationDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/RegularizationDTO"},"example":{"id":"string","productId":"string","units":0,"date":"string","reason":"string","annotations":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RegularizationDTO"},"example":"<RegularizationDTO> <id>string</id> <productId>string</productId> <units>0</units> <date>string</date> <reason>string</reason> <annotations>string</annotations> </RegularizationDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/RegularizationDTO"},"example":"<RegularizationDTO> <id>string</id> <productId>string</productId> <units>0</units> <date>string</date> <reason>string</reason> <annotations>string</annotations> </RegularizationDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/remittances/new":{"get":{"tags":["remittances"],"summary":"Get a new remittance with default values","description":"Get a new remittance with default values","operationId":"Remittances_GetNew","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemittanceDTO"},"example":{"id":"string","number":"string","bankId":"string","bankName":"string","date":"string","situation":0,"amount":0,"chargedAmount":0,"chargeDate":"string","mandateType":"string","isMediaGenerated":true,"annotations":"string","isFullyPaidAtOnce":true,"maxAmount":0,"hasMaxAmount":true,"currency":"string","dues":[{"id":"string","date":"string","chargeDate":"string","returnDate":"string","invoiceDate":"string","amount":0,"currency":"string","bankId":"string","payDocumentId":"string","payDocumentDescription":"string","payDocumentRemittable":true,"directDebitId":"string","state":0,"customerName":"string","customerDocument":"string","supplierDocument":"string","invoiceNumber":"string","directDebitBankAccount":"string","directDebitDescription":"string","directDebitSwift":"string","directDebitIsNacional":true,"customerTown":"string","customerCountry":"string","customerMainAddress":"string","customerPostalCode":"string","bankDescription":"string","remitted":true,"remittanceNumber":"string","mandateType":"string","mandateReference":"string","customerId":"string","invoiceId":"string","purchaseInvoiceId":"string","remittanceId":"string","parentDueId":"string","bankStatementCorrelationId":"string","purchaseReference":"string","journala3InnuvaId":"string","returnJournala3InnuvaId":"string"}],"activityId":"string","isMigrated":true,"journala3InnuvaId":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RemittanceDTO"},"example":"<RemittanceDTO> <id>string</id> <number>string</number> <bankId>string</bankId> <bankName>string</bankName> <date>string</date> <situation>0</situation> <amount>0</amount> <chargedAmount>0</chargedAmount> <chargeDate>string</chargeDate> <mandateType>string</mandateType> <isMediaGenerated>true</isMediaGenerated> <annotations>string</annotations> <isFullyPaidAtOnce>true</isFullyPaidAtOnce> <maxAmount>0</maxAmount> <hasMaxAmount>true</hasMaxAmount> <currency>string</currency> <dues> <id>string</id> <date>string</date> <chargeDate>string</chargeDate> <returnDate>string</returnDate> <invoiceDate>string</invoiceDate> <amount>0</amount> <currency>string</currency> <bankId>string</bankId> <payDocumentId>string</payDocumentId> <payDocumentDescription>string</payDocumentDescription> <payDocumentRemittable>true</payDocumentRemittable> <directDebitId>string</directDebitId> <state>0</state> <customerName>string</customerName> <customerDocument>string</customerDocument> <supplierDocument>string</supplierDocument> <invoiceNumber>string</invoiceNumber> <directDebitBankAccount>string</directDebitBankAccount> <directDebitDescription>string</directDebitDescription> <directDebitSwift>string</directDebitSwift> <directDebitIsNacional>true</directDebitIsNacional> <customerTown>string</customerTown> <customerCountry>string</customerCountry> <customerMainAddress>string</customerMainAddress> <customerPostalCode>string</customerPostalCode> <bankDescription>string</bankDescription> <remitted>true</remitted> <remittanceNumber>string</remittanceNumber> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <customerId>string</customerId> <invoiceId>string</invoiceId> <purchaseInvoiceId>string</purchaseInvoiceId> <remittanceId>string</remittanceId> <parentDueId>string</parentDueId> <bankStatementCorrelationId>string</bankStatementCorrelationId> <purchaseReference>string</purchaseReference> <journala3InnuvaId>string</journala3InnuvaId> <returnJournala3InnuvaId>string</returnJournala3InnuvaId> </dues> <activityId>string</activityId> <isMigrated>true</isMigrated> <journala3InnuvaId>string</journala3InnuvaId> </RemittanceDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/remittances/{id}":{"get":{"tags":["remittances"],"summary":"Get a remittance by identifier","description":"Get a remittance by identifier","operationId":"Remittances_GetById","parameters":[{"name":"id","in":"path","description":"Remittance identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemittanceDTO"},"example":{"id":"string","number":"string","bankId":"string","bankName":"string","date":"string","situation":0,"amount":0,"chargedAmount":0,"chargeDate":"string","mandateType":"string","isMediaGenerated":true,"annotations":"string","isFullyPaidAtOnce":true,"maxAmount":0,"hasMaxAmount":true,"currency":"string","dues":[{"id":"string","date":"string","chargeDate":"string","returnDate":"string","invoiceDate":"string","amount":0,"currency":"string","bankId":"string","payDocumentId":"string","payDocumentDescription":"string","payDocumentRemittable":true,"directDebitId":"string","state":0,"customerName":"string","customerDocument":"string","supplierDocument":"string","invoiceNumber":"string","directDebitBankAccount":"string","directDebitDescription":"string","directDebitSwift":"string","directDebitIsNacional":true,"customerTown":"string","customerCountry":"string","customerMainAddress":"string","customerPostalCode":"string","bankDescription":"string","remitted":true,"remittanceNumber":"string","mandateType":"string","mandateReference":"string","customerId":"string","invoiceId":"string","purchaseInvoiceId":"string","remittanceId":"string","parentDueId":"string","bankStatementCorrelationId":"string","purchaseReference":"string","journala3InnuvaId":"string","returnJournala3InnuvaId":"string"}],"activityId":"string","isMigrated":true,"journala3InnuvaId":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RemittanceDTO"},"example":"<RemittanceDTO> <id>string</id> <number>string</number> <bankId>string</bankId> <bankName>string</bankName> <date>string</date> <situation>0</situation> <amount>0</amount> <chargedAmount>0</chargedAmount> <chargeDate>string</chargeDate> <mandateType>string</mandateType> <isMediaGenerated>true</isMediaGenerated> <annotations>string</annotations> <isFullyPaidAtOnce>true</isFullyPaidAtOnce> <maxAmount>0</maxAmount> <hasMaxAmount>true</hasMaxAmount> <currency>string</currency> <dues> <id>string</id> <date>string</date> <chargeDate>string</chargeDate> <returnDate>string</returnDate> <invoiceDate>string</invoiceDate> <amount>0</amount> <currency>string</currency> <bankId>string</bankId> <payDocumentId>string</payDocumentId> <payDocumentDescription>string</payDocumentDescription> <payDocumentRemittable>true</payDocumentRemittable> <directDebitId>string</directDebitId> <state>0</state> <customerName>string</customerName> <customerDocument>string</customerDocument> <supplierDocument>string</supplierDocument> <invoiceNumber>string</invoiceNumber> <directDebitBankAccount>string</directDebitBankAccount> <directDebitDescription>string</directDebitDescription> <directDebitSwift>string</directDebitSwift> <directDebitIsNacional>true</directDebitIsNacional> <customerTown>string</customerTown> <customerCountry>string</customerCountry> <customerMainAddress>string</customerMainAddress> <customerPostalCode>string</customerPostalCode> <bankDescription>string</bankDescription> <remitted>true</remitted> <remittanceNumber>string</remittanceNumber> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <customerId>string</customerId> <invoiceId>string</invoiceId> <purchaseInvoiceId>string</purchaseInvoiceId> <remittanceId>string</remittanceId> <parentDueId>string</parentDueId> <bankStatementCorrelationId>string</bankStatementCorrelationId> <purchaseReference>string</purchaseReference> <journala3InnuvaId>string</journala3InnuvaId> <returnJournala3InnuvaId>string</returnJournala3InnuvaId> </dues> <activityId>string</activityId> <isMigrated>true</isMigrated> <journala3InnuvaId>string</journala3InnuvaId> </RemittanceDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["remittances"],"summary":"Delete a remittance","description":"Delete a remittance","operationId":"Remittances_Delete","parameters":[{"name":"id","in":"path","description":"Sale invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/remittances/{id}/duesCollection/count":{"get":{"tags":["remittances"],"summary":"Count Remittance Dues","description":"Count Remittance Dues","operationId":"Remittances_CountRemittanceDues","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRemittancesIdDuesCollectionCountGet200ApplicationJsonResponse"},"example":0},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiRemittancesIdDuesCollectionCountGet200ApplicationXmlResponse"},"example":"<ApiRemittancesIdDuesCollectionCountGet200ApplicationXmlResponse>0</ApiRemittancesIdDuesCollectionCountGet200ApplicationXmlResponse>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/remittances/{id}/duesCollection/getFirst":{"get":{"tags":["remittances"],"summary":"Get the minimun date of the dues","description":"Get the minimun date of the dues","operationId":"Remittances_GetFirstDueDate","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRemittancesIdDuesCollectionGetFirstGet200ApplicationJsonResponse"},"example":"string"},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiRemittancesIdDuesCollectionGetFirstGet200ApplicationXmlResponse"},"example":"<ApiRemittancesIdDuesCollectionGetFirstGet200ApplicationXmlResponse>string</ApiRemittancesIdDuesCollectionGetFirstGet200ApplicationXmlResponse>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/remittances":{"get":{"tags":["remittances"],"summary":"Get all remittances","description":"Get all remittances","operationId":"Remittances_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlatRemittanceDTOArray"},"example":[{"id":"string","bankId":"string","date":"string","mandateType":"string","amount":0,"chargeAmount":0,"chargeDate":"string","number":"string","annotations":"string","situation":0,"isFullyPaidAtOnce":true,"currency":"string","bankName":"string","isMediaGenerated":true,"isPaid":true,"chargedDues":0,"returnedDues":0,"activityId":"00000000-0000-0000-0000-000000000000","isMigrated":true,"journala3InnuvaId":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/FlatRemittanceDTOArray"},"example":"<FlatRemittanceDTOArray> <id>string</id> <bankId>string</bankId> <date>string</date> <mandateType>string</mandateType> <amount>0</amount> <chargeAmount>0</chargeAmount> <chargeDate>string</chargeDate> <number>string</number> <annotations>string</annotations> <situation>0</situation> <isFullyPaidAtOnce>true</isFullyPaidAtOnce> <currency>string</currency> <bankName>string</bankName> <isMediaGenerated>true</isMediaGenerated> <isPaid>true</isPaid> <chargedDues>0</chargedDues> <returnedDues>0</returnedDues> <activityId>00000000-0000-0000-0000-000000000000</activityId> <isMigrated>true</isMigrated> <journala3InnuvaId>string</journala3InnuvaId> </FlatRemittanceDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["remittances"],"summary":"Update a remittance","description":"Update a remittance","operationId":"Remittances_Put","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemittanceUpdateDTO"},"example":{"id":"string","annotations":"string","duesIds":["string"]}},"text/json":{"schema":{"$ref":"#/components/schemas/RemittanceUpdateDTO"},"example":{"id":"string","annotations":"string","duesIds":["string"]}},"text/html":{"schema":{"$ref":"#/components/schemas/RemittanceUpdateDTO"},"example":"<RemittanceUpdateDTO> <id>string</id> <annotations>string</annotations> <duesIds>string</duesIds> </RemittanceUpdateDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/RemittanceUpdateDTO"},"example":{"id":"string","annotations":"string","duesIds":["string"]}},"application/xml":{"schema":{"$ref":"#/components/schemas/RemittanceUpdateDTO"},"example":"<RemittanceUpdateDTO> <id>string</id> <annotations>string</annotations> <duesIds>string</duesIds> </RemittanceUpdateDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/RemittanceUpdateDTO"},"example":"<RemittanceUpdateDTO> <id>string</id> <annotations>string</annotations> <duesIds>string</duesIds> </RemittanceUpdateDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["remittances"],"summary":"Add a new remittance","description":"Add a new remittance","operationId":"Remittances_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Remittance","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemittanceNewDTO"},"example":{"id":"string","bankId":"string","date":"string","mandateType":"string","annotations":"string","maxAmount":0,"hasMaxAmount":true,"duesIds":["string"],"activityId":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/RemittanceNewDTO"},"example":{"id":"string","bankId":"string","date":"string","mandateType":"string","annotations":"string","maxAmount":0,"hasMaxAmount":true,"duesIds":["string"],"activityId":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/RemittanceNewDTO"},"example":"<RemittanceNewDTO> <id>string</id> <bankId>string</bankId> <date>string</date> <mandateType>string</mandateType> <annotations>string</annotations> <maxAmount>0</maxAmount> <hasMaxAmount>true</hasMaxAmount> <duesIds>string</duesIds> <activityId>string</activityId> </RemittanceNewDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/RemittanceNewDTO"},"example":{"id":"string","bankId":"string","date":"string","mandateType":"string","annotations":"string","maxAmount":0,"hasMaxAmount":true,"duesIds":["string"],"activityId":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RemittanceNewDTO"},"example":"<RemittanceNewDTO> <id>string</id> <bankId>string</bankId> <date>string</date> <mandateType>string</mandateType> <annotations>string</annotations> <maxAmount>0</maxAmount> <hasMaxAmount>true</hasMaxAmount> <duesIds>string</duesIds> <activityId>string</activityId> </RemittanceNewDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/RemittanceNewDTO"},"example":"<RemittanceNewDTO> <id>string</id> <bankId>string</bankId> <date>string</date> <mandateType>string</mandateType> <annotations>string</annotations> <maxAmount>0</maxAmount> <hasMaxAmount>true</hasMaxAmount> <duesIds>string</duesIds> <activityId>string</activityId> </RemittanceNewDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Created","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/remittances/extendedExport":{"get":{"tags":["remittances"],"summary":"Export extended sale invoices","description":"Export extended sale invoices","operationId":"Remittances_ExtendedExport","parameters":[{"name":"format","in":"query","description":"Export format","schema":{"enum":["Excel"],"type":"string"}},{"name":"headers","in":"query","description":"Headers","schema":{"type":"string"}},{"name":"title","in":"query","description":"Title","schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiRemittancesExtendedExportGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiRemittancesExtendedExportGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/remittances/{id}/sepa":{"post":{"tags":["remittances"],"summary":"Generate magnetic support","description":"Generate magnetic support","operationId":"Remittances_Sepa","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SepaCommand"},"example":{"preparationDate":"string","chargeDate":"string","useChargeDate":true}},"text/json":{"schema":{"$ref":"#/components/schemas/SepaCommand"},"example":{"preparationDate":"string","chargeDate":"string","useChargeDate":true}},"text/html":{"schema":{"$ref":"#/components/schemas/SepaCommand"},"example":"<SepaCommand> <preparationDate>string</preparationDate> <chargeDate>string</chargeDate> <useChargeDate>true</useChargeDate> </SepaCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/SepaCommand"},"example":{"preparationDate":"string","chargeDate":"string","useChargeDate":true}},"application/xml":{"schema":{"$ref":"#/components/schemas/SepaCommand"},"example":"<SepaCommand> <preparationDate>string</preparationDate> <chargeDate>string</chargeDate> <useChargeDate>true</useChargeDate> </SepaCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/SepaCommand"},"example":"<SepaCommand> <preparationDate>string</preparationDate> <chargeDate>string</chargeDate> <useChargeDate>true</useChargeDate> </SepaCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/remittances/{id}/charge":{"post":{"tags":["remittances"],"summary":"Charge a remittance totally","description":"Charge a remittance totally","operationId":"Remittances_Charge","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargeRemittanceCommand"},"example":{"effectiveDate":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/ChargeRemittanceCommand"},"example":{"effectiveDate":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/ChargeRemittanceCommand"},"example":"<ChargeRemittanceCommand> <effectiveDate>string</effectiveDate> </ChargeRemittanceCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ChargeRemittanceCommand"},"example":{"effectiveDate":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ChargeRemittanceCommand"},"example":"<ChargeRemittanceCommand> <effectiveDate>string</effectiveDate> </ChargeRemittanceCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ChargeRemittanceCommand"},"example":"<ChargeRemittanceCommand> <effectiveDate>string</effectiveDate> </ChargeRemittanceCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/remittances/{id}/cancelcharge":{"post":{"tags":["remittances"],"summary":"Cancel a charged remittance totally","description":"Cancel a charged remittance totally","operationId":"Remittances_CancelCharge","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/remittances/{id}/duesCollection/charge":{"post":{"tags":["remittances"],"summary":"Charge dues list of the remittance","description":"Charge dues list of the remittance","operationId":"Remittances_ChargeDues","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargeDuesRemittanceCommand"},"example":{"effectiveDate":"string","duesIds":["string"]}},"text/json":{"schema":{"$ref":"#/components/schemas/ChargeDuesRemittanceCommand"},"example":{"effectiveDate":"string","duesIds":["string"]}},"text/html":{"schema":{"$ref":"#/components/schemas/ChargeDuesRemittanceCommand"},"example":"<ChargeDuesRemittanceCommand> <effectiveDate>string</effectiveDate> <duesIds>string</duesIds> </ChargeDuesRemittanceCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ChargeDuesRemittanceCommand"},"example":{"effectiveDate":"string","duesIds":["string"]}},"application/xml":{"schema":{"$ref":"#/components/schemas/ChargeDuesRemittanceCommand"},"example":"<ChargeDuesRemittanceCommand> <effectiveDate>string</effectiveDate> <duesIds>string</duesIds> </ChargeDuesRemittanceCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ChargeDuesRemittanceCommand"},"example":"<ChargeDuesRemittanceCommand> <effectiveDate>string</effectiveDate> <duesIds>string</duesIds> </ChargeDuesRemittanceCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/remittances/{id}/duesCollection/return":{"post":{"tags":["remittances"],"summary":"Return dues list of the remittance","description":"Return dues list of the remittance","operationId":"Remittances_returnDues","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnDuesRemittanceCommand"},"example":{"date":"string","duesIds":["string"]}},"text/json":{"schema":{"$ref":"#/components/schemas/ReturnDuesRemittanceCommand"},"example":{"date":"string","duesIds":["string"]}},"text/html":{"schema":{"$ref":"#/components/schemas/ReturnDuesRemittanceCommand"},"example":"<ReturnDuesRemittanceCommand> <date>string</date> <duesIds>string</duesIds> </ReturnDuesRemittanceCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ReturnDuesRemittanceCommand"},"example":{"date":"string","duesIds":["string"]}},"application/xml":{"schema":{"$ref":"#/components/schemas/ReturnDuesRemittanceCommand"},"example":"<ReturnDuesRemittanceCommand> <date>string</date> <duesIds>string</duesIds> </ReturnDuesRemittanceCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ReturnDuesRemittanceCommand"},"example":"<ReturnDuesRemittanceCommand> <date>string</date> <duesIds>string</duesIds> </ReturnDuesRemittanceCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/remittances/{id}/duesCollection/cancelcharge":{"post":{"tags":["remittances"],"summary":"Cancel a charged list of dues from a remittance","description":"Cancel a charged list of dues from a remittance","operationId":"Remittances_CancelChargeDues","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelChargeDuesRemittanceCommand"},"example":{"dues":["string"]}},"text/json":{"schema":{"$ref":"#/components/schemas/CancelChargeDuesRemittanceCommand"},"example":{"dues":["string"]}},"text/html":{"schema":{"$ref":"#/components/schemas/CancelChargeDuesRemittanceCommand"},"example":"<CancelChargeDuesRemittanceCommand> <dues>string</dues> </CancelChargeDuesRemittanceCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/CancelChargeDuesRemittanceCommand"},"example":{"dues":["string"]}},"application/xml":{"schema":{"$ref":"#/components/schemas/CancelChargeDuesRemittanceCommand"},"example":"<CancelChargeDuesRemittanceCommand> <dues>string</dues> </CancelChargeDuesRemittanceCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/CancelChargeDuesRemittanceCommand"},"example":"<CancelChargeDuesRemittanceCommand> <dues>string</dues> </CancelChargeDuesRemittanceCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/remittances/{id}/duesCollection/cancelreturn":{"post":{"tags":["remittances"],"summary":"Cancel a returned list of dues from a remittance","description":"Cancel a returned list of dues from a remittance","operationId":"Remittances_CancelReturnDues","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelReturnDuesRemittanceCommand"},"example":{"duesId":["string"]}},"text/json":{"schema":{"$ref":"#/components/schemas/CancelReturnDuesRemittanceCommand"},"example":{"duesId":["string"]}},"text/html":{"schema":{"$ref":"#/components/schemas/CancelReturnDuesRemittanceCommand"},"example":"<CancelReturnDuesRemittanceCommand> <duesId>string</duesId> </CancelReturnDuesRemittanceCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/CancelReturnDuesRemittanceCommand"},"example":{"duesId":["string"]}},"application/xml":{"schema":{"$ref":"#/components/schemas/CancelReturnDuesRemittanceCommand"},"example":"<CancelReturnDuesRemittanceCommand> <duesId>string</duesId> </CancelReturnDuesRemittanceCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/CancelReturnDuesRemittanceCommand"},"example":"<CancelReturnDuesRemittanceCommand> <duesId>string</duesId> </CancelReturnDuesRemittanceCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/representatives/new":{"get":{"tags":["representatives"],"summary":"Get a new representative with default values","description":"Get a new representative with default values","operationId":"Representatives_GetNew","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepresentativeDTO"},"example":{"id":"string","name":"string","mail":"string","phone":"string","commissionPercentage":0,"applyOver":0,"commissionWhen":0,"annotations":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RepresentativeDTO"},"example":"<RepresentativeDTO> <id>string</id> <name>string</name> <mail>string</mail> <phone>string</phone> <commissionPercentage>0</commissionPercentage> <applyOver>0</applyOver> <commissionWhen>0</commissionWhen> <annotations>string</annotations> </RepresentativeDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/representatives/{id}":{"get":{"tags":["representatives"],"summary":"Get a representive by identifier","description":"Get a representive by identifier","operationId":"Representatives_GetById","parameters":[{"name":"id","in":"path","description":"representative identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepresentativeDTO"},"example":{"id":"string","name":"string","mail":"string","phone":"string","commissionPercentage":0,"applyOver":0,"commissionWhen":0,"annotations":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RepresentativeDTO"},"example":"<RepresentativeDTO> <id>string</id> <name>string</name> <mail>string</mail> <phone>string</phone> <commissionPercentage>0</commissionPercentage> <applyOver>0</applyOver> <commissionWhen>0</commissionWhen> <annotations>string</annotations> </RepresentativeDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["representatives"],"summary":"Delete a representative by identifier","description":"Delete a representative by identifier","operationId":"Representatives_Delete","parameters":[{"name":"id","in":"path","description":"Representative identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"patch":{"tags":["representatives"],"summary":"Update specific properties of representative","description":"Update specific properties of representative","operationId":"Representatives_Patch","parameters":[{"name":"id","in":"path","description":"Representative identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Collection of {a3ERP.Public.Resources.V2.PatchOperation}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/html":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/representatives":{"get":{"tags":["representatives"],"summary":"Get all representatives","description":"Get all representatives","operationId":"Representatives_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepresentativeDTOArray"},"example":[{"id":"string","name":"string","mail":"string","phone":"string","commissionPercentage":0,"applyOver":0,"commissionWhen":0,"annotations":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/RepresentativeDTOArray"},"example":"<RepresentativeDTOArray> <id>string</id> <name>string</name> <mail>string</mail> <phone>string</phone> <commissionPercentage>0</commissionPercentage> <applyOver>0</applyOver> <commissionWhen>0</commissionWhen> <annotations>string</annotations> </RepresentativeDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["representatives"],"summary":"Add a new representative","description":"Add a new representative","operationId":"Representatives_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Representative","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepresentativeDTO"},"example":{"id":"string","name":"string","mail":"string","phone":"string","commissionPercentage":0,"applyOver":0,"commissionWhen":0,"annotations":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/RepresentativeDTO"},"example":{"id":"string","name":"string","mail":"string","phone":"string","commissionPercentage":0,"applyOver":0,"commissionWhen":0,"annotations":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/RepresentativeDTO"},"example":"<RepresentativeDTO> <id>string</id> <name>string</name> <mail>string</mail> <phone>string</phone> <commissionPercentage>0</commissionPercentage> <applyOver>0</applyOver> <commissionWhen>0</commissionWhen> <annotations>string</annotations> </RepresentativeDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/RepresentativeDTO"},"example":{"id":"string","name":"string","mail":"string","phone":"string","commissionPercentage":0,"applyOver":0,"commissionWhen":0,"annotations":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RepresentativeDTO"},"example":"<RepresentativeDTO> <id>string</id> <name>string</name> <mail>string</mail> <phone>string</phone> <commissionPercentage>0</commissionPercentage> <applyOver>0</applyOver> <commissionWhen>0</commissionWhen> <annotations>string</annotations> </RepresentativeDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/RepresentativeDTO"},"example":"<RepresentativeDTO> <id>string</id> <name>string</name> <mail>string</mail> <phone>string</phone> <commissionPercentage>0</commissionPercentage> <applyOver>0</applyOver> <commissionWhen>0</commissionWhen> <annotations>string</annotations> </RepresentativeDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Created","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/representatives/export":{"get":{"tags":["representatives"],"summary":"Export all representative with filters","description":"Export all representative with filters","operationId":"Representatives_Export","parameters":[{"name":"format","in":"query","description":"Export format","schema":{"enum":["Excel"],"type":"string"}},{"name":"headers","in":"query","description":"Headers","schema":{"type":"string"}},{"name":"title","in":"query","description":"Title","schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiRepresentativesExportGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiRepresentativesExportGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/representatives/expotComissionsReport":{"post":{"tags":["representatives"],"summary":"Export comissions report","description":"Export comissions report","operationId":"Representatives_ComissionsReport","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"List of parameters to generate the comissions report","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComissionsReportCommand"},"example":{"representativeId":"string","startDate":"string","endDate":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/ComissionsReportCommand"},"example":{"representativeId":"string","startDate":"string","endDate":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/ComissionsReportCommand"},"example":"<ComissionsReportCommand> <representativeId>string</representativeId> <startDate>string</startDate> <endDate>string</endDate> </ComissionsReportCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ComissionsReportCommand"},"example":{"representativeId":"string","startDate":"string","endDate":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ComissionsReportCommand"},"example":"<ComissionsReportCommand> <representativeId>string</representativeId> <startDate>string</startDate> <endDate>string</endDate> </ComissionsReportCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ComissionsReportCommand"},"example":"<ComissionsReportCommand> <representativeId>string</representativeId> <startDate>string</startDate> <endDate>string</endDate> </ComissionsReportCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/ruleengine/validate":{"post":{"tags":["ruleengine"],"summary":"Validate a set of values","description":"Validate a set of values","operationId":"RuleEngine_Validate","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"{a3ERP.Public.Resources.V2.ValidationValue}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationValue"},"example":{"_type":"string","isNew":true,"values":[{"path":"string","value":{}}]}},"text/json":{"schema":{"$ref":"#/components/schemas/ValidationValue"},"example":{"_type":"string","isNew":true,"values":[{"path":"string","value":{}}]}},"text/html":{"schema":{"$ref":"#/components/schemas/ValidationValue"},"example":"<ValidationValue> <_type>string</_type> <isNew>true</isNew> <values> <path>string</path> <value /> </values> </ValidationValue>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ValidationValue"},"example":{"_type":"string","isNew":true,"values":[{"path":"string","value":{}}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/ValidationValue"},"example":"<ValidationValue> <_type>string</_type> <isNew>true</isNew> <values> <path>string</path> <value /> </values> </ValidationValue>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ValidationValue"},"example":"<ValidationValue> <_type>string</_type> <isNew>true</isNew> <values> <path>string</path> <value /> </values> </ValidationValue>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageArray"},"example":[{"type":"string","description":"string","title":"string","details":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/MessageArray"},"example":"<MessageArray> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </MessageArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleDeliveryNotes/{id}":{"get":{"tags":["saleDeliveryNotes"],"summary":"Get a sale delivery note","description":"Get a sale delivery note","operationId":"SaleDeliveryNotes_GetById","parameters":[{"name":"id","in":"path","description":"Sale delivery note identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleDeliveryNoteDTO"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleDeliveryNoteDTO"}}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["saleDeliveryNotes"],"summary":"Delete a sale delivery note","description":"Delete a sale delivery note","operationId":"SaleDeliveryNotes_Delete","parameters":[{"name":"id","in":"path","description":"Sale order identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleDeliveryNotes/{id}/circuitinfo":{"get":{"tags":["saleDeliveryNotes"],"summary":"Get circuit info lines","description":"Get circuit info lines","operationId":"SaleDeliveryNotes_CircuitInfoLines","parameters":[{"name":"id","in":"path","description":"Circuit info lines","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CircuitInfoDTOArray"},"example":[{"lineId":"string","description":"string","units":0,"lineBase":0,"situation":0,"cancelledUnits":0,"pendingUnits":0,"confirmedUnits":0,"deliveredUnits":0,"billedUnits":0}]},"application/xml":{"schema":{"$ref":"#/components/schemas/CircuitInfoDTOArray"},"example":"<CircuitInfoDTOArray> <lineId>string</lineId> <description>string</description> <units>0</units> <lineBase>0</lineBase> <situation>0</situation> <cancelledUnits>0</cancelledUnits> <pendingUnits>0</pendingUnits> <confirmedUnits>0</confirmedUnits> <deliveredUnits>0</deliveredUnits> <billedUnits>0</billedUnits> </CircuitInfoDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleDeliveryNotes/new":{"get":{"tags":["saleDeliveryNotes"],"summary":"Get a new sale delivery note with default values","description":"Get a new sale delivery note with default values","operationId":"SaleDeliveryNotes_GetNew","parameters":[{"name":"customerId","in":"query","description":"Customer identifier","schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleDeliveryNoteDTO"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleDeliveryNoteDTO"}}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleDeliveryNotes/{id}/pdf":{"get":{"tags":["saleDeliveryNotes"],"summary":"Get the pdf of the document","description":"Get the pdf of the document","operationId":"SaleDeliveryNotes_GetPdf","parameters":[{"name":"id","in":"path","description":"Document identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"templateId","in":"query","description":"Template identifier","schema":{"type":"integer","format":"int32","default":0}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/Response"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"404":{"description":"Not found","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/saleDeliveryNotes/{id}/line/{lineId}/documentlineinfo":{"get":{"tags":["saleDeliveryNotes"],"summary":"Get document line info","description":"Get document line info","operationId":"SaleDeliveryNotes_GetDocumentLineInfo","parameters":[{"name":"id","in":"path","description":"Document id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"lineId","in":"path","description":"Line id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentLineInfoDTOArray"},"example":[{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/DocumentLineInfoDTOArray"},"example":"<DocumentLineInfoDTOArray> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </DocumentLineInfoDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleDeliveryNotes/{id}/line/{lineId}/destinationdocumentscount":{"get":{"tags":["saleDeliveryNotes"],"summary":"Get destination documents count","description":"Get destination documents count","operationId":"SaleDeliveryNotes_DestinationDocumentsCount","parameters":[{"name":"id","in":"path","description":"Document id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"lineId","in":"path","description":"Line id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiSaleDeliveryNotesIdLineLineIdDestinationdocumentscountGet200ApplicationJs"},"example":0},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiSaleDeliveryNotesIdLineLineIdDestinationdocumentscountGet200ApplicationXm"},"example":"<ApiSaleDeliveryNotesIdLineLineIdDestinationdocumentscountGet200ApplicationXm>0</ApiSaleDeliveryNotesIdLineLineIdDestinationdocumentscountGet200ApplicationXm>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleDeliveryNotes/newLine":{"get":{"tags":["saleDeliveryNotes"],"summary":"Get a new sale delivery note line with default values","description":"Get a new sale delivery note line with default values","operationId":"SaleDeliveryNotes_GetNewLine","parameters":[{"name":"customerId","in":"query","description":"Customer identifier","schema":{"type":"string","format":"uuid"}},{"name":"productId","in":"query","description":"Product identifier","schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleDeliveryNoteLineDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleDeliveryNoteLineDto"}}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleDeliveryNotes/{id}/deliveryLabels":{"get":{"tags":["saleDeliveryNotes"],"summary":"Get the delivery labels of a document","description":"Get the delivery labels of a document","operationId":"SaleDeliveryNotes_GetDeliveryLabels","parameters":[{"name":"id","in":"path","description":"Document identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"numberOfPackages","in":"query","description":"Number of packages to print. Limit 1000","schema":{"type":"integer","format":"int32","default":1}},{"name":"templateId","in":"query","description":"Template identifier","schema":{"type":"integer","format":"int32","default":0}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/Response"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"404":{"description":"Not found","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/saleDeliveryNotes":{"get":{"tags":["saleDeliveryNotes"],"summary":"Get all sale delivery notes","description":"Get all sale delivery notes","operationId":"SaleDeliveryNotes_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlatSaleDeliveryNoteDTOArray"},"example":[{"id":"string","number":"string","date":"string","receptionDate":"string","reference":"string","customerVATNumber":"string","customerName":"string","email":"string","taxBase":0,"taxTotal":0,"total":0,"saleCurrency":"string","saleOperationTypeCode":"string","saleOperationTypeDescription":"string","situation":"string","billable":true,"source":"string","sourceId":"string","activityId":"string","activityDescription":"string","processId":"string","emailCC":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/FlatSaleDeliveryNoteDTOArray"},"example":"<FlatSaleDeliveryNoteDTOArray> <id>string</id> <number>string</number> <date>string</date> <receptionDate>string</receptionDate> <reference>string</reference> <customerVATNumber>string</customerVATNumber> <customerName>string</customerName> <email>string</email> <taxBase>0</taxBase> <taxTotal>0</taxTotal> <total>0</total> <saleCurrency>string</saleCurrency> <saleOperationTypeCode>string</saleOperationTypeCode> <saleOperationTypeDescription>string</saleOperationTypeDescription> <situation>string</situation> <billable>true</billable> <source>string</source> <sourceId>string</sourceId> <activityId>string</activityId> <activityDescription>string</activityDescription> <processId>string</processId> <emailCC>string</emailCC> </FlatSaleDeliveryNoteDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["saleDeliveryNotes"],"summary":"Update a sale delivery note","description":"Update a sale delivery note","operationId":"SaleDeliveryNotes_Put","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleDeliveryNoteDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/SaleDeliveryNoteDTO"}},"text/html":{"schema":{"$ref":"#/components/schemas/SaleDeliveryNoteDTO"}},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/SaleDeliveryNoteDTO"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleDeliveryNoteDTO"}},"text/xml":{"schema":{"$ref":"#/components/schemas/SaleDeliveryNoteDTO"}},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["saleDeliveryNotes"],"summary":"Create a sale delivery note","description":"Create a sale delivery note","operationId":"SaleDeliveryNotes_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleDeliveryNoteDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/SaleDeliveryNoteDTO"}},"text/html":{"schema":{"$ref":"#/components/schemas/SaleDeliveryNoteDTO"}},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/SaleDeliveryNoteDTO"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleDeliveryNoteDTO"}},"text/xml":{"schema":{"$ref":"#/components/schemas/SaleDeliveryNoteDTO"}},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleDeliveryNotes/export":{"get":{"tags":["saleDeliveryNotes"],"summary":"Sale delivery note export","description":"Sale delivery note export","operationId":"SaleDeliveryNotes_Export","parameters":[{"name":"format","in":"query","description":"Export format","schema":{"enum":["Excel"],"type":"string"}},{"name":"headers","in":"query","description":"Headers","schema":{"type":"string"}},{"name":"title","in":"query","description":"Title","schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiSaleDeliveryNotesExportGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiSaleDeliveryNotesExportGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/saleDeliveryNotes/pdf":{"post":{"tags":["saleDeliveryNotes"],"summary":"Print a collection of sale delivery notes","description":"Print a collection of sale delivery notes","operationId":"SaleDeliveryNotes_QueuePdfs","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":{"templateId":"string","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"text/json":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":{"templateId":"string","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"text/html":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":"<PrintCommand> <templateId>string</templateId> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </PrintCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":{"templateId":"string","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":"<PrintCommand> <templateId>string</templateId> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </PrintCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":"<PrintCommand> <templateId>string</templateId> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </PrintCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleDeliveryNotes/{id}/bill":{"post":{"tags":["saleDeliveryNotes"],"summary":"Bill sale delivery note","description":"Bill sale delivery note","operationId":"SaleDeliveryNotes_Bill","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"text/json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"text/html":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleDeliveryNotes/billmassive":{"post":{"tags":["saleDeliveryNotes"],"summary":"Bill massive sale delivery note","description":"Bill massive sale delivery note","operationId":"SaleDeliveryNotes_BillMassive","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MassiveSaleDeliveryNoteDTO"},"example":{"cancelRest":true,"saleDeliveryNoteIds":["00000000-0000-0000-0000-000000000000"],"documentDate":"string","operationDate":"string","serie":"00000000-0000-0000-0000-000000000000","reference":"string","serieCriteria":true,"referenceCriteria":true,"deliveryAddressCriteria":true,"singleBillPerSaleDeliveryNoteCriteria":true,"transactionDateBehavior":0}},"text/json":{"schema":{"$ref":"#/components/schemas/MassiveSaleDeliveryNoteDTO"},"example":{"cancelRest":true,"saleDeliveryNoteIds":["00000000-0000-0000-0000-000000000000"],"documentDate":"string","operationDate":"string","serie":"00000000-0000-0000-0000-000000000000","reference":"string","serieCriteria":true,"referenceCriteria":true,"deliveryAddressCriteria":true,"singleBillPerSaleDeliveryNoteCriteria":true,"transactionDateBehavior":0}},"text/html":{"schema":{"$ref":"#/components/schemas/MassiveSaleDeliveryNoteDTO"},"example":"<MassiveSaleDeliveryNoteDTO> <cancelRest>true</cancelRest> <saleDeliveryNoteIds>00000000-0000-0000-0000-000000000000</saleDeliveryNoteIds> <documentDate>string</documentDate> <operationDate>string</operationDate> <serie>00000000-0000-0000-0000-000000000000</serie> <reference>string</reference> <serieCriteria>true</serieCriteria> <referenceCriteria>true</referenceCriteria> <deliveryAddressCriteria>true</deliveryAddressCriteria> <singleBillPerSaleDeliveryNoteCriteria>true</singleBillPerSaleDeliveryNoteCriteria> <transactionDateBehavior>0</transactionDateBehavior> </MassiveSaleDeliveryNoteDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/MassiveSaleDeliveryNoteDTO"},"example":{"cancelRest":true,"saleDeliveryNoteIds":["00000000-0000-0000-0000-000000000000"],"documentDate":"string","operationDate":"string","serie":"00000000-0000-0000-0000-000000000000","reference":"string","serieCriteria":true,"referenceCriteria":true,"deliveryAddressCriteria":true,"singleBillPerSaleDeliveryNoteCriteria":true,"transactionDateBehavior":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/MassiveSaleDeliveryNoteDTO"},"example":"<MassiveSaleDeliveryNoteDTO> <cancelRest>true</cancelRest> <saleDeliveryNoteIds>00000000-0000-0000-0000-000000000000</saleDeliveryNoteIds> <documentDate>string</documentDate> <operationDate>string</operationDate> <serie>00000000-0000-0000-0000-000000000000</serie> <reference>string</reference> <serieCriteria>true</serieCriteria> <referenceCriteria>true</referenceCriteria> <deliveryAddressCriteria>true</deliveryAddressCriteria> <singleBillPerSaleDeliveryNoteCriteria>true</singleBillPerSaleDeliveryNoteCriteria> <transactionDateBehavior>0</transactionDateBehavior> </MassiveSaleDeliveryNoteDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/MassiveSaleDeliveryNoteDTO"},"example":"<MassiveSaleDeliveryNoteDTO> <cancelRest>true</cancelRest> <saleDeliveryNoteIds>00000000-0000-0000-0000-000000000000</saleDeliveryNoteIds> <documentDate>string</documentDate> <operationDate>string</operationDate> <serie>00000000-0000-0000-0000-000000000000</serie> <reference>string</reference> <serieCriteria>true</serieCriteria> <referenceCriteria>true</referenceCriteria> <deliveryAddressCriteria>true</deliveryAddressCriteria> <singleBillPerSaleDeliveryNoteCriteria>true</singleBillPerSaleDeliveryNoteCriteria> <transactionDateBehavior>0</transactionDateBehavior> </MassiveSaleDeliveryNoteDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"202":{"description":"Accpeted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleDeliveryNotes/{id}/billToDraft":{"post":{"tags":["saleDeliveryNotes"],"summary":"Bill sale delivery note to draft","description":"Bill sale delivery note to draft","operationId":"SaleDeliveryNotes_BillToDraft","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"text/json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"text/html":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleDeliveryNotes/billmassiveToDraft":{"post":{"tags":["saleDeliveryNotes"],"summary":"Bill massive sale delivery note to draft","description":"Bill massive sale delivery note to draft","operationId":"SaleDeliveryNotes_BillMassiveToDraft","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MassiveSaleDeliveryNoteDTO"},"example":{"cancelRest":true,"saleDeliveryNoteIds":["00000000-0000-0000-0000-000000000000"],"documentDate":"string","operationDate":"string","serie":"00000000-0000-0000-0000-000000000000","reference":"string","serieCriteria":true,"referenceCriteria":true,"deliveryAddressCriteria":true,"singleBillPerSaleDeliveryNoteCriteria":true,"transactionDateBehavior":0}},"text/json":{"schema":{"$ref":"#/components/schemas/MassiveSaleDeliveryNoteDTO"},"example":{"cancelRest":true,"saleDeliveryNoteIds":["00000000-0000-0000-0000-000000000000"],"documentDate":"string","operationDate":"string","serie":"00000000-0000-0000-0000-000000000000","reference":"string","serieCriteria":true,"referenceCriteria":true,"deliveryAddressCriteria":true,"singleBillPerSaleDeliveryNoteCriteria":true,"transactionDateBehavior":0}},"text/html":{"schema":{"$ref":"#/components/schemas/MassiveSaleDeliveryNoteDTO"},"example":"<MassiveSaleDeliveryNoteDTO> <cancelRest>true</cancelRest> <saleDeliveryNoteIds>00000000-0000-0000-0000-000000000000</saleDeliveryNoteIds> <documentDate>string</documentDate> <operationDate>string</operationDate> <serie>00000000-0000-0000-0000-000000000000</serie> <reference>string</reference> <serieCriteria>true</serieCriteria> <referenceCriteria>true</referenceCriteria> <deliveryAddressCriteria>true</deliveryAddressCriteria> <singleBillPerSaleDeliveryNoteCriteria>true</singleBillPerSaleDeliveryNoteCriteria> <transactionDateBehavior>0</transactionDateBehavior> </MassiveSaleDeliveryNoteDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/MassiveSaleDeliveryNoteDTO"},"example":{"cancelRest":true,"saleDeliveryNoteIds":["00000000-0000-0000-0000-000000000000"],"documentDate":"string","operationDate":"string","serie":"00000000-0000-0000-0000-000000000000","reference":"string","serieCriteria":true,"referenceCriteria":true,"deliveryAddressCriteria":true,"singleBillPerSaleDeliveryNoteCriteria":true,"transactionDateBehavior":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/MassiveSaleDeliveryNoteDTO"},"example":"<MassiveSaleDeliveryNoteDTO> <cancelRest>true</cancelRest> <saleDeliveryNoteIds>00000000-0000-0000-0000-000000000000</saleDeliveryNoteIds> <documentDate>string</documentDate> <operationDate>string</operationDate> <serie>00000000-0000-0000-0000-000000000000</serie> <reference>string</reference> <serieCriteria>true</serieCriteria> <referenceCriteria>true</referenceCriteria> <deliveryAddressCriteria>true</deliveryAddressCriteria> <singleBillPerSaleDeliveryNoteCriteria>true</singleBillPerSaleDeliveryNoteCriteria> <transactionDateBehavior>0</transactionDateBehavior> </MassiveSaleDeliveryNoteDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/MassiveSaleDeliveryNoteDTO"},"example":"<MassiveSaleDeliveryNoteDTO> <cancelRest>true</cancelRest> <saleDeliveryNoteIds>00000000-0000-0000-0000-000000000000</saleDeliveryNoteIds> <documentDate>string</documentDate> <operationDate>string</operationDate> <serie>00000000-0000-0000-0000-000000000000</serie> <reference>string</reference> <serieCriteria>true</serieCriteria> <referenceCriteria>true</referenceCriteria> <deliveryAddressCriteria>true</deliveryAddressCriteria> <singleBillPerSaleDeliveryNoteCriteria>true</singleBillPerSaleDeliveryNoteCriteria> <transactionDateBehavior>0</transactionDateBehavior> </MassiveSaleDeliveryNoteDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleInvoices/{id}":{"get":{"tags":["saleInvoices"],"summary":"Get a sale invoice","description":"Get a sale invoice","operationId":"SaleInvoices_GetById","parameters":[{"name":"id","in":"path","description":"Sale invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleInvoiceDTO"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleInvoiceDTO"}}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["saleInvoices"],"summary":"Delete a sale invoice","description":"Delete a sale invoice","operationId":"SaleInvoices_Delete","parameters":[{"name":"id","in":"path","description":"Sale invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleInvoices/{id}/dues":{"get":{"tags":["saleInvoices"],"summary":"Get the dues of a sale invoice","description":"Get the dues of a sale invoice","operationId":"SaleInvoices_GetDues","parameters":[{"name":"id","in":"path","description":"Sale invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DueDTOArray"},"example":[{"id":"string","date":"string","chargeDate":"string","returnDate":"string","invoiceDate":"string","amount":0,"currency":"string","bankId":"string","payDocumentId":"string","payDocumentDescription":"string","payDocumentRemittable":true,"directDebitId":"string","state":0,"customerName":"string","customerDocument":"string","supplierDocument":"string","invoiceNumber":"string","directDebitBankAccount":"string","directDebitDescription":"string","directDebitSwift":"string","directDebitIsNacional":true,"customerTown":"string","customerCountry":"string","customerMainAddress":"string","customerPostalCode":"string","bankDescription":"string","remitted":true,"remittanceNumber":"string","mandateType":"string","mandateReference":"string","customerId":"string","invoiceId":"string","purchaseInvoiceId":"string","remittanceId":"string","parentDueId":"string","bankStatementCorrelationId":"string","purchaseReference":"string","journala3InnuvaId":"string","returnJournala3InnuvaId":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/DueDTOArray"},"example":"<DueDTOArray> <id>string</id> <date>string</date> <chargeDate>string</chargeDate> <returnDate>string</returnDate> <invoiceDate>string</invoiceDate> <amount>0</amount> <currency>string</currency> <bankId>string</bankId> <payDocumentId>string</payDocumentId> <payDocumentDescription>string</payDocumentDescription> <payDocumentRemittable>true</payDocumentRemittable> <directDebitId>string</directDebitId> <state>0</state> <customerName>string</customerName> <customerDocument>string</customerDocument> <supplierDocument>string</supplierDocument> <invoiceNumber>string</invoiceNumber> <directDebitBankAccount>string</directDebitBankAccount> <directDebitDescription>string</directDebitDescription> <directDebitSwift>string</directDebitSwift> <directDebitIsNacional>true</directDebitIsNacional> <customerTown>string</customerTown> <customerCountry>string</customerCountry> <customerMainAddress>string</customerMainAddress> <customerPostalCode>string</customerPostalCode> <bankDescription>string</bankDescription> <remitted>true</remitted> <remittanceNumber>string</remittanceNumber> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <customerId>string</customerId> <invoiceId>string</invoiceId> <purchaseInvoiceId>string</purchaseInvoiceId> <remittanceId>string</remittanceId> <parentDueId>string</parentDueId> <bankStatementCorrelationId>string</bankStatementCorrelationId> <purchaseReference>string</purchaseReference> <journala3InnuvaId>string</journala3InnuvaId> <returnJournala3InnuvaId>string</returnJournala3InnuvaId> </DueDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleInvoices/{id}/clone":{"get":{"tags":["saleInvoices"],"summary":"Get a clone of a sale invoice","description":"Get a clone of a sale invoice","operationId":"SaleInvoices_GetCloneById","parameters":[{"name":"id","in":"path","description":"Sale invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleInvoiceDTO"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleInvoiceDTO"}}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleInvoices/lineEditInfo":{"get":{"tags":["saleInvoices"],"summary":"Get line fields blocked according to the LATF","description":"Get line fields blocked according to the LATF","operationId":"SaleInvoices_GetEditInfoForInvoiceLines","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditableInfoElectronicInvoiceLinesDTO"},"example":{"product":true,"units":true,"price":true,"taxType":true,"discount":true,"warehouse":true}},"application/xml":{"schema":{"$ref":"#/components/schemas/EditableInfoElectronicInvoiceLinesDTO"},"example":"<EditableInfoElectronicInvoiceLinesDTO> <product>true</product> <units>true</units> <price>true</price> <taxType>true</taxType> <discount>true</discount> <warehouse>true</warehouse> </EditableInfoElectronicInvoiceLinesDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleInvoices/{id}/rectify":{"get":{"tags":["saleInvoices"],"summary":"Get rectify invoice by sale invoice","description":"Get rectify invoice by sale invoice","operationId":"SaleInvoices_GetRectifyInvoiceById","parameters":[{"name":"id","in":"path","description":"Sale invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleInvoiceDTO"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleInvoiceDTO"}}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["saleInvoices"],"summary":"Rectify a sale invoice","description":"Rectify a sale invoice","operationId":"SaleInvoices_RectifyById","parameters":[{"name":"id","in":"path","description":"Sale invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"201":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleInvoices/headerEditInfo":{"get":{"tags":["saleInvoices"],"summary":"Get header fields blocked according to the LATF","description":"Get header fields blocked according to the LATF","operationId":"SaleInvoices_GetEditInfoForInvoiceHeader","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditableInfoElectronicInvoiceHeaderDTO"},"example":{"nif":true,"name":true,"country":true,"selectExistingCustomer":true,"invoiceDate":true,"transactionDate":true,"serie":true,"activity":true,"invoiceNumber":true,"transactionType":true,"invoiceType":true,"taxIncluded":true,"rate":true,"baseAffect":true,"condition":true,"promptPayment":true,"financialSurchage":true,"retentionBase":true,"retention":true,"discount":true}},"application/xml":{"schema":{"$ref":"#/components/schemas/EditableInfoElectronicInvoiceHeaderDTO"},"example":"<EditableInfoElectronicInvoiceHeaderDTO> <nif>true</nif> <name>true</name> <country>true</country> <selectExistingCustomer>true</selectExistingCustomer> <invoiceDate>true</invoiceDate> <transactionDate>true</transactionDate> <serie>true</serie> <activity>true</activity> <invoiceNumber>true</invoiceNumber> <transactionType>true</transactionType> <invoiceType>true</invoiceType> <taxIncluded>true</taxIncluded> <rate>true</rate> <baseAffect>true</baseAffect> <condition>true</condition> <promptPayment>true</promptPayment> <financialSurchage>true</financialSurchage> <retentionBase>true</retentionBase> <retention>true</retention> <discount>true</discount> </EditableInfoElectronicInvoiceHeaderDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleInvoices/{id}/tbaiImage":{"get":{"tags":["saleInvoices"],"summary":"Get a sale invoice TBai Image","description":"Get a sale invoice TBai Image","operationId":"SaleInvoices_GetTBAIFootPrintByInvoiceId","parameters":[{"name":"id","in":"path","description":"Sale invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TBAIFootPrintDTO"},"example":{"identifier":"string","qrImage":[],"qrCode":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TBAIFootPrintDTO"},"example":"<TBAIFootPrintDTO> <identifier>string</identifier> <qrImage /> <qrCode>string</qrCode> </TBAIFootPrintDTO>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TBAIFootPrintDTO"},"example":{"identifier":"string","qrImage":[],"qrCode":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TBAIFootPrintDTO"},"example":"<TBAIFootPrintDTO> <identifier>string</identifier> <qrImage /> <qrCode>string</qrCode> </TBAIFootPrintDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleInvoices/{id}/sentStatus":{"get":{"tags":["saleInvoices"],"summary":"Gets the information about a sent document","description":"Gets the information about a sent document","operationId":"SaleInvoices_SentStatus","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SentDocumentStatusDTO"},"example":{"eMail":"string","sentDate":"string","downloadedDate":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SentDocumentStatusDTO"},"example":"<SentDocumentStatusDTO> <eMail>string</eMail> <sentDate>string</sentDate> <downloadedDate>string</downloadedDate> </SentDocumentStatusDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleInvoices/additionaldata/regimes":{"get":{"tags":["saleInvoices"],"summary":"Get SII regimes types","description":"Get SII regimes types","operationId":"SaleInvoiceA_GetAllRegimeTypes","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiiRegimeTypeDTOArray"},"example":[{"code":"string","description":"string","orderUI":0,"correlationId":"00000000-0000-0000-0000-000000000000","isRectifying":true,"documentType":0}]},"application/xml":{"schema":{"$ref":"#/components/schemas/SiiRegimeTypeDTOArray"},"example":"<SiiRegimeTypeDTOArray> <code>string</code> <description>string</description> <orderUI>0</orderUI> <correlationId>00000000-0000-0000-0000-000000000000</correlationId> <isRectifying>true</isRectifying> <documentType>0</documentType> </SiiRegimeTypeDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleInvoices/additionaldata/invoices":{"get":{"tags":["saleInvoices"],"summary":"Get SII Invoice types","description":"Get SII Invoice types","operationId":"SaleInvoiceA_GetAllInvoiceType","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiiInvoiceTypeDTOArray"},"example":[{"code":"string","description":"string","orderUI":0,"correlationId":"00000000-0000-0000-0000-000000000000","isRectifying":true,"documentType":0}]},"application/xml":{"schema":{"$ref":"#/components/schemas/SiiInvoiceTypeDTOArray"},"example":"<SiiInvoiceTypeDTOArray> <code>string</code> <description>string</description> <orderUI>0</orderUI> <correlationId>00000000-0000-0000-0000-000000000000</correlationId> <isRectifying>true</isRectifying> <documentType>0</documentType> </SiiInvoiceTypeDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleInvoices/new":{"get":{"tags":["saleInvoices"],"summary":"Get a new sale invoice with default values","description":"Get a new sale invoice with default values","operationId":"SaleInvoices_GetNew","parameters":[{"name":"customerId","in":"query","description":"Customer identifier","schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleInvoiceDTO"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleInvoiceDTO"}}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleInvoices/{id}/pdf":{"get":{"tags":["saleInvoices"],"summary":"Get the pdf of the document","description":"Get the pdf of the document","operationId":"SaleInvoices_GetPdf","parameters":[{"name":"id","in":"path","description":"Document identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"templateId","in":"query","description":"Template identifier","schema":{"type":"integer","format":"int32","default":0}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/Response"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"404":{"description":"Not found","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/saleInvoices/newLine":{"get":{"tags":["saleInvoices"],"summary":"Get a new sale invoice line with default values","description":"Get a new sale invoice line with default values","operationId":"SaleInvoices_GetNewLine","parameters":[{"name":"customerId","in":"query","description":"Customer identifier","schema":{"type":"string","format":"uuid"}},{"name":"productId","in":"query","description":"Product identifier","schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleInvoiceLineDTO"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleInvoiceLineDTO"}}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleInvoices/allowcustominvoicenumber":{"get":{"tags":["saleInvoices"],"summary":"Get if is allowed inform custom invoice number","description":"Get if is allowed inform custom invoice number","operationId":"SaleInvoices_AllowCustomInvoiceNumber","parameters":[{"name":"serie","in":"query","description":"Serie identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"activity","in":"query","description":"Activity identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiSaleInvoicesAllowcustominvoicenumberGet200ApplicationJsonResponse"},"example":"True"},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiSaleInvoicesAllowcustominvoicenumberGet200ApplicationXmlResponse"},"example":"<ApiSaleInvoicesAllowcustominvoicenumberGet200ApplicationXmlResponse>true</ApiSaleInvoicesAllowcustominvoicenumberGet200ApplicationXmlResponse>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleInvoices":{"get":{"tags":["saleInvoices"],"summary":"Get all sale invoices","description":"Get all sale invoices","operationId":"SaleInvoices_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlatSaleInvoiceDTOArray"},"example":[{"id":"string","number":"string","date":"string","accountingDate":"string","transactionDate":"string","reference":"string","customerId":"string","customerVATNumber":"string","customerName":"string","email":"string","taxBase":0,"totalTax":0,"total":0,"saleCurrency":"string","saleOperationTypeCode":"string","saleOperationTypeDescription":"string","invoiceType":"string","situation":0,"isRectificative":true,"rectificationType":0,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","antiFraudeLogStatus":0,"aeatResponseCode":"string","aeatResponseDescription":"string","invoiceSent":"string","sifNotApplyReason":0,"sifNotApplyDescriptionMessages":"string","ticketBAILogStatus":0,"ticketBAILogStatusDescription":"string","source":"string","sourceId":"string","activityId":"string","activityDescription":"string","isMigrated":true,"logDate":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/FlatSaleInvoiceDTOArray"},"example":"<FlatSaleInvoiceDTOArray> <id>string</id> <number>string</number> <date>string</date> <accountingDate>string</accountingDate> <transactionDate>string</transactionDate> <reference>string</reference> <customerId>string</customerId> <customerVATNumber>string</customerVATNumber> <customerName>string</customerName> <email>string</email> <taxBase>0</taxBase> <totalTax>0</totalTax> <total>0</total> <saleCurrency>string</saleCurrency> <saleOperationTypeCode>string</saleOperationTypeCode> <saleOperationTypeDescription>string</saleOperationTypeDescription> <invoiceType>string</invoiceType> <situation>0</situation> <isRectificative>true</isRectificative> <rectificationType>0</rectificationType> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <antiFraudeLogStatus>0</antiFraudeLogStatus> <aeatResponseCode>string</aeatResponseCode> <aeatResponseDescription>string</aeatResponseDescription> <invoiceSent>string</invoiceSent> <sifNotApplyReason>0</sifNotApplyReason> <sifNotApplyDescriptionMessages>string</sifNotApplyDescriptionMessages> <ticketBAILogStatus>0</ticketBAILogStatus> <ticketBAILogStatusDescription>string</ticketBAILogStatusDescription> <source>string</source> <sourceId>string</sourceId> <activityId>string</activityId> <activityDescription>string</activityDescription> <isMigrated>true</isMigrated> <logDate>string</logDate> </FlatSaleInvoiceDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["saleInvoices"],"summary":"Update a sale invoice","description":"Update a sale invoice","operationId":"SaleInvoices_Put","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleInvoiceDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/SaleInvoiceDTO"}},"text/html":{"schema":{"$ref":"#/components/schemas/SaleInvoiceDTO"}},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/SaleInvoiceDTO"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleInvoiceDTO"}},"text/xml":{"schema":{"$ref":"#/components/schemas/SaleInvoiceDTO"}},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["saleInvoices"],"summary":"Create a sale invoice","description":"Create a sale invoice","operationId":"SaleInvoices_Post","parameters":[{"name":"draftId","in":"query","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleInvoiceDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/SaleInvoiceDTO"}},"text/html":{"schema":{"$ref":"#/components/schemas/SaleInvoiceDTO"}},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/SaleInvoiceDTO"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleInvoiceDTO"}},"text/xml":{"schema":{"$ref":"#/components/schemas/SaleInvoiceDTO"}},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Created","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleInvoices/export":{"get":{"tags":["saleInvoices"],"summary":"Sale invoice export","description":"Sale invoice export","operationId":"SaleInvoices_Export","parameters":[{"name":"format","in":"query","description":"Export format","schema":{"enum":["Excel"],"type":"string"}},{"name":"headers","in":"query","description":"Headers","schema":{"type":"string"}},{"name":"title","in":"query","description":"Title","schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiSaleInvoicesExportGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiSaleInvoicesExportGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/saleInvoices/extendedExport":{"get":{"tags":["saleInvoices"],"summary":"Export extended sale invoices","description":"Export extended sale invoices","operationId":"SaleInvoices_ExtendedExport","parameters":[{"name":"format","in":"query","description":"Export format","schema":{"enum":["Excel"],"type":"string"}},{"name":"headers","in":"query","description":"Headers","schema":{"type":"string"}},{"name":"title","in":"query","description":"Title","schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiSaleInvoicesExtendedExportGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiSaleInvoicesExtendedExportGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/saleInvoices/{id}/portfolio":{"put":{"tags":["saleInvoices"],"summary":"Update the portfolio of a sale invoice","description":"Update the portfolio of a sale invoice","operationId":"SaleInvoices_SavePortfolio","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioSaleInvoiceDTO"},"example":{"chargeDTOs":[{"id":"string","date":"string","chargeDate":"string","returnDate":"string","invoiceDate":"string","amount":0,"currency":"string","bankId":"string","payDocumentId":"string","payDocumentDescription":"string","payDocumentRemittable":true,"directDebitId":"string","state":0,"customerName":"string","invoiceNumber":"string","directDebitBankAccount":"string","directDebitDescription":"string","directDebitSwift":"string","directDebitIsNacional":true,"bankDescription":"string","remitted":true,"remittanceNumber":"string","mandateType":"string","mandateReference":"string","bankStatementCorrelationId":"string","customerId":"string","invoiceId":"string","remittanceId":"string","isMigrated":true,"journala3InnuvaId":"string","returnJournala3InnuvaId":"string"}]}},"text/json":{"schema":{"$ref":"#/components/schemas/PortfolioSaleInvoiceDTO"},"example":{"chargeDTOs":[{"id":"string","date":"string","chargeDate":"string","returnDate":"string","invoiceDate":"string","amount":0,"currency":"string","bankId":"string","payDocumentId":"string","payDocumentDescription":"string","payDocumentRemittable":true,"directDebitId":"string","state":0,"customerName":"string","invoiceNumber":"string","directDebitBankAccount":"string","directDebitDescription":"string","directDebitSwift":"string","directDebitIsNacional":true,"bankDescription":"string","remitted":true,"remittanceNumber":"string","mandateType":"string","mandateReference":"string","bankStatementCorrelationId":"string","customerId":"string","invoiceId":"string","remittanceId":"string","isMigrated":true,"journala3InnuvaId":"string","returnJournala3InnuvaId":"string"}]}},"text/html":{"schema":{"$ref":"#/components/schemas/PortfolioSaleInvoiceDTO"},"example":"<PortfolioSaleInvoiceDTO> <chargeDTOs> <id>string</id> <date>string</date> <chargeDate>string</chargeDate> <returnDate>string</returnDate> <invoiceDate>string</invoiceDate> <amount>0</amount> <currency>string</currency> <bankId>string</bankId> <payDocumentId>string</payDocumentId> <payDocumentDescription>string</payDocumentDescription> <payDocumentRemittable>true</payDocumentRemittable> <directDebitId>string</directDebitId> <state>0</state> <customerName>string</customerName> <invoiceNumber>string</invoiceNumber> <directDebitBankAccount>string</directDebitBankAccount> <directDebitDescription>string</directDebitDescription> <directDebitSwift>string</directDebitSwift> <directDebitIsNacional>true</directDebitIsNacional> <bankDescription>string</bankDescription> <remitted>true</remitted> <remittanceNumber>string</remittanceNumber> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <bankStatementCorrelationId>string</bankStatementCorrelationId> <customerId>string</customerId> <invoiceId>string</invoiceId> <remittanceId>string</remittanceId> <isMigrated>true</isMigrated> <journala3InnuvaId>string</journala3InnuvaId> <returnJournala3InnuvaId>string</returnJournala3InnuvaId> </chargeDTOs> </PortfolioSaleInvoiceDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PortfolioSaleInvoiceDTO"},"example":{"chargeDTOs":[{"id":"string","date":"string","chargeDate":"string","returnDate":"string","invoiceDate":"string","amount":0,"currency":"string","bankId":"string","payDocumentId":"string","payDocumentDescription":"string","payDocumentRemittable":true,"directDebitId":"string","state":0,"customerName":"string","invoiceNumber":"string","directDebitBankAccount":"string","directDebitDescription":"string","directDebitSwift":"string","directDebitIsNacional":true,"bankDescription":"string","remitted":true,"remittanceNumber":"string","mandateType":"string","mandateReference":"string","bankStatementCorrelationId":"string","customerId":"string","invoiceId":"string","remittanceId":"string","isMigrated":true,"journala3InnuvaId":"string","returnJournala3InnuvaId":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/PortfolioSaleInvoiceDTO"},"example":"<PortfolioSaleInvoiceDTO> <chargeDTOs> <id>string</id> <date>string</date> <chargeDate>string</chargeDate> <returnDate>string</returnDate> <invoiceDate>string</invoiceDate> <amount>0</amount> <currency>string</currency> <bankId>string</bankId> <payDocumentId>string</payDocumentId> <payDocumentDescription>string</payDocumentDescription> <payDocumentRemittable>true</payDocumentRemittable> <directDebitId>string</directDebitId> <state>0</state> <customerName>string</customerName> <invoiceNumber>string</invoiceNumber> <directDebitBankAccount>string</directDebitBankAccount> <directDebitDescription>string</directDebitDescription> <directDebitSwift>string</directDebitSwift> <directDebitIsNacional>true</directDebitIsNacional> <bankDescription>string</bankDescription> <remitted>true</remitted> <remittanceNumber>string</remittanceNumber> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <bankStatementCorrelationId>string</bankStatementCorrelationId> <customerId>string</customerId> <invoiceId>string</invoiceId> <remittanceId>string</remittanceId> <isMigrated>true</isMigrated> <journala3InnuvaId>string</journala3InnuvaId> <returnJournala3InnuvaId>string</returnJournala3InnuvaId> </chargeDTOs> </PortfolioSaleInvoiceDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PortfolioSaleInvoiceDTO"},"example":"<PortfolioSaleInvoiceDTO> <chargeDTOs> <id>string</id> <date>string</date> <chargeDate>string</chargeDate> <returnDate>string</returnDate> <invoiceDate>string</invoiceDate> <amount>0</amount> <currency>string</currency> <bankId>string</bankId> <payDocumentId>string</payDocumentId> <payDocumentDescription>string</payDocumentDescription> <payDocumentRemittable>true</payDocumentRemittable> <directDebitId>string</directDebitId> <state>0</state> <customerName>string</customerName> <invoiceNumber>string</invoiceNumber> <directDebitBankAccount>string</directDebitBankAccount> <directDebitDescription>string</directDebitDescription> <directDebitSwift>string</directDebitSwift> <directDebitIsNacional>true</directDebitIsNacional> <bankDescription>string</bankDescription> <remitted>true</remitted> <remittanceNumber>string</remittanceNumber> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <bankStatementCorrelationId>string</bankStatementCorrelationId> <customerId>string</customerId> <invoiceId>string</invoiceId> <remittanceId>string</remittanceId> <isMigrated>true</isMigrated> <journala3InnuvaId>string</journala3InnuvaId> <returnJournala3InnuvaId>string</returnJournala3InnuvaId> </chargeDTOs> </PortfolioSaleInvoiceDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleInvoices/pdf":{"post":{"tags":["saleInvoices"],"summary":"Print a collection of sale invoices","description":"Print a collection of sale invoices","operationId":"SaleInvoices_QueuePdfs","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":{"templateId":"string","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"text/json":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":{"templateId":"string","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"text/html":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":"<PrintCommand> <templateId>string</templateId> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </PrintCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":{"templateId":"string","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":"<PrintCommand> <templateId>string</templateId> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </PrintCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":"<PrintCommand> <templateId>string</templateId> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </PrintCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleInvoices/send":{"post":{"tags":["saleInvoices"],"summary":"Send a collection of sale invoices","description":"Send a collection of sale invoices","operationId":"SaleInvoices_SendDocuments","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCommand"},"example":{"templateId":"string","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"text/json":{"schema":{"$ref":"#/components/schemas/SendCommand"},"example":{"templateId":"string","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"text/html":{"schema":{"$ref":"#/components/schemas/SendCommand"},"example":"<SendCommand> <templateId>string</templateId> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </SendCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/SendCommand"},"example":{"templateId":"string","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/SendCommand"},"example":"<SendCommand> <templateId>string</templateId> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </SendCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/SendCommand"},"example":"<SendCommand> <templateId>string</templateId> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </SendCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleInvoices/reportsummary":{"post":{"tags":["saleInvoices"],"summary":"Get sale invoices summary","description":"Get sale invoices summary","operationId":"SaleInvoices_GetReport","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Template identifier","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportRequest"},"example":{"template":"string","parameters":[{"name":"string","value":{}}]}},"text/json":{"schema":{"$ref":"#/components/schemas/ReportRequest"},"example":{"template":"string","parameters":[{"name":"string","value":{}}]}},"text/html":{"schema":{"$ref":"#/components/schemas/ReportRequest"},"example":"<ReportRequest> <template>string</template> <parameters> <name>string</name> <value /> </parameters> </ReportRequest>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ReportRequest"},"example":{"template":"string","parameters":[{"name":"string","value":{}}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/ReportRequest"},"example":"<ReportRequest> <template>string</template> <parameters> <name>string</name> <value /> </parameters> </ReportRequest>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ReportRequest"},"example":"<ReportRequest> <template>string</template> <parameters> <name>string</name> <value /> </parameters> </ReportRequest>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/Response"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"404":{"description":"Not found","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/saleInvoices/issuedInvoicesReport":{"post":{"tags":["saleInvoices"],"summary":"Get sale invoices emitted","description":"Get sale invoices emitted","operationId":"SaleInvoices_GetListIVA","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"List of parameters to configure the report","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportRequest"},"example":{"template":"string","parameters":[{"name":"string","value":{}}]}},"text/json":{"schema":{"$ref":"#/components/schemas/ReportRequest"},"example":{"template":"string","parameters":[{"name":"string","value":{}}]}},"text/html":{"schema":{"$ref":"#/components/schemas/ReportRequest"},"example":"<ReportRequest> <template>string</template> <parameters> <name>string</name> <value /> </parameters> </ReportRequest>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ReportRequest"},"example":{"template":"string","parameters":[{"name":"string","value":{}}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/ReportRequest"},"example":"<ReportRequest> <template>string</template> <parameters> <name>string</name> <value /> </parameters> </ReportRequest>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ReportRequest"},"example":"<ReportRequest> <template>string</template> <parameters> <name>string</name> <value /> </parameters> </ReportRequest>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiSaleInvoicesIssuedInvoicesReportPost200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"404":{"description":"Not found","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/saleInvoices/{id}/dues/{dueId}/cancel":{"post":{"tags":["saleInvoices"],"summary":"Cancel a due","description":"Cancel a due","operationId":"SaleInvoices_Cancel","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"dueId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Cancel correctly","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Could not be saved","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleInvoices/{id}/dues/{dueId}/charge":{"post":{"tags":["saleInvoices"],"summary":"Charge a due","description":"Charge a due","operationId":"SaleInvoices_Charge","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"dueId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargeCommand"},"example":{"date":"string","ammount":0,"bankId":"string","paymentDocumentId":"string","directDebitId":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/ChargeCommand"},"example":{"date":"string","ammount":0,"bankId":"string","paymentDocumentId":"string","directDebitId":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/ChargeCommand"},"example":"<ChargeCommand> <date>string</date> <ammount>0</ammount> <bankId>string</bankId> <paymentDocumentId>string</paymentDocumentId> <directDebitId>string</directDebitId> </ChargeCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ChargeCommand"},"example":{"date":"string","ammount":0,"bankId":"string","paymentDocumentId":"string","directDebitId":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ChargeCommand"},"example":"<ChargeCommand> <date>string</date> <ammount>0</ammount> <bankId>string</bankId> <paymentDocumentId>string</paymentDocumentId> <directDebitId>string</directDebitId> </ChargeCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ChargeCommand"},"example":"<ChargeCommand> <date>string</date> <ammount>0</ammount> <bankId>string</bankId> <paymentDocumentId>string</paymentDocumentId> <directDebitId>string</directDebitId> </ChargeCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleInvoices/{id}/dues/{dueId}/return":{"post":{"tags":["saleInvoices"],"summary":"Return a due","description":"Return a due","operationId":"SaleInvoices_Return","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"dueId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnCommand"},"example":{"date":"string","ammount":0,"paymentDocumentId":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/ReturnCommand"},"example":{"date":"string","ammount":0,"paymentDocumentId":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/ReturnCommand"},"example":"<ReturnCommand> <date>string</date> <ammount>0</ammount> <paymentDocumentId>string</paymentDocumentId> </ReturnCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ReturnCommand"},"example":{"date":"string","ammount":0,"paymentDocumentId":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ReturnCommand"},"example":"<ReturnCommand> <date>string</date> <ammount>0</ammount> <paymentDocumentId>string</paymentDocumentId> </ReturnCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ReturnCommand"},"example":"<ReturnCommand> <date>string</date> <ammount>0</ammount> <paymentDocumentId>string</paymentDocumentId> </ReturnCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Returned correctly","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Could not be saved","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleInvoices/{id}/dues/{dueId}/cancelReturn":{"post":{"tags":["saleInvoices"],"summary":"Cancel a return a due","description":"Cancel a return a due","operationId":"SaleInvoices_CancelReturn","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"dueId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Cancel return correctly","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Could not be saved","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleInvoices/{id}/send":{"post":{"tags":["saleInvoices"],"summary":"Send sale invoice","description":"Send sale invoice","operationId":"SaleInvoices_Send","parameters":[{"name":"id","in":"path","description":"Document identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"templateId","in":"query","description":"Template identifier","schema":{"type":"integer","format":"int32","default":0}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOffers/{id}":{"get":{"tags":["saleOffers"],"summary":"Get a sale offer","description":"Get a sale offer","operationId":"SaleOffers_GetById","parameters":[{"name":"id","in":"path","description":"Sale offer identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleOfferDTO"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleOfferDTO"}}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["saleOffers"],"summary":"Delete a sale offer","description":"Delete a sale offer","operationId":"SaleOffers_Delete","parameters":[{"name":"id","in":"path","description":"Sale offer identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOffers/{id}/clone":{"get":{"tags":["saleOffers"],"summary":"Get a clone of a sale offer","description":"Get a clone of a sale offer","operationId":"SaleOffers_GetCloneById","parameters":[{"name":"id","in":"path","description":"Sale offer identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleOfferDTO"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleOfferDTO"}}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOffers/{id}/sentStatus":{"get":{"tags":["saleOffers"],"summary":"Gets the information about a sent document","description":"Gets the information about a sent document","operationId":"SaleOffers_SentStatus","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SentDocumentStatusDTO"},"example":{"eMail":"string","sentDate":"string","downloadedDate":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SentDocumentStatusDTO"},"example":"<SentDocumentStatusDTO> <eMail>string</eMail> <sentDate>string</sentDate> <downloadedDate>string</downloadedDate> </SentDocumentStatusDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOffers/{id}/circuitinfo":{"get":{"tags":["saleOffers"],"summary":"Get circuit info lines","description":"Get circuit info lines","operationId":"SaleOffers_CircuitInfoLines","parameters":[{"name":"id","in":"path","description":"Circuit info lines","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CircuitInfoDTOArray"},"example":[{"lineId":"string","description":"string","units":0,"lineBase":0,"situation":0,"cancelledUnits":0,"pendingUnits":0,"confirmedUnits":0,"deliveredUnits":0,"billedUnits":0}]},"application/xml":{"schema":{"$ref":"#/components/schemas/CircuitInfoDTOArray"},"example":"<CircuitInfoDTOArray> <lineId>string</lineId> <description>string</description> <units>0</units> <lineBase>0</lineBase> <situation>0</situation> <cancelledUnits>0</cancelledUnits> <pendingUnits>0</pendingUnits> <confirmedUnits>0</confirmedUnits> <deliveredUnits>0</deliveredUnits> <billedUnits>0</billedUnits> </CircuitInfoDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOffers/new":{"get":{"tags":["saleOffers"],"summary":"Get a new sale offers with default values","description":"Get a new sale offers with default values","operationId":"SaleOffers_GetNew","parameters":[{"name":"customerId","in":"query","description":"Customer identifier","schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleOfferDTO"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleOfferDTO"}}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOffers/{id}/pdf":{"get":{"tags":["saleOffers"],"summary":"Get the pdf of the document","description":"Get the pdf of the document","operationId":"SaleOffers_GetPdf","parameters":[{"name":"id","in":"path","description":"Document identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"templateId","in":"query","description":"Template identifier","schema":{"type":"integer","format":"int32","default":0}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/Response"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"404":{"description":"Not found","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/saleOffers/{id}/line/{lineId}/documentlineinfo":{"get":{"tags":["saleOffers"],"summary":"Get document line info","description":"Get document line info","operationId":"SaleOffers_GetDocumentLineInfo","parameters":[{"name":"id","in":"path","description":"Document id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"lineId","in":"path","description":"Line id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentLineInfoDTOArray"},"example":[{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/DocumentLineInfoDTOArray"},"example":"<DocumentLineInfoDTOArray> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </DocumentLineInfoDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOffers/{id}/line/{lineId}/destinationdocumentscount":{"get":{"tags":["saleOffers"],"summary":"Get destination documents count","description":"Get destination documents count","operationId":"SaleOffers_DestinationDocumentsCount","parameters":[{"name":"id","in":"path","description":"Document id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"lineId","in":"path","description":"Line id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiSaleOffersIdLineLineIdDestinationdocumentscountGet200ApplicationJsonRespo"},"example":0},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiSaleOffersIdLineLineIdDestinationdocumentscountGet200ApplicationXmlRespon"},"example":"<ApiSaleOffersIdLineLineIdDestinationdocumentscountGet200ApplicationXmlRespon>0</ApiSaleOffersIdLineLineIdDestinationdocumentscountGet200ApplicationXmlRespon>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOffers/newLine":{"get":{"tags":["saleOffers"],"summary":"Get a new sale offer line with default values","description":"Get a new sale offer line with default values","operationId":"SaleOffers_GetNewLine","parameters":[{"name":"customerId","in":"query","description":"Customer identifier","schema":{"type":"string","format":"uuid"}},{"name":"productId","in":"query","description":"Product identifier","schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleOfferLineDTO"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleOfferLineDTO"}}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOffers":{"get":{"tags":["saleOffers"],"summary":"Get all sale offers","description":"Get all sale offers","operationId":"SaleOffers_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlatSaleOfferDTOArray"},"example":[{"id":"string","state":"string","situation":"string","number":"string","reference":"string","date":"string","expirationDate":"string","customerId":"string","customerVATNumber":"string","customerName":"string","email":"string","totalTax":0,"taxBase":0,"total":0,"saleCurrency":"string","saleOperationTypeCode":"string","saleOperationTypeDescription":"string","source":"string","sourceId":"string","activityId":"string","activityDescription":"string","emailCC":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/FlatSaleOfferDTOArray"},"example":"<FlatSaleOfferDTOArray> <id>string</id> <state>string</state> <situation>string</situation> <number>string</number> <reference>string</reference> <date>string</date> <expirationDate>string</expirationDate> <customerId>string</customerId> <customerVATNumber>string</customerVATNumber> <customerName>string</customerName> <email>string</email> <totalTax>0</totalTax> <taxBase>0</taxBase> <total>0</total> <saleCurrency>string</saleCurrency> <saleOperationTypeCode>string</saleOperationTypeCode> <saleOperationTypeDescription>string</saleOperationTypeDescription> <source>string</source> <sourceId>string</sourceId> <activityId>string</activityId> <activityDescription>string</activityDescription> <emailCC>string</emailCC> </FlatSaleOfferDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["saleOffers"],"summary":"Update a sale offer","description":"Update a sale offer","operationId":"SaleOffers_Put","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleOfferDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/SaleOfferDTO"}},"text/html":{"schema":{"$ref":"#/components/schemas/SaleOfferDTO"}},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/SaleOfferDTO"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleOfferDTO"}},"text/xml":{"schema":{"$ref":"#/components/schemas/SaleOfferDTO"}},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["saleOffers"],"summary":"Create a sale offer","description":"Create a sale offer","operationId":"SaleOffers_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleOfferDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/SaleOfferDTO"}},"text/html":{"schema":{"$ref":"#/components/schemas/SaleOfferDTO"}},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/SaleOfferDTO"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleOfferDTO"}},"text/xml":{"schema":{"$ref":"#/components/schemas/SaleOfferDTO"}},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOffers/export":{"get":{"tags":["saleOffers"],"summary":"Sale offers export","description":"Sale offers export","operationId":"SaleOffers_Export","parameters":[{"name":"format","in":"query","description":"Export format","schema":{"enum":["Excel"],"type":"string"}},{"name":"headers","in":"query","description":"Headers","schema":{"type":"string"}},{"name":"title","in":"query","description":"Title","schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiSaleOffersExportGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiSaleOffersExportGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/saleOffers/extendedExport":{"get":{"tags":["saleOffers"],"summary":"sale offers extended export","description":"sale offers extended export","operationId":"SaleOffers_ExtendedExport","parameters":[{"name":"format","in":"query","description":"Export format","schema":{"enum":["Excel"],"type":"string"}},{"name":"headers","in":"query","description":"Headers","schema":{"type":"string"}},{"name":"title","in":"query","description":"Title","schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiSaleOffersExtendedExportGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiSaleOffersExtendedExportGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/saleOffers/{id}/bill":{"post":{"tags":["saleOffers"],"summary":"Bill sale offer","description":"Bill sale offer","operationId":"SaleOffers_Bill","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommandBill"}},"text/json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommandBill"}},"text/html":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommandBill"}},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommandBill"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommandBill"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommandBill"}},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOffers/{id}/state":{"post":{"tags":["saleOffers"],"summary":"Update state of a sale offer","description":"Update state of a sale offer","operationId":"SaleOffers_UpdateState","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateCommand"},"example":{"offerState":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/StateCommand"},"example":{"offerState":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/StateCommand"},"example":"<StateCommand> <offerState>string</offerState> </StateCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/StateCommand"},"example":{"offerState":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/StateCommand"},"example":"<StateCommand> <offerState>string</offerState> </StateCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/StateCommand"},"example":"<StateCommand> <offerState>string</offerState> </StateCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOffers/{id}/confirm":{"post":{"tags":["saleOffers"],"summary":"Confirm sale offer","description":"Confirm sale offer","operationId":"SaleOffers_Confirm","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"text/json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"text/html":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOffers/{id}/delivery":{"post":{"tags":["saleOffers"],"summary":"Delivery sale offer","description":"Delivery sale offer","operationId":"SaleOffers_Delivery","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"text/json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"text/html":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOffers/{id}/send":{"post":{"tags":["saleOffers"],"summary":"Send sale offer","description":"Send sale offer","operationId":"SaleOffers_Send","parameters":[{"name":"id","in":"path","description":"Document identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"templateId","in":"query","description":"Template identifier","schema":{"type":"integer","format":"int32","default":0}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOperationTypes/taxTypeIsCompatible":{"get":{"tags":["saleOperationTypes"],"summary":"Get skip video value","description":"Get skip video value","operationId":"SaleOperationTypes_TaxTypeIsCompatible","parameters":[{"name":"taxTypeCode","in":"query","required":true,"schema":{"type":"string"}},{"name":"saleOperationCode","in":"query","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiSaleOperationTypesTaxTypeIsCompatibleGet200ApplicationJsonResponse"},"example":"True"},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiSaleOperationTypesTaxTypeIsCompatibleGet200ApplicationXmlResponse"},"example":"<ApiSaleOperationTypesTaxTypeIsCompatibleGet200ApplicationXmlResponse>true</ApiSaleOperationTypesTaxTypeIsCompatibleGet200ApplicationXmlResponse>"}}}}}},"/api/saleOperationTypes":{"get":{"tags":["saleOperationTypes"],"summary":"Get all sale operation types","description":"Get all sale operation types","operationId":"SaleOperationTypes_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleOperationTypeDTOArray"},"example":[{"code":"string","description":"string","applyTax":true,"applyEquivalenceSurcharge":true}]},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleOperationTypeDTOArray"},"example":"<SaleOperationTypeDTOArray> <code>string</code> <description>string</description> <applyTax>true</applyTax> <applyEquivalenceSurcharge>true</applyEquivalenceSurcharge> </SaleOperationTypeDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOrders/{id}":{"get":{"tags":["saleOrders"],"summary":"Get a sale order","description":"Get a sale order","operationId":"SaleOrders_GetById","parameters":[{"name":"id","in":"path","description":"Sale order identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleOrderDTO"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleOrderDTO"}}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["saleOrders"],"summary":"Delete a sale order","description":"Delete a sale order","operationId":"SaleOrders_Delete","parameters":[{"name":"id","in":"path","description":"Sale order identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOrders/{id}/sentStatus":{"get":{"tags":["saleOrders"],"summary":"Gets the information about a sent document","description":"Gets the information about a sent document","operationId":"SaleOrders_SentStatus","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SentDocumentStatusDTO"},"example":{"eMail":"string","sentDate":"string","downloadedDate":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SentDocumentStatusDTO"},"example":"<SentDocumentStatusDTO> <eMail>string</eMail> <sentDate>string</sentDate> <downloadedDate>string</downloadedDate> </SentDocumentStatusDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOrders/{id}/circuitinfo":{"get":{"tags":["saleOrders"],"summary":"Get circuit info lines","description":"Get circuit info lines","operationId":"SaleOrders_CircuitInfoLines","parameters":[{"name":"id","in":"path","description":"Circuit info lines","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CircuitInfoDTOArray"},"example":[{"lineId":"string","description":"string","units":0,"lineBase":0,"situation":0,"cancelledUnits":0,"pendingUnits":0,"confirmedUnits":0,"deliveredUnits":0,"billedUnits":0}]},"application/xml":{"schema":{"$ref":"#/components/schemas/CircuitInfoDTOArray"},"example":"<CircuitInfoDTOArray> <lineId>string</lineId> <description>string</description> <units>0</units> <lineBase>0</lineBase> <situation>0</situation> <cancelledUnits>0</cancelledUnits> <pendingUnits>0</pendingUnits> <confirmedUnits>0</confirmedUnits> <deliveredUnits>0</deliveredUnits> <billedUnits>0</billedUnits> </CircuitInfoDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOrders/new":{"get":{"tags":["saleOrders"],"summary":"Get a new sale order with default values","description":"Get a new sale order with default values","operationId":"SaleOrders_GetNew","parameters":[{"name":"customerId","in":"query","description":"Customer identifier","schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleOrderDTO"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleOrderDTO"}}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOrders/{id}/pdf":{"get":{"tags":["saleOrders"],"summary":"Get the pdf of the document","description":"Get the pdf of the document","operationId":"SaleOrders_GetPdf","parameters":[{"name":"id","in":"path","description":"Document identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"templateId","in":"query","description":"Template identifier","schema":{"type":"integer","format":"int32","default":0}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/Response"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"404":{"description":"Not found","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/saleOrders/{id}/line/{lineId}/documentlineinfo":{"get":{"tags":["saleOrders"],"summary":"Get document line info","description":"Get document line info","operationId":"SaleOrders_GetDocumentLineInfo","parameters":[{"name":"id","in":"path","description":"Document id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"lineId","in":"path","description":"Line id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentLineInfoDTOArray"},"example":[{"id":"string","documentType":0,"number":"string","units":0,"date":"string","reference":"string","lineId":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/DocumentLineInfoDTOArray"},"example":"<DocumentLineInfoDTOArray> <id>string</id> <documentType>0</documentType> <number>string</number> <units>0</units> <date>string</date> <reference>string</reference> <lineId>string</lineId> </DocumentLineInfoDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOrders/{id}/line/{lineId}/destinationdocumentscount":{"get":{"tags":["saleOrders"],"summary":"Get destination documents count","description":"Get destination documents count","operationId":"SaleOrders_DestinationDocumentsCount","parameters":[{"name":"id","in":"path","description":"Document id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"lineId","in":"path","description":"Line id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiSaleOrdersIdLineLineIdDestinationdocumentscountGet200ApplicationJsonRespo"},"example":0},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiSaleOrdersIdLineLineIdDestinationdocumentscountGet200ApplicationXmlRespon"},"example":"<ApiSaleOrdersIdLineLineIdDestinationdocumentscountGet200ApplicationXmlRespon>0</ApiSaleOrdersIdLineLineIdDestinationdocumentscountGet200ApplicationXmlRespon>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOrders/newLine":{"get":{"tags":["saleOrders"],"summary":"Get a new sale order line with default values","description":"Get a new sale order line with default values","operationId":"SaleOrders_GetNewLine","parameters":[{"name":"customerId","in":"query","description":"Customer identifier","schema":{"type":"string","format":"uuid"}},{"name":"productId","in":"query","description":"Product identifier","schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleOrderLineDTO"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleOrderLineDTO"}}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOrders":{"get":{"tags":["saleOrders"],"summary":"Get all sale orders","description":"Get all sale orders","operationId":"SaleOrders_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlatSaleOrderDTOArray"},"example":[{"id":"string","number":"string","date":"string","deliveryDate":"string","reference":"string","customerVATNumber":"string","customerName":"string","email":"string","taxBase":0,"taxTotal":0,"total":0,"saleCurrency":"string","saleOperationTypeCode":"string","saleOperationTypeDescription":"string","situation":"string","source":"string","sourceId":"string","activityId":"string","activityDescription":"string","emailCC":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/FlatSaleOrderDTOArray"},"example":"<FlatSaleOrderDTOArray> <id>string</id> <number>string</number> <date>string</date> <deliveryDate>string</deliveryDate> <reference>string</reference> <customerVATNumber>string</customerVATNumber> <customerName>string</customerName> <email>string</email> <taxBase>0</taxBase> <taxTotal>0</taxTotal> <total>0</total> <saleCurrency>string</saleCurrency> <saleOperationTypeCode>string</saleOperationTypeCode> <saleOperationTypeDescription>string</saleOperationTypeDescription> <situation>string</situation> <source>string</source> <sourceId>string</sourceId> <activityId>string</activityId> <activityDescription>string</activityDescription> <emailCC>string</emailCC> </FlatSaleOrderDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["saleOrders"],"summary":"Update a sale order","description":"Update a sale order","operationId":"SaleOrders_Put","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleOrderDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/SaleOrderDTO"}},"text/html":{"schema":{"$ref":"#/components/schemas/SaleOrderDTO"}},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/SaleOrderDTO"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleOrderDTO"}},"text/xml":{"schema":{"$ref":"#/components/schemas/SaleOrderDTO"}},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["saleOrders"],"summary":"Create a sale order","description":"Create a sale order","operationId":"SaleOrders_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleOrderDTO"}},"text/json":{"schema":{"$ref":"#/components/schemas/SaleOrderDTO"}},"text/html":{"schema":{"$ref":"#/components/schemas/SaleOrderDTO"}},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/SaleOrderDTO"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SaleOrderDTO"}},"text/xml":{"schema":{"$ref":"#/components/schemas/SaleOrderDTO"}},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOrders/export":{"get":{"tags":["saleOrders"],"summary":"Sale orders export","description":"Sale orders export","operationId":"SaleOrders_Export","parameters":[{"name":"format","in":"query","description":"Export format","schema":{"enum":["Excel"],"type":"string"}},{"name":"headers","in":"query","description":"Headers","schema":{"type":"string"}},{"name":"title","in":"query","description":"Title","schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiSaleOrdersExportGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiSaleOrdersExportGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/saleOrders/pdf":{"post":{"tags":["saleOrders"],"summary":"Print a collection of sale orders","description":"Print a collection of sale orders","operationId":"SaleOrders_QueuePdfs","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":{"templateId":"string","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"text/json":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":{"templateId":"string","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"text/html":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":"<PrintCommand> <templateId>string</templateId> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </PrintCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":{"templateId":"string","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":"<PrintCommand> <templateId>string</templateId> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </PrintCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PrintCommand"},"example":"<PrintCommand> <templateId>string</templateId> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </PrintCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOrders/send":{"post":{"tags":["saleOrders"],"summary":"Send a collection of sale orders","description":"Send a collection of sale orders","operationId":"SaleOrders_SendDocuments","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCommand"},"example":{"templateId":"string","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"text/json":{"schema":{"$ref":"#/components/schemas/SendCommand"},"example":{"templateId":"string","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"text/html":{"schema":{"$ref":"#/components/schemas/SendCommand"},"example":"<SendCommand> <templateId>string</templateId> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </SendCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/SendCommand"},"example":{"templateId":"string","searchBy":"string","filter":"string","selectedIds":["string"],"excludedIds":["string"],"state":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/SendCommand"},"example":"<SendCommand> <templateId>string</templateId> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </SendCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/SendCommand"},"example":"<SendCommand> <templateId>string</templateId> <searchBy>string</searchBy> <filter>string</filter> <selectedIds>string</selectedIds> <excludedIds>string</excludedIds> <state>0</state> </SendCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOrders/{id}/bill":{"post":{"tags":["saleOrders"],"summary":"Bill sale order","description":"Bill sale order","operationId":"SaleOrders_Bill","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommandBill"}},"text/json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommandBill"}},"text/html":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommandBill"}},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommandBill"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommandBill"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommandBill"}},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOrders/{id}/deliver":{"post":{"tags":["saleOrders"],"summary":"Deliver sale order","description":"Deliver sale order","operationId":"SaleOrders_Deliver","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"text/json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"text/html":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ServeDocumentCommand"}},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/saleOrders/{id}/send":{"post":{"tags":["saleOrders"],"summary":"Send a sale order","description":"Send a sale order","operationId":"SaleOrders_Send","parameters":[{"name":"id","in":"path","description":"Document identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"templateId","in":"query","description":"Template identifier","schema":{"type":"integer","format":"int32","default":0}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/series/{id}":{"get":{"tags":["series"],"summary":"Get a serie by identifier","description":"Get a serie by identifier","operationId":"Series_GetById","parameters":[{"name":"id","in":"path","description":"The serie id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerieDTO"},"example":{"id":"string","code":"string","description":"string","a3InnuvaActivityId":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SerieDTO"},"example":"<SerieDTO> <id>string</id> <code>string</code> <description>string</description> <a3InnuvaActivityId>string</a3InnuvaActivityId> </SerieDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["series"],"summary":"Delete a serie by identifier","description":"Delete a serie by identifier","operationId":"Series_Delete","parameters":[{"name":"id","in":"path","description":"serie identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"patch":{"tags":["series"],"summary":"Update specific properties of a serie","description":"Update specific properties of a serie","operationId":"Series_Patch","parameters":[{"name":"id","in":"path","description":"serie identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Collection of {a3ERP.Public.Resources.V2.PatchOperation}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/html":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/series":{"get":{"tags":["series"],"summary":"Get all series","description":"Get all series","operationId":"Series_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlatSerieDTOArray"},"example":[{"id":"string","code":"string","description":"string","a3InnuvaActivityId":"string","a3InnuvaActivityShortDescription":"string","isLAFTDisabled":true,"laftDisabledConfirmation":true}]},"application/xml":{"schema":{"$ref":"#/components/schemas/FlatSerieDTOArray"},"example":"<FlatSerieDTOArray> <id>string</id> <code>string</code> <description>string</description> <a3InnuvaActivityId>string</a3InnuvaActivityId> <a3InnuvaActivityShortDescription>string</a3InnuvaActivityShortDescription> <isLAFTDisabled>true</isLAFTDisabled> <laftDisabledConfirmation>true</laftDisabledConfirmation> </FlatSerieDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["series"],"summary":"Add a new serie","description":"Add a new serie","operationId":"Series_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Serie identifier","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerieDTO"},"example":{"id":"string","code":"string","description":"string","a3InnuvaActivityId":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/SerieDTO"},"example":{"id":"string","code":"string","description":"string","a3InnuvaActivityId":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/SerieDTO"},"example":"<SerieDTO> <id>string</id> <code>string</code> <description>string</description> <a3InnuvaActivityId>string</a3InnuvaActivityId> </SerieDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/SerieDTO"},"example":{"id":"string","code":"string","description":"string","a3InnuvaActivityId":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SerieDTO"},"example":"<SerieDTO> <id>string</id> <code>string</code> <description>string</description> <a3InnuvaActivityId>string</a3InnuvaActivityId> </SerieDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/SerieDTO"},"example":"<SerieDTO> <id>string</id> <code>string</code> <description>string</description> <a3InnuvaActivityId>string</a3InnuvaActivityId> </SerieDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Created","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/series/{idSerie}/antifraud/config":{"put":{"tags":["series"],"summary":"Update antifraud config of an serie","description":"Update antifraud config of an serie","operationId":"Series_Put","parameters":[{"name":"idSerie","in":"path","description":"idSerie","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"antifraudConfig","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerieAntifraudConfigDTO"},"example":{"isLAFTDisabled":true,"laftDisabledConfirmation":true}},"text/json":{"schema":{"$ref":"#/components/schemas/SerieAntifraudConfigDTO"},"example":{"isLAFTDisabled":true,"laftDisabledConfirmation":true}},"text/html":{"schema":{"$ref":"#/components/schemas/SerieAntifraudConfigDTO"},"example":"<SerieAntifraudConfigDTO> <isLAFTDisabled>true</isLAFTDisabled> <laftDisabledConfirmation>true</laftDisabledConfirmation> </SerieAntifraudConfigDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/SerieAntifraudConfigDTO"},"example":{"isLAFTDisabled":true,"laftDisabledConfirmation":true}},"application/xml":{"schema":{"$ref":"#/components/schemas/SerieAntifraudConfigDTO"},"example":"<SerieAntifraudConfigDTO> <isLAFTDisabled>true</isLAFTDisabled> <laftDisabledConfirmation>true</laftDisabledConfirmation> </SerieAntifraudConfigDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/SerieAntifraudConfigDTO"},"example":"<SerieAntifraudConfigDTO> <isLAFTDisabled>true</isLAFTDisabled> <laftDisabledConfirmation>true</laftDisabledConfirmation> </SerieAntifraudConfigDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/stock/query":{"post":{"tags":["stock"],"summary":"Stock query","description":"Stock query","operationId":"Stock_Query","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"List of parameters to generate the stock query report","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryStockCommand"},"example":{"stockFilter":0,"stockUnits":0,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","dateTo":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/QueryStockCommand"},"example":{"stockFilter":0,"stockUnits":0,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","dateTo":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/QueryStockCommand"},"example":"<QueryStockCommand> <stockFilter>0</stockFilter> <stockUnits>0</stockUnits> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <dateTo>string</dateTo> </QueryStockCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/QueryStockCommand"},"example":{"stockFilter":0,"stockUnits":0,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","dateTo":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/QueryStockCommand"},"example":"<QueryStockCommand> <stockFilter>0</stockFilter> <stockUnits>0</stockUnits> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <dateTo>string</dateTo> </QueryStockCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/QueryStockCommand"},"example":"<QueryStockCommand> <stockFilter>0</stockFilter> <stockUnits>0</stockUnits> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <dateTo>string</dateTo> </QueryStockCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/stock/movements":{"post":{"tags":["stock"],"summary":"Stock movements by product and dates","description":"Stock movements by product and dates","operationId":"Stock_Movements","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"List of parameters to generate the stock movement report","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockMovementCommand"},"example":{"productId":"string","startDate":"string","endDate":"string","warehouseCorrelationId":"00000000-0000-0000-0000-000000000000"}},"text/json":{"schema":{"$ref":"#/components/schemas/StockMovementCommand"},"example":{"productId":"string","startDate":"string","endDate":"string","warehouseCorrelationId":"00000000-0000-0000-0000-000000000000"}},"text/html":{"schema":{"$ref":"#/components/schemas/StockMovementCommand"},"example":"<StockMovementCommand> <productId>string</productId> <startDate>string</startDate> <endDate>string</endDate> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> </StockMovementCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/StockMovementCommand"},"example":{"productId":"string","startDate":"string","endDate":"string","warehouseCorrelationId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/StockMovementCommand"},"example":"<StockMovementCommand> <productId>string</productId> <startDate>string</startDate> <endDate>string</endDate> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> </StockMovementCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/StockMovementCommand"},"example":"<StockMovementCommand> <productId>string</productId> <startDate>string</startDate> <endDate>string</endDate> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> </StockMovementCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/subscription/{name}":{"get":{"tags":["subscription"],"summary":"Get subscription application","description":"Get subscription application","operationId":"Subscription_GetByName","parameters":[{"name":"name","in":"path","description":"The application name","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionDTO"},"example":{"applicationName":"string","state":0,"reason":"string","backOfficeURL":"string","frontOfficeURL":"string","secret":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SubscriptionDTO"},"example":"<SubscriptionDTO> <applicationName>string</applicationName> <state>0</state> <reason>string</reason> <backOfficeURL>string</backOfficeURL> <frontOfficeURL>string</frontOfficeURL> <secret>string</secret> </SubscriptionDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["subscription"],"summary":"Change subscription application","description":"Change subscription application","operationId":"Subscription_Put","parameters":[{"name":"name","in":"path","description":"Application name","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Subscription command","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionCommand"},"example":{"state":0,"reason":"string","backOfficeURL":"string","frontOfficeURL":"string","secret":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/SubscriptionCommand"},"example":{"state":0,"reason":"string","backOfficeURL":"string","frontOfficeURL":"string","secret":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/SubscriptionCommand"},"example":"<SubscriptionCommand> <state>0</state> <reason>string</reason> <backOfficeURL>string</backOfficeURL> <frontOfficeURL>string</frontOfficeURL> <secret>string</secret> </SubscriptionCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/SubscriptionCommand"},"example":{"state":0,"reason":"string","backOfficeURL":"string","frontOfficeURL":"string","secret":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SubscriptionCommand"},"example":"<SubscriptionCommand> <state>0</state> <reason>string</reason> <backOfficeURL>string</backOfficeURL> <frontOfficeURL>string</frontOfficeURL> <secret>string</secret> </SubscriptionCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/SubscriptionCommand"},"example":"<SubscriptionCommand> <state>0</state> <reason>string</reason> <backOfficeURL>string</backOfficeURL> <frontOfficeURL>string</frontOfficeURL> <secret>string</secret> </SubscriptionCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/suppliers/new":{"get":{"tags":["suppliers"],"summary":"Get a new supplier with default values","description":"Get a new supplier with default values","operationId":"Suppliers_GetNew","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierDTO"},"example":{"id":"string","creationDate":"string","vatNumber":"string","vatNumberType":0,"supplierType":"string","code":"string","name":"string","businessName":"string","web":"string","address":{"correlationId":"string","street":"string","town":"string","zipCode":"string","provinceCode":"string","provinceName":"string","countryCode":"string","localization":"string"},"phone":"string","mail":"string","isSameAddress":true,"businessAddress":{"correlationId":"string","street":"string","town":"string","zipCode":"string","provinceCode":"string","provinceName":"string","countryCode":"string","localization":"string"},"businessPhone":"string","businessMail":"string","annotations":"string","discountPercentage":0,"purchaseType":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","paymentDay1":0,"paymentDay2":0,"paymentDay3":0,"operationType":"string","taxType":"string","taxIncluded":true,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"expenseTypeId":"string","contact":{"id":"string","name":"string","mail":"string","phone":"string","source":"string","sourceId":"string"},"source":"string","sourceId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"accountCode":"string","accountId":"string","rateId":"string","discountId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SupplierDTO"},"example":"<SupplierDTO> <id>string</id> <creationDate>string</creationDate> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <supplierType>string</supplierType> <code>string</code> <name>string</name> <businessName>string</businessName> <web>string</web> <address> <correlationId>string</correlationId> <street>string</street> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <localization>string</localization> </address> <phone>string</phone> <mail>string</mail> <isSameAddress>true</isSameAddress> <businessAddress> <correlationId>string</correlationId> <street>string</street> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <localization>string</localization> </businessAddress> <businessPhone>string</businessPhone> <businessMail>string</businessMail> <annotations>string</annotations> <discountPercentage>0</discountPercentage> <purchaseType>string</purchaseType> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <paymentDay1>0</paymentDay1> <paymentDay2>0</paymentDay2> <paymentDay3>0</paymentDay3> <operationType>string</operationType> <taxType>string</taxType> <taxIncluded>true</taxIncluded> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <expenseTypeId>string</expenseTypeId> <contact> <id>string</id> <name>string</name> <mail>string</mail> <phone>string</phone> <source>string</source> <sourceId>string</sourceId> </contact> <source>string</source> <sourceId>string</sourceId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <accountCode>string</accountCode> <accountId>string</accountId> <rateId>string</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </SupplierDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/suppliers/{id}":{"get":{"tags":["suppliers"],"summary":"Get a supplier by identifier","description":"Get a supplier by identifier","operationId":"Suppliers_GetById","parameters":[{"name":"id","in":"path","description":"Supplier identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierDTO"},"example":{"id":"string","creationDate":"string","vatNumber":"string","vatNumberType":0,"supplierType":"string","code":"string","name":"string","businessName":"string","web":"string","address":{"correlationId":"string","street":"string","town":"string","zipCode":"string","provinceCode":"string","provinceName":"string","countryCode":"string","localization":"string"},"phone":"string","mail":"string","isSameAddress":true,"businessAddress":{"correlationId":"string","street":"string","town":"string","zipCode":"string","provinceCode":"string","provinceName":"string","countryCode":"string","localization":"string"},"businessPhone":"string","businessMail":"string","annotations":"string","discountPercentage":0,"purchaseType":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","paymentDay1":0,"paymentDay2":0,"paymentDay3":0,"operationType":"string","taxType":"string","taxIncluded":true,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"expenseTypeId":"string","contact":{"id":"string","name":"string","mail":"string","phone":"string","source":"string","sourceId":"string"},"source":"string","sourceId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"accountCode":"string","accountId":"string","rateId":"string","discountId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SupplierDTO"},"example":"<SupplierDTO> <id>string</id> <creationDate>string</creationDate> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <supplierType>string</supplierType> <code>string</code> <name>string</name> <businessName>string</businessName> <web>string</web> <address> <correlationId>string</correlationId> <street>string</street> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <localization>string</localization> </address> <phone>string</phone> <mail>string</mail> <isSameAddress>true</isSameAddress> <businessAddress> <correlationId>string</correlationId> <street>string</street> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <localization>string</localization> </businessAddress> <businessPhone>string</businessPhone> <businessMail>string</businessMail> <annotations>string</annotations> <discountPercentage>0</discountPercentage> <purchaseType>string</purchaseType> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <paymentDay1>0</paymentDay1> <paymentDay2>0</paymentDay2> <paymentDay3>0</paymentDay3> <operationType>string</operationType> <taxType>string</taxType> <taxIncluded>true</taxIncluded> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <expenseTypeId>string</expenseTypeId> <contact> <id>string</id> <name>string</name> <mail>string</mail> <phone>string</phone> <source>string</source> <sourceId>string</sourceId> </contact> <source>string</source> <sourceId>string</sourceId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <accountCode>string</accountCode> <accountId>string</accountId> <rateId>string</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </SupplierDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["suppliers"],"summary":"Delete a supplier by identifier","description":"Delete a supplier by identifier","operationId":"Suppliers_Delete","parameters":[{"name":"id","in":"path","description":"Supplier identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"patch":{"tags":["suppliers"],"summary":"Update specific properties of supplier","description":"Update specific properties of supplier","operationId":"Suppliers_Patch","parameters":[{"name":"id","in":"path","description":"Supplier id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Collection of {a3ERP.Public.Resources.V2.PatchOperation}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/html":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/suppliers/{id}/image":{"get":{"tags":["suppliers"],"summary":"Get the supplier's image","description":"Get the supplier's image","operationId":"Suppliers_GetImage","parameters":[{"name":"id","in":"path","description":"Supplier identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"image/jpeg":{"schema":{"$ref":"#/components/schemas/ApiSuppliersIdImageGet200ImageJpegResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"image/jpeg":{"schema":{"$ref":"#/components/schemas/ApiSuppliersIdImageGet204ImageJpegResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"image/jpeg":{}}},"401":{"description":"Unauthorized","content":{"image/jpeg":{}}},"404":{"description":"Unprocessable request","content":{"image/jpeg":{}}},"500":{"description":"Internal server error","content":{"image/jpeg":{}}}}},"put":{"tags":["suppliers"],"summary":"Update the supplier's image","description":"Update the supplier's image","operationId":"Suppliers_PutImage","parameters":[{"name":"id","in":"path","description":"Supplier identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["uploadedFile"],"properties":{"uploadedFile":{"type":"array","description":"File to upload"}}}}}},"responses":{"204":{"description":"No content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["suppliers"],"summary":"Deletes the supplier's image by supplier identifier","description":"Deletes the supplier's image by supplier identifier","operationId":"Suppliers_DeleteImage","parameters":[{"name":"id","in":"path","description":"Supplier identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/suppliers/{id}/directdebits":{"get":{"tags":["suppliers"],"summary":"Get the direct debitings of a supplier by identifier","description":"Get the direct debitings of a supplier by identifier","operationId":"Suppliers_GetDirectDebits","parameters":[{"name":"id","in":"path","description":"Supplier identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectDebitDTOArray"},"example":[{"id":"string","name":"string","account":"string","isNational":true,"bicswift":"string","isDefault":true,"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/DirectDebitDTOArray"},"example":"<DirectDebitDTOArray> <id>string</id> <name>string</name> <account>string</account> <isNational>true</isNational> <bicswift>string</bicswift> <isDefault>true</isDefault> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> </DirectDebitDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["suppliers"],"summary":"Add a new direct debit","description":"Add a new direct debit","operationId":"Suppliers_PostDirectDebit","parameters":[{"name":"id","in":"path","description":"Supplier id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Direct Debit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectDebitDTO"},"example":{"id":"string","name":"string","account":"string","isNational":true,"bicswift":"string","isDefault":true,"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/DirectDebitDTO"},"example":{"id":"string","name":"string","account":"string","isNational":true,"bicswift":"string","isDefault":true,"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/DirectDebitDTO"},"example":"<DirectDebitDTO> <id>string</id> <name>string</name> <account>string</account> <isNational>true</isNational> <bicswift>string</bicswift> <isDefault>true</isDefault> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> </DirectDebitDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/DirectDebitDTO"},"example":{"id":"string","name":"string","account":"string","isNational":true,"bicswift":"string","isDefault":true,"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DirectDebitDTO"},"example":"<DirectDebitDTO> <id>string</id> <name>string</name> <account>string</account> <isNational>true</isNational> <bicswift>string</bicswift> <isDefault>true</isDefault> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> </DirectDebitDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/DirectDebitDTO"},"example":"<DirectDebitDTO> <id>string</id> <name>string</name> <account>string</account> <isNational>true</isNational> <bicswift>string</bicswift> <isDefault>true</isDefault> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> </DirectDebitDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/suppliers/{id}/directdebit/{directDebitId}":{"get":{"tags":["suppliers"],"summary":"Get a direct debiting by identifier","description":"Get a direct debiting by identifier","operationId":"Suppliers_GetDirectDebitById","parameters":[{"name":"id","in":"path","description":"Supplier identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"directDebitId","in":"path","description":"Direct debiting identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectDebitDTO"},"example":{"id":"string","name":"string","account":"string","isNational":true,"bicswift":"string","isDefault":true,"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DirectDebitDTO"},"example":"<DirectDebitDTO> <id>string</id> <name>string</name> <account>string</account> <isNational>true</isNational> <bicswift>string</bicswift> <isDefault>true</isDefault> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> </DirectDebitDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/suppliers":{"get":{"tags":["suppliers"],"summary":"Get all suppliers","description":"Get all suppliers","operationId":"Suppliers_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlatSupplierDTOArray"},"example":[{"id":"string","creationDate":"string","vatNumber":"string","vatNumberType":0,"code":"string","name":"string","businessName":"string","web":"string","street":"string","zipCode":"string","town":"string","province":"string","phone":"string","mail":"string","businessStreet":"string","businessZipCode":"string","businessTown":"string","businessProvince":"string","businessPhone":"string","businessMail":"string","accountCode":"string","accountId":"string","source":"string","sourceId":"string","enabled":true,"legacyId":0}]},"application/xml":{"schema":{"$ref":"#/components/schemas/FlatSupplierDTOArray"},"example":"<FlatSupplierDTOArray> <id>string</id> <creationDate>string</creationDate> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <code>string</code> <name>string</name> <businessName>string</businessName> <web>string</web> <street>string</street> <zipCode>string</zipCode> <town>string</town> <province>string</province> <phone>string</phone> <mail>string</mail> <businessStreet>string</businessStreet> <businessZipCode>string</businessZipCode> <businessTown>string</businessTown> <businessProvince>string</businessProvince> <businessPhone>string</businessPhone> <businessMail>string</businessMail> <accountCode>string</accountCode> <accountId>string</accountId> <source>string</source> <sourceId>string</sourceId> <enabled>true</enabled> <legacyId>0</legacyId> </FlatSupplierDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["suppliers"],"summary":"Add a new supplier","description":"Add a new supplier","operationId":"Suppliers_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Supplier","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierDTO"},"example":{"id":"string","creationDate":"string","vatNumber":"string","vatNumberType":0,"supplierType":"string","code":"string","name":"string","businessName":"string","web":"string","address":{"correlationId":"string","street":"string","town":"string","zipCode":"string","provinceCode":"string","provinceName":"string","countryCode":"string","localization":"string"},"phone":"string","mail":"string","isSameAddress":true,"businessAddress":{"correlationId":"string","street":"string","town":"string","zipCode":"string","provinceCode":"string","provinceName":"string","countryCode":"string","localization":"string"},"businessPhone":"string","businessMail":"string","annotations":"string","discountPercentage":0,"purchaseType":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","paymentDay1":0,"paymentDay2":0,"paymentDay3":0,"operationType":"string","taxType":"string","taxIncluded":true,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"expenseTypeId":"string","contact":{"id":"string","name":"string","mail":"string","phone":"string","source":"string","sourceId":"string"},"source":"string","sourceId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"accountCode":"string","accountId":"string","rateId":"string","discountId":"00000000-0000-0000-0000-000000000000"}},"text/json":{"schema":{"$ref":"#/components/schemas/SupplierDTO"},"example":{"id":"string","creationDate":"string","vatNumber":"string","vatNumberType":0,"supplierType":"string","code":"string","name":"string","businessName":"string","web":"string","address":{"correlationId":"string","street":"string","town":"string","zipCode":"string","provinceCode":"string","provinceName":"string","countryCode":"string","localization":"string"},"phone":"string","mail":"string","isSameAddress":true,"businessAddress":{"correlationId":"string","street":"string","town":"string","zipCode":"string","provinceCode":"string","provinceName":"string","countryCode":"string","localization":"string"},"businessPhone":"string","businessMail":"string","annotations":"string","discountPercentage":0,"purchaseType":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","paymentDay1":0,"paymentDay2":0,"paymentDay3":0,"operationType":"string","taxType":"string","taxIncluded":true,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"expenseTypeId":"string","contact":{"id":"string","name":"string","mail":"string","phone":"string","source":"string","sourceId":"string"},"source":"string","sourceId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"accountCode":"string","accountId":"string","rateId":"string","discountId":"00000000-0000-0000-0000-000000000000"}},"text/html":{"schema":{"$ref":"#/components/schemas/SupplierDTO"},"example":"<SupplierDTO> <id>string</id> <creationDate>string</creationDate> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <supplierType>string</supplierType> <code>string</code> <name>string</name> <businessName>string</businessName> <web>string</web> <address> <correlationId>string</correlationId> <street>string</street> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <localization>string</localization> </address> <phone>string</phone> <mail>string</mail> <isSameAddress>true</isSameAddress> <businessAddress> <correlationId>string</correlationId> <street>string</street> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <localization>string</localization> </businessAddress> <businessPhone>string</businessPhone> <businessMail>string</businessMail> <annotations>string</annotations> <discountPercentage>0</discountPercentage> <purchaseType>string</purchaseType> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <paymentDay1>0</paymentDay1> <paymentDay2>0</paymentDay2> <paymentDay3>0</paymentDay3> <operationType>string</operationType> <taxType>string</taxType> <taxIncluded>true</taxIncluded> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <expenseTypeId>string</expenseTypeId> <contact> <id>string</id> <name>string</name> <mail>string</mail> <phone>string</phone> <source>string</source> <sourceId>string</sourceId> </contact> <source>string</source> <sourceId>string</sourceId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <accountCode>string</accountCode> <accountId>string</accountId> <rateId>string</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </SupplierDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/SupplierDTO"},"example":{"id":"string","creationDate":"string","vatNumber":"string","vatNumberType":0,"supplierType":"string","code":"string","name":"string","businessName":"string","web":"string","address":{"correlationId":"string","street":"string","town":"string","zipCode":"string","provinceCode":"string","provinceName":"string","countryCode":"string","localization":"string"},"phone":"string","mail":"string","isSameAddress":true,"businessAddress":{"correlationId":"string","street":"string","town":"string","zipCode":"string","provinceCode":"string","provinceName":"string","countryCode":"string","localization":"string"},"businessPhone":"string","businessMail":"string","annotations":"string","discountPercentage":0,"purchaseType":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","paymentDay1":0,"paymentDay2":0,"paymentDay3":0,"operationType":"string","taxType":"string","taxIncluded":true,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"expenseTypeId":"string","contact":{"id":"string","name":"string","mail":"string","phone":"string","source":"string","sourceId":"string"},"source":"string","sourceId":"string","customProperties":[{"propertyName":"string","propertyValue":{}}],"accountCode":"string","accountId":"string","rateId":"string","discountId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SupplierDTO"},"example":"<SupplierDTO> <id>string</id> <creationDate>string</creationDate> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <supplierType>string</supplierType> <code>string</code> <name>string</name> <businessName>string</businessName> <web>string</web> <address> <correlationId>string</correlationId> <street>string</street> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <localization>string</localization> </address> <phone>string</phone> <mail>string</mail> <isSameAddress>true</isSameAddress> <businessAddress> <correlationId>string</correlationId> <street>string</street> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <localization>string</localization> </businessAddress> <businessPhone>string</businessPhone> <businessMail>string</businessMail> <annotations>string</annotations> <discountPercentage>0</discountPercentage> <purchaseType>string</purchaseType> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <paymentDay1>0</paymentDay1> <paymentDay2>0</paymentDay2> <paymentDay3>0</paymentDay3> <operationType>string</operationType> <taxType>string</taxType> <taxIncluded>true</taxIncluded> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <expenseTypeId>string</expenseTypeId> <contact> <id>string</id> <name>string</name> <mail>string</mail> <phone>string</phone> <source>string</source> <sourceId>string</sourceId> </contact> <source>string</source> <sourceId>string</sourceId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <accountCode>string</accountCode> <accountId>string</accountId> <rateId>string</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </SupplierDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/SupplierDTO"},"example":"<SupplierDTO> <id>string</id> <creationDate>string</creationDate> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <supplierType>string</supplierType> <code>string</code> <name>string</name> <businessName>string</businessName> <web>string</web> <address> <correlationId>string</correlationId> <street>string</street> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <localization>string</localization> </address> <phone>string</phone> <mail>string</mail> <isSameAddress>true</isSameAddress> <businessAddress> <correlationId>string</correlationId> <street>string</street> <town>string</town> <zipCode>string</zipCode> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <localization>string</localization> </businessAddress> <businessPhone>string</businessPhone> <businessMail>string</businessMail> <annotations>string</annotations> <discountPercentage>0</discountPercentage> <purchaseType>string</purchaseType> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <paymentDay1>0</paymentDay1> <paymentDay2>0</paymentDay2> <paymentDay3>0</paymentDay3> <operationType>string</operationType> <taxType>string</taxType> <taxIncluded>true</taxIncluded> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <expenseTypeId>string</expenseTypeId> <contact> <id>string</id> <name>string</name> <mail>string</mail> <phone>string</phone> <source>string</source> <sourceId>string</sourceId> </contact> <source>string</source> <sourceId>string</sourceId> <customProperties> <propertyName>string</propertyName> <propertyValue /> </customProperties> <accountCode>string</accountCode> <accountId>string</accountId> <rateId>string</rateId> <discountId>00000000-0000-0000-0000-000000000000</discountId> </SupplierDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Created","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/suppliers/export":{"get":{"tags":["suppliers"],"summary":"Export all suppliers","description":"Export all suppliers","operationId":"Suppliers_Export","parameters":[{"name":"format","in":"query","description":"Export format","schema":{"enum":["Excel"],"type":"string"}},{"name":"headers","in":"query","description":"Headers","schema":{"type":"string"}},{"name":"title","in":"query","description":"Title","schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiSuppliersExportGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiSuppliersExportGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/suppliers/{id}/directdebitsCollection":{"put":{"tags":["suppliers"],"summary":"Update direct debit collection","description":"Update direct debit collection","operationId":"Suppliers_PutDirectDebits","parameters":[{"name":"id","in":"path","description":"Supplier identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Direct debit list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectDebitDTOArray"},"example":[{"id":"string","name":"string","account":"string","isNational":true,"bicswift":"string","isDefault":true,"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string"}]},"text/json":{"schema":{"$ref":"#/components/schemas/DirectDebitDTOArray"},"example":[{"id":"string","name":"string","account":"string","isNational":true,"bicswift":"string","isDefault":true,"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string"}]},"text/html":{"schema":{"$ref":"#/components/schemas/DirectDebitDTOArray"},"example":"<DirectDebitDTOArray> <id>string</id> <name>string</name> <account>string</account> <isNational>true</isNational> <bicswift>string</bicswift> <isDefault>true</isDefault> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> </DirectDebitDTOArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/DirectDebitDTOArray"},"example":[{"id":"string","name":"string","account":"string","isNational":true,"bicswift":"string","isDefault":true,"mandateType":"string","mandateReference":"string","mandateSignatureDate":"string","mandateDebType":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/DirectDebitDTOArray"},"example":"<DirectDebitDTOArray> <id>string</id> <name>string</name> <account>string</account> <isNational>true</isNational> <bicswift>string</bicswift> <isDefault>true</isDefault> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> </DirectDebitDTOArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/DirectDebitDTOArray"},"example":"<DirectDebitDTOArray> <id>string</id> <name>string</name> <account>string</account> <isNational>true</isNational> <bicswift>string</bicswift> <isDefault>true</isDefault> <mandateType>string</mandateType> <mandateReference>string</mandateReference> <mandateSignatureDate>string</mandateSignatureDate> <mandateDebType>string</mandateDebType> </DirectDebitDTOArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/suppliers/{id}/enable":{"post":{"tags":["suppliers"],"summary":"Enable supplier","description":"Enable supplier","operationId":"Suppliers_EnableSupplier","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/suppliers/{id}/disable":{"post":{"tags":["suppliers"],"summary":"Disable supplier","description":"Disable supplier","operationId":"Suppliers_DisableSupplier","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/suppliers/{id}/directdebits/{directDebitId}":{"delete":{"tags":["suppliers"],"summary":"Delete a direct debitting by identifier","description":"Delete a direct debitting by identifier","operationId":"Suppliers_DeleteDirectDebit","parameters":[{"name":"id","in":"path","description":"Supplier identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"directDebitId","in":"path","description":"Direct debiting identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"patch":{"tags":["suppliers"],"summary":"Update specific properties of direct debit","description":"Update specific properties of direct debit","operationId":"Suppliers_PatchDirectDebit","parameters":[{"name":"id","in":"path","description":"Supplier identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"directDebitId","in":"path","description":"Direct debit identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Collection of {a3ERP.Public.Resources.V2.PatchOperation}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"text/html":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":[{"op":"replace","path":"string","value":{}}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PatchOperationArray"},"example":"<PatchOperationArray> <op>replace</op> <path>string</path> <value /> </PatchOperationArray>"},"application/x-www-form-urlencoded":{}}},"responses":{"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/supplyInvoices/{id}":{"get":{"tags":["supplyInvoices"],"summary":"Get a supply invoice","description":"Get a supply invoice","operationId":"SupplyInvoices_GetById","parameters":[{"name":"id","in":"path","description":"Supply invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplyInvoiceDTO"},"example":{"id":"string","date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"isInmediatePayment":true,"source":"string","sourceId":"string","version":"string","isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","lines":[{"id":"string","description":"string","price":0,"expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","priceOrigin":"string"}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"isMigrated":true,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SupplyInvoiceDTO"},"example":"<SupplyInvoiceDTO> <id>string</id> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <isInmediatePayment>true</isInmediatePayment> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <lines> <id>string</id> <description>string</description> <price>0</price> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <priceOrigin>string</priceOrigin> </lines> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <isMigrated>true</isMigrated> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> </SupplyInvoiceDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["supplyInvoices"],"summary":"Delete a supply invoice","description":"Delete a supply invoice","operationId":"SupplyInvoices_Delete","parameters":[{"name":"id","in":"path","description":"Supply invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/supplyInvoices/{id}/dues":{"get":{"tags":["supplyInvoices"],"summary":"Get the dues of a supply invoice","description":"Get the dues of a supply invoice","operationId":"SupplyInvoices_GetDues","parameters":[{"name":"id","in":"path","description":"Supply invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentDTOArray"},"example":[{"id":"string","date":"string","payDate":"string","invoiceDate":"string","amount":0,"currency":"string","bankId":"string","payDocumentId":"string","payDocumentDescription":"string","directDebitId":"string","state":0,"supplierName":"string","invoiceNumber":"string","supplierInvoiceNumber":"string","directDebitBankAccount":"string","directDebitDescription":"string","directDebitSwift":"string","directDebitIsNacional":true,"bankDescription":"string","supplierId":"string","invoiceId":"string","isInmediatePayment":true,"isMigrated":true,"journala3InnuvaId":"string","returnJournala3InnuvaId":"string","bankStatementCorrelationId":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/PaymentDTOArray"},"example":"<PaymentDTOArray> <id>string</id> <date>string</date> <payDate>string</payDate> <invoiceDate>string</invoiceDate> <amount>0</amount> <currency>string</currency> <bankId>string</bankId> <payDocumentId>string</payDocumentId> <payDocumentDescription>string</payDocumentDescription> <directDebitId>string</directDebitId> <state>0</state> <supplierName>string</supplierName> <invoiceNumber>string</invoiceNumber> <supplierInvoiceNumber>string</supplierInvoiceNumber> <directDebitBankAccount>string</directDebitBankAccount> <directDebitDescription>string</directDebitDescription> <directDebitSwift>string</directDebitSwift> <directDebitIsNacional>true</directDebitIsNacional> <bankDescription>string</bankDescription> <supplierId>string</supplierId> <invoiceId>string</invoiceId> <isInmediatePayment>true</isInmediatePayment> <isMigrated>true</isMigrated> <journala3InnuvaId>string</journala3InnuvaId> <returnJournala3InnuvaId>string</returnJournala3InnuvaId> <bankStatementCorrelationId>string</bankStatementCorrelationId> </PaymentDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/supplyInvoices/{id}/attachment":{"get":{"tags":["supplyInvoices"],"summary":"Get supply invoice file attachment","description":"Get supply invoice file attachment","operationId":"SupplyInvoices_GetAttachment","parameters":[{"name":"id","in":"path","description":"Supply invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiSupplyInvoicesIdAttachmentGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"No content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiSupplyInvoicesIdAttachmentGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"404":{"description":"Not found","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}},"post":{"tags":["supplyInvoices"],"summary":"Post supply invoice file attachment","description":"Post supply invoice file attachment","operationId":"SupplyInvoices_PostAttachment","parameters":[{"name":"id","in":"path","description":"Supply invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["uploadedFile"],"properties":{"uploadedFile":{"type":"array","description":"File to upload"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["supplyInvoices"],"summary":"Deletes supply invoice file attachment","description":"Deletes supply invoice file attachment","operationId":"SupplyInvoices_DeleteAttachment","parameters":[{"name":"id","in":"path","description":"Supply invoice identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/supplyInvoices/additionaldata/regimes":{"get":{"tags":["supplyInvoices"],"summary":"Get SII regimes types","description":"Get SII regimes types","operationId":"SupplyInvoiceA_GetAllRegimeTypes","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiiRegimeTypeDTOArray"},"example":[{"code":"string","description":"string","orderUI":0,"correlationId":"00000000-0000-0000-0000-000000000000","isRectifying":true,"documentType":0}]},"application/xml":{"schema":{"$ref":"#/components/schemas/SiiRegimeTypeDTOArray"},"example":"<SiiRegimeTypeDTOArray> <code>string</code> <description>string</description> <orderUI>0</orderUI> <correlationId>00000000-0000-0000-0000-000000000000</correlationId> <isRectifying>true</isRectifying> <documentType>0</documentType> </SiiRegimeTypeDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/supplyInvoices/additionaldata/invoices":{"get":{"tags":["supplyInvoices"],"summary":"Get SII Invoice types","description":"Get SII Invoice types","operationId":"SupplyInvoiceA_GetAllInvoiceType","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiiInvoiceTypeDTOArray"},"example":[{"code":"string","description":"string","orderUI":0,"correlationId":"00000000-0000-0000-0000-000000000000","isRectifying":true,"documentType":0}]},"application/xml":{"schema":{"$ref":"#/components/schemas/SiiInvoiceTypeDTOArray"},"example":"<SiiInvoiceTypeDTOArray> <code>string</code> <description>string</description> <orderUI>0</orderUI> <correlationId>00000000-0000-0000-0000-000000000000</correlationId> <isRectifying>true</isRectifying> <documentType>0</documentType> </SiiInvoiceTypeDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/supplyInvoices/new":{"get":{"tags":["supplyInvoices"],"summary":"Get a new supply invoice with default values","description":"Get a new supply invoice with default values","operationId":"SupplyInvoices_GetNew","parameters":[{"name":"supplierId","in":"query","description":"Supplier identifier","schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplyInvoiceDTO"},"example":{"id":"string","date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"isInmediatePayment":true,"source":"string","sourceId":"string","version":"string","isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","lines":[{"id":"string","description":"string","price":0,"expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","priceOrigin":"string"}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"isMigrated":true,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SupplyInvoiceDTO"},"example":"<SupplyInvoiceDTO> <id>string</id> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <isInmediatePayment>true</isInmediatePayment> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <lines> <id>string</id> <description>string</description> <price>0</price> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <priceOrigin>string</priceOrigin> </lines> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <isMigrated>true</isMigrated> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> </SupplyInvoiceDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/supplyInvoices/newLine":{"get":{"tags":["supplyInvoices"],"summary":"Get a new supply invoice line with default values","description":"Get a new supply invoice line with default values","operationId":"SupplyInvoices_GetNewLine","parameters":[{"name":"supplierId","in":"query","description":"Supplier identifier","schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplyInvoiceLineDTO"},"example":{"id":"string","description":"string","price":0,"expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","priceOrigin":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SupplyInvoiceLineDTO"},"example":"<SupplyInvoiceLineDTO> <id>string</id> <description>string</description> <price>0</price> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <priceOrigin>string</priceOrigin> </SupplyInvoiceLineDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/supplyInvoices":{"get":{"tags":["supplyInvoices"],"summary":"Get all supply invoices","description":"Get all supply invoices","operationId":"SupplyInvoices_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlatSupplyInvoiceDTOArray"},"example":[{"id":"string","number":"string","date":"string","accountingDate":"string","reference":"string","supplierId":"string","supplierVATNumber":"string","supplierName":"string","email":"string","taxBase":0,"taxTotal":0,"total":0,"purchaseCurrency":"string","purchaseOperationTypeCode":"string","purchaseOperationTypeDescription":"string","invoiceType":"string","situation":0,"isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","source":"string","sourceId":"string","isMigrated":true}]},"application/xml":{"schema":{"$ref":"#/components/schemas/FlatSupplyInvoiceDTOArray"},"example":"<FlatSupplyInvoiceDTOArray> <id>string</id> <number>string</number> <date>string</date> <accountingDate>string</accountingDate> <reference>string</reference> <supplierId>string</supplierId> <supplierVATNumber>string</supplierVATNumber> <supplierName>string</supplierName> <email>string</email> <taxBase>0</taxBase> <taxTotal>0</taxTotal> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <purchaseOperationTypeCode>string</purchaseOperationTypeCode> <purchaseOperationTypeDescription>string</purchaseOperationTypeDescription> <invoiceType>string</invoiceType> <situation>0</situation> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <source>string</source> <sourceId>string</sourceId> <isMigrated>true</isMigrated> </FlatSupplyInvoiceDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["supplyInvoices"],"summary":"Update a supply invoice","description":"Update a supply invoice","operationId":"SupplyInvoices_Put","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplyInvoiceDTO"},"example":{"id":"string","date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"isInmediatePayment":true,"source":"string","sourceId":"string","version":"string","isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","lines":[{"id":"string","description":"string","price":0,"expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","priceOrigin":"string"}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"isMigrated":true,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000"}},"text/json":{"schema":{"$ref":"#/components/schemas/SupplyInvoiceDTO"},"example":{"id":"string","date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"isInmediatePayment":true,"source":"string","sourceId":"string","version":"string","isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","lines":[{"id":"string","description":"string","price":0,"expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","priceOrigin":"string"}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"isMigrated":true,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000"}},"text/html":{"schema":{"$ref":"#/components/schemas/SupplyInvoiceDTO"},"example":"<SupplyInvoiceDTO> <id>string</id> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <isInmediatePayment>true</isInmediatePayment> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <lines> <id>string</id> <description>string</description> <price>0</price> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <priceOrigin>string</priceOrigin> </lines> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <isMigrated>true</isMigrated> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> </SupplyInvoiceDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/SupplyInvoiceDTO"},"example":{"id":"string","date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"isInmediatePayment":true,"source":"string","sourceId":"string","version":"string","isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","lines":[{"id":"string","description":"string","price":0,"expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","priceOrigin":"string"}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"isMigrated":true,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SupplyInvoiceDTO"},"example":"<SupplyInvoiceDTO> <id>string</id> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <isInmediatePayment>true</isInmediatePayment> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <lines> <id>string</id> <description>string</description> <price>0</price> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <priceOrigin>string</priceOrigin> </lines> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <isMigrated>true</isMigrated> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> </SupplyInvoiceDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/SupplyInvoiceDTO"},"example":"<SupplyInvoiceDTO> <id>string</id> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <isInmediatePayment>true</isInmediatePayment> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <lines> <id>string</id> <description>string</description> <price>0</price> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <priceOrigin>string</priceOrigin> </lines> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <isMigrated>true</isMigrated> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> </SupplyInvoiceDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["supplyInvoices"],"summary":"Create a supply invoice","description":"Create a supply invoice","operationId":"SupplyInvoices_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplyInvoiceDTO"},"example":{"id":"string","date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"isInmediatePayment":true,"source":"string","sourceId":"string","version":"string","isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","lines":[{"id":"string","description":"string","price":0,"expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","priceOrigin":"string"}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"isMigrated":true,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000"}},"text/json":{"schema":{"$ref":"#/components/schemas/SupplyInvoiceDTO"},"example":{"id":"string","date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"isInmediatePayment":true,"source":"string","sourceId":"string","version":"string","isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","lines":[{"id":"string","description":"string","price":0,"expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","priceOrigin":"string"}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"isMigrated":true,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000"}},"text/html":{"schema":{"$ref":"#/components/schemas/SupplyInvoiceDTO"},"example":"<SupplyInvoiceDTO> <id>string</id> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <isInmediatePayment>true</isInmediatePayment> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <lines> <id>string</id> <description>string</description> <price>0</price> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <priceOrigin>string</priceOrigin> </lines> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <isMigrated>true</isMigrated> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> </SupplyInvoiceDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/SupplyInvoiceDTO"},"example":{"id":"string","date":"string","accountingDate":"string","supplierId":"string","activityId":"string","serieId":"string","number":0,"documentNumber":"string","reference":"string","bankId":"string","paymentMethodId":"string","paymentTypeId":"string","vatNumber":"string","vatNumberType":0,"name":"string","email":"string","emailCC":"string","address":"string","zipCode":"string","town":"string","provinceCode":"string","provinceName":"string","countryCode":"string","addressDetails":"string","directDebitId":"string","operationTypeCode":"string","invoiceType":"string","isRent":true,"isTaxIncluded":true,"isTaxBaseAffected":true,"totalPromptPayment":0,"promptPaymentPercentage":0,"totalFinancialSurcharge":0,"financialSurchargePercentage":0,"taxRetentionBase":0,"withholdingPercentage":0,"withholdingModel":"string","withholdingKeyId":0,"withholdingSubKeyId":0,"annotations":"string","taxBase":0,"totalTax":0,"totalRetention":0,"total":0,"purchaseCurrency":"string","situation":0,"isInmediatePayment":true,"source":"string","sourceId":"string","version":"string","isRectificative":true,"rectifiedId":"string","rectifiedDate":"string","rectifiedNumber":"string","isRectified":true,"rectificativeId":"string","rectificativeDate":"string","rectificativeNumber":"string","lines":[{"id":"string","description":"string","price":0,"expenseTypeId":"string","taxDeductionType":"string","taxTypeCode":"string","taxRate":0,"taxSurchargeRate":0,"isExpense":true,"taxBase":0,"annotations":"string","warehouseCorrelationId":"00000000-0000-0000-0000-000000000000","priceOrigin":"string"}],"siiData":{"id":"string","documentId":0,"invoiceDescription":"string","numberInitialInvoice":"string","numberFinalInvoice":"string","invoiceSpecialRegime":true,"taxBaseAtCost":0,"siiRegistrationDate":"string","regimeCode":"string","documentTypeCode":"string","a3InnuvaId":"00000000-0000-0000-0000-000000000000"},"isMigrated":true,"warehouseCorrelationId":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SupplyInvoiceDTO"},"example":"<SupplyInvoiceDTO> <id>string</id> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <isInmediatePayment>true</isInmediatePayment> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <lines> <id>string</id> <description>string</description> <price>0</price> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <priceOrigin>string</priceOrigin> </lines> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <isMigrated>true</isMigrated> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> </SupplyInvoiceDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/SupplyInvoiceDTO"},"example":"<SupplyInvoiceDTO> <id>string</id> <date>string</date> <accountingDate>string</accountingDate> <supplierId>string</supplierId> <activityId>string</activityId> <serieId>string</serieId> <number>0</number> <documentNumber>string</documentNumber> <reference>string</reference> <bankId>string</bankId> <paymentMethodId>string</paymentMethodId> <paymentTypeId>string</paymentTypeId> <vatNumber>string</vatNumber> <vatNumberType>0</vatNumberType> <name>string</name> <email>string</email> <emailCC>string</emailCC> <address>string</address> <zipCode>string</zipCode> <town>string</town> <provinceCode>string</provinceCode> <provinceName>string</provinceName> <countryCode>string</countryCode> <addressDetails>string</addressDetails> <directDebitId>string</directDebitId> <operationTypeCode>string</operationTypeCode> <invoiceType>string</invoiceType> <isRent>true</isRent> <isTaxIncluded>true</isTaxIncluded> <isTaxBaseAffected>true</isTaxBaseAffected> <totalPromptPayment>0</totalPromptPayment> <promptPaymentPercentage>0</promptPaymentPercentage> <totalFinancialSurcharge>0</totalFinancialSurcharge> <financialSurchargePercentage>0</financialSurchargePercentage> <taxRetentionBase>0</taxRetentionBase> <withholdingPercentage>0</withholdingPercentage> <withholdingModel>string</withholdingModel> <withholdingKeyId>0</withholdingKeyId> <withholdingSubKeyId>0</withholdingSubKeyId> <annotations>string</annotations> <taxBase>0</taxBase> <totalTax>0</totalTax> <totalRetention>0</totalRetention> <total>0</total> <purchaseCurrency>string</purchaseCurrency> <situation>0</situation> <isInmediatePayment>true</isInmediatePayment> <source>string</source> <sourceId>string</sourceId> <version>string</version> <isRectificative>true</isRectificative> <rectifiedId>string</rectifiedId> <rectifiedDate>string</rectifiedDate> <rectifiedNumber>string</rectifiedNumber> <isRectified>true</isRectified> <rectificativeId>string</rectificativeId> <rectificativeDate>string</rectificativeDate> <rectificativeNumber>string</rectificativeNumber> <lines> <id>string</id> <description>string</description> <price>0</price> <expenseTypeId>string</expenseTypeId> <taxDeductionType>string</taxDeductionType> <taxTypeCode>string</taxTypeCode> <taxRate>0</taxRate> <taxSurchargeRate>0</taxSurchargeRate> <isExpense>true</isExpense> <taxBase>0</taxBase> <annotations>string</annotations> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> <priceOrigin>string</priceOrigin> </lines> <siiData> <id>string</id> <documentId>0</documentId> <invoiceDescription>string</invoiceDescription> <numberInitialInvoice>string</numberInitialInvoice> <numberFinalInvoice>string</numberFinalInvoice> <invoiceSpecialRegime>true</invoiceSpecialRegime> <taxBaseAtCost>0</taxBaseAtCost> <siiRegistrationDate>string</siiRegistrationDate> <regimeCode>string</regimeCode> <documentTypeCode>string</documentTypeCode> <a3InnuvaId>00000000-0000-0000-0000-000000000000</a3InnuvaId> </siiData> <isMigrated>true</isMigrated> <warehouseCorrelationId>00000000-0000-0000-0000-000000000000</warehouseCorrelationId> </SupplyInvoiceDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/supplyInvoices/{id}/portfolio":{"put":{"tags":["supplyInvoices"],"summary":"Update the portfolio of a purchase invoice","description":"Update the portfolio of a purchase invoice","operationId":"SupplyInvoices_SavePortfolio","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioPurchaseInvoiceDTO"},"example":{"payments":[{"id":"string","date":"string","payDate":"string","invoiceDate":"string","amount":0,"currency":"string","bankId":"string","payDocumentId":"string","payDocumentDescription":"string","directDebitId":"string","state":0,"supplierName":"string","invoiceNumber":"string","supplierInvoiceNumber":"string","directDebitBankAccount":"string","directDebitDescription":"string","directDebitSwift":"string","directDebitIsNacional":true,"bankDescription":"string","supplierId":"string","invoiceId":"string","isInmediatePayment":true,"isMigrated":true,"journala3InnuvaId":"string","returnJournala3InnuvaId":"string","bankStatementCorrelationId":"string"}]}},"text/json":{"schema":{"$ref":"#/components/schemas/PortfolioPurchaseInvoiceDTO"},"example":{"payments":[{"id":"string","date":"string","payDate":"string","invoiceDate":"string","amount":0,"currency":"string","bankId":"string","payDocumentId":"string","payDocumentDescription":"string","directDebitId":"string","state":0,"supplierName":"string","invoiceNumber":"string","supplierInvoiceNumber":"string","directDebitBankAccount":"string","directDebitDescription":"string","directDebitSwift":"string","directDebitIsNacional":true,"bankDescription":"string","supplierId":"string","invoiceId":"string","isInmediatePayment":true,"isMigrated":true,"journala3InnuvaId":"string","returnJournala3InnuvaId":"string","bankStatementCorrelationId":"string"}]}},"text/html":{"schema":{"$ref":"#/components/schemas/PortfolioPurchaseInvoiceDTO"},"example":"<PortfolioPurchaseInvoiceDTO> <payments> <id>string</id> <date>string</date> <payDate>string</payDate> <invoiceDate>string</invoiceDate> <amount>0</amount> <currency>string</currency> <bankId>string</bankId> <payDocumentId>string</payDocumentId> <payDocumentDescription>string</payDocumentDescription> <directDebitId>string</directDebitId> <state>0</state> <supplierName>string</supplierName> <invoiceNumber>string</invoiceNumber> <supplierInvoiceNumber>string</supplierInvoiceNumber> <directDebitBankAccount>string</directDebitBankAccount> <directDebitDescription>string</directDebitDescription> <directDebitSwift>string</directDebitSwift> <directDebitIsNacional>true</directDebitIsNacional> <bankDescription>string</bankDescription> <supplierId>string</supplierId> <invoiceId>string</invoiceId> <isInmediatePayment>true</isInmediatePayment> <isMigrated>true</isMigrated> <journala3InnuvaId>string</journala3InnuvaId> <returnJournala3InnuvaId>string</returnJournala3InnuvaId> <bankStatementCorrelationId>string</bankStatementCorrelationId> </payments> </PortfolioPurchaseInvoiceDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PortfolioPurchaseInvoiceDTO"},"example":{"payments":[{"id":"string","date":"string","payDate":"string","invoiceDate":"string","amount":0,"currency":"string","bankId":"string","payDocumentId":"string","payDocumentDescription":"string","directDebitId":"string","state":0,"supplierName":"string","invoiceNumber":"string","supplierInvoiceNumber":"string","directDebitBankAccount":"string","directDebitDescription":"string","directDebitSwift":"string","directDebitIsNacional":true,"bankDescription":"string","supplierId":"string","invoiceId":"string","isInmediatePayment":true,"isMigrated":true,"journala3InnuvaId":"string","returnJournala3InnuvaId":"string","bankStatementCorrelationId":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/PortfolioPurchaseInvoiceDTO"},"example":"<PortfolioPurchaseInvoiceDTO> <payments> <id>string</id> <date>string</date> <payDate>string</payDate> <invoiceDate>string</invoiceDate> <amount>0</amount> <currency>string</currency> <bankId>string</bankId> <payDocumentId>string</payDocumentId> <payDocumentDescription>string</payDocumentDescription> <directDebitId>string</directDebitId> <state>0</state> <supplierName>string</supplierName> <invoiceNumber>string</invoiceNumber> <supplierInvoiceNumber>string</supplierInvoiceNumber> <directDebitBankAccount>string</directDebitBankAccount> <directDebitDescription>string</directDebitDescription> <directDebitSwift>string</directDebitSwift> <directDebitIsNacional>true</directDebitIsNacional> <bankDescription>string</bankDescription> <supplierId>string</supplierId> <invoiceId>string</invoiceId> <isInmediatePayment>true</isInmediatePayment> <isMigrated>true</isMigrated> <journala3InnuvaId>string</journala3InnuvaId> <returnJournala3InnuvaId>string</returnJournala3InnuvaId> <bankStatementCorrelationId>string</bankStatementCorrelationId> </payments> </PortfolioPurchaseInvoiceDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PortfolioPurchaseInvoiceDTO"},"example":"<PortfolioPurchaseInvoiceDTO> <payments> <id>string</id> <date>string</date> <payDate>string</payDate> <invoiceDate>string</invoiceDate> <amount>0</amount> <currency>string</currency> <bankId>string</bankId> <payDocumentId>string</payDocumentId> <payDocumentDescription>string</payDocumentDescription> <directDebitId>string</directDebitId> <state>0</state> <supplierName>string</supplierName> <invoiceNumber>string</invoiceNumber> <supplierInvoiceNumber>string</supplierInvoiceNumber> <directDebitBankAccount>string</directDebitBankAccount> <directDebitDescription>string</directDebitDescription> <directDebitSwift>string</directDebitSwift> <directDebitIsNacional>true</directDebitIsNacional> <bankDescription>string</bankDescription> <supplierId>string</supplierId> <invoiceId>string</invoiceId> <isInmediatePayment>true</isInmediatePayment> <isMigrated>true</isMigrated> <journala3InnuvaId>string</journala3InnuvaId> <returnJournala3InnuvaId>string</returnJournala3InnuvaId> <bankStatementCorrelationId>string</bankStatementCorrelationId> </payments> </PortfolioPurchaseInvoiceDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/supplyInvoices/{id}/dues/{dueId}/pay":{"post":{"tags":["supplyInvoices"],"summary":"Pay a due","description":"Pay a due","operationId":"SupplyInvoices_Pay","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"dueId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayCommand"},"example":{"date":"string","ammount":0,"bankId":"string","paymentDocumentId":"string","directDebitId":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/PayCommand"},"example":{"date":"string","ammount":0,"bankId":"string","paymentDocumentId":"string","directDebitId":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/PayCommand"},"example":"<PayCommand> <date>string</date> <ammount>0</ammount> <bankId>string</bankId> <paymentDocumentId>string</paymentDocumentId> <directDebitId>string</directDebitId> </PayCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/PayCommand"},"example":{"date":"string","ammount":0,"bankId":"string","paymentDocumentId":"string","directDebitId":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PayCommand"},"example":"<PayCommand> <date>string</date> <ammount>0</ammount> <bankId>string</bankId> <paymentDocumentId>string</paymentDocumentId> <directDebitId>string</directDebitId> </PayCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/PayCommand"},"example":"<PayCommand> <date>string</date> <ammount>0</ammount> <bankId>string</bankId> <paymentDocumentId>string</paymentDocumentId> <directDebitId>string</directDebitId> </PayCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/supplyInvoices/{id}/dues/{dueId}/cancelPay":{"post":{"tags":["supplyInvoices"],"summary":"Cancel a due pay","description":"Cancel a due pay","operationId":"SupplyInvoices_CancelPay","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"dueId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/tags":{"get":{"tags":["tags"],"summary":"Get all Tags","description":"Get all Tags","operationId":"Tags_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagDTOArray"},"example":[{"id":"string","description":"string","type":0}]},"application/xml":{"schema":{"$ref":"#/components/schemas/TagDTOArray"},"example":"<TagDTOArray> <id>string</id> <description>string</description> <type>0</type> </TagDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["tags"],"summary":"Add a new Tag","description":"Add a new Tag","operationId":"Tags_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagDTO"},"example":{"id":"string","description":"string","type":0}},"text/json":{"schema":{"$ref":"#/components/schemas/TagDTO"},"example":{"id":"string","description":"string","type":0}},"text/html":{"schema":{"$ref":"#/components/schemas/TagDTO"},"example":"<TagDTO> <id>string</id> <description>string</description> <type>0</type> </TagDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/TagDTO"},"example":{"id":"string","description":"string","type":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/TagDTO"},"example":"<TagDTO> <id>string</id> <description>string</description> <type>0</type> </TagDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/TagDTO"},"example":"<TagDTO> <id>string</id> <description>string</description> <type>0</type> </TagDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Created","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/taxrates":{"get":{"tags":["taxrates"],"summary":"Get all tax rates","description":"Get all tax rates","operationId":"TaxRates_Get","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRateDTOArray"},"example":[{"code":"string","description":"string","type":"string","date":"string","since":"string","until":"string","rate":0,"surcharge":0}]},"application/xml":{"schema":{"$ref":"#/components/schemas/TaxRateDTOArray"},"example":"<TaxRateDTOArray> <code>string</code> <description>string</description> <type>string</type> <date>string</date> <since>string</since> <until>string</until> <rate>0</rate> <surcharge>0</surcharge> </TaxRateDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/taxrates/{date}":{"get":{"tags":["taxrates"],"summary":"Get rates of a date","description":"Get rates of a date","operationId":"TaxRates_GetOfADate","parameters":[{"name":"date","in":"path","description":"Date (yyyy-mm-dd)","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRateDTOArray"},"example":[{"code":"string","description":"string","type":"string","date":"string","since":"string","until":"string","rate":0,"surcharge":0}]},"application/xml":{"schema":{"$ref":"#/components/schemas/TaxRateDTOArray"},"example":"<TaxRateDTOArray> <code>string</code> <description>string</description> <type>string</type> <date>string</date> <since>string</since> <until>string</until> <rate>0</rate> <surcharge>0</surcharge> </TaxRateDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/taxrates/{code}/{date}":{"get":{"tags":["taxrates"],"summary":"Get rate of a tax type by date","description":"Get rate of a tax type by date","operationId":"TaxRates_GetByDate","parameters":[{"name":"code","in":"path","description":"Tax type code","required":true,"schema":{"type":"string"}},{"name":"date","in":"path","description":"Date (yyyy-mm-dd)","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRateDTO"},"example":{"code":"string","description":"string","type":"string","date":"string","since":"string","until":"string","rate":0,"surcharge":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/TaxRateDTO"},"example":"<TaxRateDTO> <code>string</code> <description>string</description> <type>string</type> <date>string</date> <since>string</since> <until>string</until> <rate>0</rate> <surcharge>0</surcharge> </TaxRateDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/ticketBai/{id}/pdf":{"get":{"tags":["ticketBai"],"summary":"Get the pdf of the TicketBai invoice","description":"Get the pdf of the TicketBai invoice","operationId":"TicketBai_GetPdf","parameters":[{"name":"id","in":"path","description":"TicketBAI identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/Response"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"404":{"description":"Not found","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/ticketBai/{id}/xml":{"get":{"tags":["ticketBai"],"summary":"Get the xml of the TicketBAI invoice","description":"Get the xml of the TicketBAI invoice","operationId":"TicketBai_GetXml","parameters":[{"name":"id","in":"path","description":"TicketBAI identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/Response"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"404":{"description":"Not found","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/ticketBai/{id}/footPrint":{"get":{"tags":["ticketBai"],"summary":"Get TicketBAI Image","description":"Get TicketBAI Image","operationId":"TicketBai_GetTBAIFootPrintById","parameters":[{"name":"id","in":"path","description":"TicketBAI identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TBAIFootPrintDTO"},"example":{"identifier":"string","qrImage":[],"qrCode":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TBAIFootPrintDTO"},"example":"<TBAIFootPrintDTO> <identifier>string</identifier> <qrImage /> <qrCode>string</qrCode> </TBAIFootPrintDTO>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TBAIFootPrintDTO"},"example":{"identifier":"string","qrImage":[],"qrCode":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TBAIFootPrintDTO"},"example":"<TBAIFootPrintDTO> <identifier>string</identifier> <qrImage /> <qrCode>string</qrCode> </TBAIFootPrintDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/ticketBai/{id}/sendResponse":{"get":{"tags":["ticketBai"],"summary":"Get send response","description":"Get send response","operationId":"TicketBai_GetSendResponseById","parameters":[{"name":"id","in":"path","description":"TicketBAI identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiTicketBaiIdSendResponseGet200ApplicationJsonResponse"},"example":"string"},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiTicketBaiIdSendResponseGet200ApplicationXmlResponse"},"example":"<ApiTicketBaiIdSendResponseGet200ApplicationXmlResponse>string</ApiTicketBaiIdSendResponseGet200ApplicationXmlResponse>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiTicketBaiIdSendResponseGet204ApplicationJsonResponse"},"example":"string"},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiTicketBaiIdSendResponseGet204ApplicationXmlResponse"},"example":"<ApiTicketBaiIdSendResponseGet204ApplicationXmlResponse>string</ApiTicketBaiIdSendResponseGet204ApplicationXmlResponse>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/ticketBai":{"get":{"tags":["ticketBai"],"summary":"Get all TicketBAI invoices","description":"Get all TicketBAI invoices","operationId":"TicketBai_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketBAIDTOArray"},"example":[{"id":"string","invoiceType":0,"invoiceTypeDescription":"string","documentNumber":"string","invoiceDate":"string","rectifiedInvoiceId":"string","customerName":"string","invoiceAmount":0,"logStatus":0,"logStatusDescription":"string","sentDate":"string","invoiceId":"string","relatedDocNumber":"string","identifierTBAI":"string","relatedInvoices":[{"id":"string","invoiceType":0,"invoiceDate":"string","documentNumber":"string","relatedInvoiceDescription":"string","logDate":"string"}],"relatedInvoiceDescription":"string","relatedDescriptionToPrint":"string","logDate":"string","eInvoiceOrigin":0}]},"application/xml":{"schema":{"$ref":"#/components/schemas/TicketBAIDTOArray"},"example":"<TicketBAIDTOArray> <id>string</id> <invoiceType>0</invoiceType> <invoiceTypeDescription>string</invoiceTypeDescription> <documentNumber>string</documentNumber> <invoiceDate>string</invoiceDate> <rectifiedInvoiceId>string</rectifiedInvoiceId> <customerName>string</customerName> <invoiceAmount>0</invoiceAmount> <logStatus>0</logStatus> <logStatusDescription>string</logStatusDescription> <sentDate>string</sentDate> <invoiceId>string</invoiceId> <relatedDocNumber>string</relatedDocNumber> <identifierTBAI>string</identifierTBAI> <relatedInvoices> <id>string</id> <invoiceType>0</invoiceType> <invoiceDate>string</invoiceDate> <documentNumber>string</documentNumber> <relatedInvoiceDescription>string</relatedInvoiceDescription> <logDate>string</logDate> </relatedInvoices> <relatedInvoiceDescription>string</relatedInvoiceDescription> <relatedDescriptionToPrint>string</relatedDescriptionToPrint> <logDate>string</logDate> <eInvoiceOrigin>0</eInvoiceOrigin> </TicketBAIDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/ticketBai/export":{"get":{"tags":["ticketBai"],"summary":"TicketBAI invoice relation export","description":"TicketBAI invoice relation export","operationId":"TicketBai_Export","parameters":[{"name":"format","in":"query","description":"Export format","schema":{"enum":["Excel"],"type":"string"}},{"name":"headers","in":"query","description":"Headers","schema":{"type":"string"}},{"name":"title","in":"query","description":"Title","schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiTicketBaiExportGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiTicketBaiExportGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/ticketBai/QueueXMLDownload":{"post":{"tags":["ticketBai"],"summary":"Queue the XML download request","description":"Queue the XML download request","operationId":"TicketBai_QueueXMLDownloadRequest","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"Download XML Data Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilterRequest"},"example":{"searchBy":"string","filter":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/FilterRequest"},"example":{"searchBy":"string","filter":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/FilterRequest"},"example":"<FilterRequest> <searchBy>string</searchBy> <filter>string</filter> </FilterRequest>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/FilterRequest"},"example":{"searchBy":"string","filter":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/FilterRequest"},"example":"<FilterRequest> <searchBy>string</searchBy> <filter>string</filter> </FilterRequest>"},"text/xml":{"schema":{"$ref":"#/components/schemas/FilterRequest"},"example":"<FilterRequest> <searchBy>string</searchBy> <filter>string</filter> </FilterRequest>"},"application/x-www-form-urlencoded":{}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/ticketBai/{correlationId}/send":{"post":{"tags":["ticketBai"],"summary":"Send ticketbai invoices when status is error or pending to send","description":"Send ticketbai invoices when status is error or pending to send","operationId":"TicketBai_Send","parameters":[{"name":"correlationId","in":"path","description":"ticketbai correlation Id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/ticketBai/{correlationId}/sendzuzendu":{"post":{"tags":["ticketBai"],"summary":"Send ticketbai invoices when developers are testing Zuzendu","description":"Send ticketbai invoices when developers are testing Zuzendu","operationId":"TicketBai_SendZuzendu","parameters":[{"name":"correlationId","in":"path","description":"invoice correlationId","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Not processable","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/tickets/new":{"get":{"tags":["tickets"],"summary":"Get a new ticket with default values","description":"Get a new ticket with default values","operationId":"Tickets_GetNew","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketDTO"},"example":{"id":"string","activityId":"string","date":"string","number":"string","annotations":"string","amount":0,"bankId":"string","expenseTypeId":"string","source":"string","sourceId":"string","isMigrated":true}},"application/xml":{"schema":{"$ref":"#/components/schemas/TicketDTO"},"example":"<TicketDTO> <id>string</id> <activityId>string</activityId> <date>string</date> <number>string</number> <annotations>string</annotations> <amount>0</amount> <bankId>string</bankId> <expenseTypeId>string</expenseTypeId> <source>string</source> <sourceId>string</sourceId> <isMigrated>true</isMigrated> </TicketDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/tickets/{id}":{"get":{"tags":["tickets"],"summary":"Get a ticket","description":"Get a ticket","operationId":"Tickets_GetById","parameters":[{"name":"id","in":"path","description":"ticket identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketDTO"},"example":{"id":"string","activityId":"string","date":"string","number":"string","annotations":"string","amount":0,"bankId":"string","expenseTypeId":"string","source":"string","sourceId":"string","isMigrated":true}},"application/xml":{"schema":{"$ref":"#/components/schemas/TicketDTO"},"example":"<TicketDTO> <id>string</id> <activityId>string</activityId> <date>string</date> <number>string</number> <annotations>string</annotations> <amount>0</amount> <bankId>string</bankId> <expenseTypeId>string</expenseTypeId> <source>string</source> <sourceId>string</sourceId> <isMigrated>true</isMigrated> </TicketDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["tickets"],"summary":"Delete a ticket","description":"Delete a ticket","operationId":"Tickets_Delete","parameters":[{"name":"id","in":"path","description":"Ticket identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/tickets/{id}/attachment":{"get":{"tags":["tickets"],"summary":"Get ticket file attachment","description":"Get ticket file attachment","operationId":"Tickets_GetAttachment","parameters":[{"name":"id","in":"path","description":"Ticket identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiTicketsIdAttachmentGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"No content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiTicketsIdAttachmentGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"404":{"description":"Not found","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}},"post":{"tags":["tickets"],"summary":"Post ticket file attachment","description":"Post ticket file attachment","operationId":"Tickets_PostAttachment","parameters":[{"name":"id","in":"path","description":"Ticket identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["uploadedFile"],"properties":{"uploadedFile":{"type":"array","description":"File to upload"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["tickets"],"summary":"Delete ticket file attachment","description":"Delete ticket file attachment","operationId":"Tickets_DeleteAttachment","parameters":[{"name":"id","in":"path","description":"Ticket identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/tickets":{"get":{"tags":["tickets"],"summary":"Get all tickets","description":"Get all tickets","operationId":"Tickets_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlatTicketDTOArray"},"example":[{"id":"string","number":"string","date":"string","amount":0,"annotations":"string","bankId":"string","currencyCode":"string","expenseTypeDescription":"string","bankName":"string","documentNumber":"string","expenseTypeId":"string","source":"string","sourceId":"string","activityId":"string","activityDescription":"string","isMigrated":true}]},"application/xml":{"schema":{"$ref":"#/components/schemas/FlatTicketDTOArray"},"example":"<FlatTicketDTOArray> <id>string</id> <number>string</number> <date>string</date> <amount>0</amount> <annotations>string</annotations> <bankId>string</bankId> <currencyCode>string</currencyCode> <expenseTypeDescription>string</expenseTypeDescription> <bankName>string</bankName> <documentNumber>string</documentNumber> <expenseTypeId>string</expenseTypeId> <source>string</source> <sourceId>string</sourceId> <activityId>string</activityId> <activityDescription>string</activityDescription> <isMigrated>true</isMigrated> </FlatTicketDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["tickets"],"summary":"Update a ticket","description":"Update a ticket","operationId":"Tickets_Put","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketDTO"},"example":{"id":"string","activityId":"string","date":"string","number":"string","annotations":"string","amount":0,"bankId":"string","expenseTypeId":"string","source":"string","sourceId":"string","isMigrated":true}},"text/json":{"schema":{"$ref":"#/components/schemas/TicketDTO"},"example":{"id":"string","activityId":"string","date":"string","number":"string","annotations":"string","amount":0,"bankId":"string","expenseTypeId":"string","source":"string","sourceId":"string","isMigrated":true}},"text/html":{"schema":{"$ref":"#/components/schemas/TicketDTO"},"example":"<TicketDTO> <id>string</id> <activityId>string</activityId> <date>string</date> <number>string</number> <annotations>string</annotations> <amount>0</amount> <bankId>string</bankId> <expenseTypeId>string</expenseTypeId> <source>string</source> <sourceId>string</sourceId> <isMigrated>true</isMigrated> </TicketDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/TicketDTO"},"example":{"id":"string","activityId":"string","date":"string","number":"string","annotations":"string","amount":0,"bankId":"string","expenseTypeId":"string","source":"string","sourceId":"string","isMigrated":true}},"application/xml":{"schema":{"$ref":"#/components/schemas/TicketDTO"},"example":"<TicketDTO> <id>string</id> <activityId>string</activityId> <date>string</date> <number>string</number> <annotations>string</annotations> <amount>0</amount> <bankId>string</bankId> <expenseTypeId>string</expenseTypeId> <source>string</source> <sourceId>string</sourceId> <isMigrated>true</isMigrated> </TicketDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/TicketDTO"},"example":"<TicketDTO> <id>string</id> <activityId>string</activityId> <date>string</date> <number>string</number> <annotations>string</annotations> <amount>0</amount> <bankId>string</bankId> <expenseTypeId>string</expenseTypeId> <source>string</source> <sourceId>string</sourceId> <isMigrated>true</isMigrated> </TicketDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"204":{"description":"Not content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["tickets"],"summary":"Create a ticket","description":"Create a ticket","operationId":"Tickets_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketDTO"},"example":{"id":"string","activityId":"string","date":"string","number":"string","annotations":"string","amount":0,"bankId":"string","expenseTypeId":"string","source":"string","sourceId":"string","isMigrated":true}},"text/json":{"schema":{"$ref":"#/components/schemas/TicketDTO"},"example":{"id":"string","activityId":"string","date":"string","number":"string","annotations":"string","amount":0,"bankId":"string","expenseTypeId":"string","source":"string","sourceId":"string","isMigrated":true}},"text/html":{"schema":{"$ref":"#/components/schemas/TicketDTO"},"example":"<TicketDTO> <id>string</id> <activityId>string</activityId> <date>string</date> <number>string</number> <annotations>string</annotations> <amount>0</amount> <bankId>string</bankId> <expenseTypeId>string</expenseTypeId> <source>string</source> <sourceId>string</sourceId> <isMigrated>true</isMigrated> </TicketDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/TicketDTO"},"example":{"id":"string","activityId":"string","date":"string","number":"string","annotations":"string","amount":0,"bankId":"string","expenseTypeId":"string","source":"string","sourceId":"string","isMigrated":true}},"application/xml":{"schema":{"$ref":"#/components/schemas/TicketDTO"},"example":"<TicketDTO> <id>string</id> <activityId>string</activityId> <date>string</date> <number>string</number> <annotations>string</annotations> <amount>0</amount> <bankId>string</bankId> <expenseTypeId>string</expenseTypeId> <source>string</source> <sourceId>string</sourceId> <isMigrated>true</isMigrated> </TicketDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/TicketDTO"},"example":"<TicketDTO> <id>string</id> <activityId>string</activityId> <date>string</date> <number>string</number> <annotations>string</annotations> <amount>0</amount> <bankId>string</bankId> <expenseTypeId>string</expenseTypeId> <source>string</source> <sourceId>string</sourceId> <isMigrated>true</isMigrated> </TicketDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"201":{"description":"Ok","headers":{"location":{"description":"The new resource's URI","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/tickets/export":{"get":{"tags":["tickets"],"summary":"expense tickets export","description":"expense tickets export","operationId":"Tickets_Export","parameters":[{"name":"format","in":"query","description":"Export format","schema":{"enum":["Excel"],"type":"string"}},{"name":"headers","in":"query","description":"Headers","schema":{"type":"string"}},{"name":"title","in":"query","description":"Title","schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiTicketsExportGet200ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"204":{"description":"Not content","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ApiTicketsExportGet204ApplicationOctet-streamResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"application/octet-stream":{}}},"401":{"description":"Unauthorized","content":{"application/octet-stream":{}}},"500":{"description":"Internal server error","content":{"application/octet-stream":{}}}}}},"/api/token/tenants":{"get":{"tags":["token"],"summary":"Token_Get","operationId":"Token_Get","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyLicensingDTOArray"},"example":[{"licensingStatus":0,"productType":0,"id":0,"name":"string","idCDA":"string","default":true,"companyStatus":"Updating"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/CompanyLicensingDTOArray"},"example":"<CompanyLicensingDTOArray> <licensingStatus>0</licensingStatus> <productType>0</productType> <id>0</id> <name>string</name> <idCDA>string</idCDA> <default>true</default> <companyStatus>Updating</companyStatus> </CompanyLicensingDTOArray>"}}}}}},"/api/token/checkToken":{"get":{"tags":["token"],"summary":"Check if any token is valid","description":"Check if any token is valid","operationId":"Token_CheckToken","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiTokenCheckTokenGet200ApplicationJsonResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiTokenCheckTokenGet200ApplicationXmlResponse"},"example":"<ApiTokenCheckTokenGet200ApplicationXmlResponse />"}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}}}}},"/api/token/tenants/{id}/image":{"get":{"tags":["token"],"summary":"Gets the company image","description":"Gets the company image","operationId":"Token_GetImage","parameters":[{"name":"id","in":"path","description":"Company identifier","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"image/jpeg":{"schema":{"$ref":"#/components/schemas/ApiTokenTenantsIdImageGet200ImageJpegResponse"},"examples":{"default":{"value":""}}}}},"400":{"description":"Bad request","content":{"image/jpeg":{}}},"401":{"description":"Unauthorized","content":{"image/jpeg":{}}},"500":{"description":"Internal server error","content":{"image/jpeg":{}}}}}},"/api/token/validateToken":{"get":{"tags":["token"],"summary":"Check if a a3factura token is valid","description":"Check if a a3factura token is valid","operationId":"Token_ValidateToken","parameters":[{"name":"authorization","in":"query","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"498":{"description":"Invalid Token","content":{"application/json":{},"application/xml":{}}}}}},"/api/token/signin":{"post":{"tags":["token"],"summary":"Login","description":"Login","operationId":"Token_Logon","parameters":[{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginRequest"},"example":{"mail":"string","password":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/LoginRequest"},"example":{"mail":"string","password":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/LoginRequest"},"example":"<LoginRequest> <mail>string</mail> <password>string</password> </LoginRequest>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/LoginRequest"},"example":{"mail":"string","password":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/LoginRequest"},"example":"<LoginRequest> <mail>string</mail> <password>string</password> </LoginRequest>"},"text/xml":{"schema":{"$ref":"#/components/schemas/LoginRequest"},"example":"<LoginRequest> <mail>string</mail> <password>string</password> </LoginRequest>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginResponse"},"example":{"token":"string","refreshToken":"string","mail":"string","locale":"string","name":"string","id":0,"version":"string","isAdvisor":true,"companies":[{"id":0,"name":"string","idCDA":"string","default":true,"companyStatus":"Updating"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/LoginResponse"},"example":"<LoginResponse> <token>string</token> <refreshToken>string</refreshToken> <mail>string</mail> <locale>string</locale> <name>string</name> <id>0</id> <version>string</version> <isAdvisor>true</isAdvisor> <companies> <id>0</id> <name>string</name> <idCDA>string</idCDA> <default>true</default> <companyStatus>Updating</companyStatus> </companies> </LoginResponse>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/token/refresh":{"post":{"tags":["token"],"summary":"Refresh token","description":"Refresh token","operationId":"Token_Refresh","parameters":[{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenDTO"},"example":{"access_token":"string","refresh_token":"string","expires_in":0,"token_type":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/TokenDTO"},"example":{"access_token":"string","refresh_token":"string","expires_in":0,"token_type":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/TokenDTO"},"example":"<TokenDTO> <access_token>string</access_token> <refresh_token>string</refresh_token> <expires_in>0</expires_in> <token_type>string</token_type> </TokenDTO>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/TokenDTO"},"example":{"access_token":"string","refresh_token":"string","expires_in":0,"token_type":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TokenDTO"},"example":"<TokenDTO> <access_token>string</access_token> <refresh_token>string</refresh_token> <expires_in>0</expires_in> <token_type>string</token_type> </TokenDTO>"},"text/xml":{"schema":{"$ref":"#/components/schemas/TokenDTO"},"example":"<TokenDTO> <access_token>string</access_token> <refresh_token>string</refresh_token> <expires_in>0</expires_in> <token_type>string</token_type> </TokenDTO>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenDTO"},"example":{"access_token":"string","refresh_token":"string","expires_in":0,"token_type":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TokenDTO"},"example":"<TokenDTO> <access_token>string</access_token> <refresh_token>string</refresh_token> <expires_in>0</expires_in> <token_type>string</token_type> </TokenDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/token/applicationToken":{"post":{"tags":["token"],"summary":"Get an application token","description":"Get an application token","operationId":"Token_GetApplicationToken","parameters":[{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"application name and application credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationTokenCommand"},"example":{"applicationName":"string","credentials":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/ApplicationTokenCommand"},"example":{"applicationName":"string","credentials":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/ApplicationTokenCommand"},"example":"<ApplicationTokenCommand> <applicationName>string</applicationName> <credentials>string</credentials> </ApplicationTokenCommand>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ApplicationTokenCommand"},"example":{"applicationName":"string","credentials":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ApplicationTokenCommand"},"example":"<ApplicationTokenCommand> <applicationName>string</applicationName> <credentials>string</credentials> </ApplicationTokenCommand>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ApplicationTokenCommand"},"example":"<ApplicationTokenCommand> <applicationName>string</applicationName> <credentials>string</credentials> </ApplicationTokenCommand>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiTokenApplicationTokenPost200ApplicationJsonResponse"},"example":"string"},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiTokenApplicationTokenPost200ApplicationXmlResponse"},"example":"<ApiTokenApplicationTokenPost200ApplicationXmlResponse>string</ApiTokenApplicationTokenPost200ApplicationXmlResponse>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/token/setCookiesFromToken":{"post":{"tags":["token"],"summary":"Set cookies from token","description":"Set cookies from token","operationId":"Token_SetCookiesFromToken","parameters":[{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetCookiesFromTokenRequest"},"example":{"access_token":"string","refresh_token":"string","session":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/SetCookiesFromTokenRequest"},"example":{"access_token":"string","refresh_token":"string","session":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/SetCookiesFromTokenRequest"},"example":"<SetCookiesFromTokenRequest> <access_token>string</access_token> <refresh_token>string</refresh_token> <session>string</session> </SetCookiesFromTokenRequest>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/SetCookiesFromTokenRequest"},"example":{"access_token":"string","refresh_token":"string","session":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SetCookiesFromTokenRequest"},"example":"<SetCookiesFromTokenRequest> <access_token>string</access_token> <refresh_token>string</refresh_token> <session>string</session> </SetCookiesFromTokenRequest>"},"text/xml":{"schema":{"$ref":"#/components/schemas/SetCookiesFromTokenRequest"},"example":"<SetCookiesFromTokenRequest> <access_token>string</access_token> <refresh_token>string</refresh_token> <session>string</session> </SetCookiesFromTokenRequest>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/token/tenants/{id}/select":{"post":{"tags":["token"],"summary":"Select a company","description":"Select a company","operationId":"Token_Select","parameters":[{"name":"id","in":"path","description":"Company identifier","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshToken"},"example":"string"},"text/json":{"schema":{"$ref":"#/components/schemas/RefreshToken"},"example":"string"},"text/html":{"schema":{"$ref":"#/components/schemas/RefreshToken"},"example":"<RefreshToken>string</RefreshToken>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/RefreshToken"},"example":"string"},"application/xml":{"schema":{"$ref":"#/components/schemas/RefreshToken"},"example":"<RefreshToken>string</RefreshToken>"},"text/xml":{"schema":{"$ref":"#/components/schemas/RefreshToken"},"example":"<RefreshToken>string</RefreshToken>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectCompanyResponse"},"example":{"companyStatus":"Updating","token":"string","refreshToken":"string","productType":0}},"application/xml":{"schema":{"$ref":"#/components/schemas/SelectCompanyResponse"},"example":"<SelectCompanyResponse> <companyStatus>Updating</companyStatus> <token>string</token> <refreshToken>string</refreshToken> <productType>0</productType> </SelectCompanyResponse>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/token/reloadTokenFromCookies":{"post":{"tags":["token"],"summary":"Reload the token from cookies","description":"Reload the token from cookies","operationId":"Token_ReloadTokenFromCookies","parameters":[{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReloadTokenFromCookiesRequest"},"example":{"session":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/ReloadTokenFromCookiesRequest"},"example":{"session":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/ReloadTokenFromCookiesRequest"},"example":"<ReloadTokenFromCookiesRequest> <session>string</session> </ReloadTokenFromCookiesRequest>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ReloadTokenFromCookiesRequest"},"example":{"session":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ReloadTokenFromCookiesRequest"},"example":"<ReloadTokenFromCookiesRequest> <session>string</session> </ReloadTokenFromCookiesRequest>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ReloadTokenFromCookiesRequest"},"example":"<ReloadTokenFromCookiesRequest> <session>string</session> </ReloadTokenFromCookiesRequest>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenDTO"},"example":{"access_token":"string","refresh_token":"string","expires_in":0,"token_type":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TokenDTO"},"example":"<TokenDTO> <access_token>string</access_token> <refresh_token>string</refresh_token> <expires_in>0</expires_in> <token_type>string</token_type> </TokenDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/users/logout":{"get":{"tags":["users"],"summary":"Logout","description":"Logout","operationId":"Users_Logout","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiUsersLogoutGet200ApplicationJsonResponse"},"example":"True"},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiUsersLogoutGet200ApplicationXmlResponse"},"example":"<ApiUsersLogoutGet200ApplicationXmlResponse>true</ApiUsersLogoutGet200ApplicationXmlResponse>"}}}}}},"/api/users/checkresetpassword":{"get":{"tags":["users"],"summary":"Check if token is valid","description":"Check if token is valid","operationId":"Users_CheckResetPassword","parameters":[{"name":"token","in":"query","description":"Token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/users/authenticateToken":{"get":{"tags":["users"],"summary":"Validates the token and login user into application","description":"Validates the token and login user into application","operationId":"Users_Authenticate","parameters":[{"name":"token","in":"query","description":"Token","required":true,"schema":{"type":"string"}},{"name":"refreshToken","in":"query","description":"","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginResponse"},"example":{"token":"string","refreshToken":"string","mail":"string","locale":"string","name":"string","id":0,"version":"string","isAdvisor":true,"companies":[{"id":0,"name":"string","idCDA":"string","default":true,"companyStatus":"Updating"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/LoginResponse"},"example":"<LoginResponse> <token>string</token> <refreshToken>string</refreshToken> <mail>string</mail> <locale>string</locale> <name>string</name> <id>0</id> <version>string</version> <isAdvisor>true</isAdvisor> <companies> <id>0</id> <name>string</name> <idCDA>string</idCDA> <default>true</default> <companyStatus>Updating</companyStatus> </companies> </LoginResponse>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/users/login":{"post":{"tags":["users"],"summary":"Login","description":"Login","operationId":"Users_Logon","parameters":[{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginRequest"},"example":{"mail":"string","password":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/LoginRequest"},"example":{"mail":"string","password":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/LoginRequest"},"example":"<LoginRequest> <mail>string</mail> <password>string</password> </LoginRequest>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/LoginRequest"},"example":{"mail":"string","password":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/LoginRequest"},"example":"<LoginRequest> <mail>string</mail> <password>string</password> </LoginRequest>"},"text/xml":{"schema":{"$ref":"#/components/schemas/LoginRequest"},"example":"<LoginRequest> <mail>string</mail> <password>string</password> </LoginRequest>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginResponse"},"example":{"token":"string","refreshToken":"string","mail":"string","locale":"string","name":"string","id":0,"version":"string","isAdvisor":true,"companies":[{"id":0,"name":"string","idCDA":"string","default":true,"companyStatus":"Updating"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/LoginResponse"},"example":"<LoginResponse> <token>string</token> <refreshToken>string</refreshToken> <mail>string</mail> <locale>string</locale> <name>string</name> <id>0</id> <version>string</version> <isAdvisor>true</isAdvisor> <companies> <id>0</id> <name>string</name> <idCDA>string</idCDA> <default>true</default> <companyStatus>Updating</companyStatus> </companies> </LoginResponse>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/users/resetPassword":{"post":{"tags":["users"],"summary":"Password reset","description":"Password reset","operationId":"Users_ResetPassword","parameters":[{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetPasswordRequest"},"example":{"token":"string","password":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/ResetPasswordRequest"},"example":{"token":"string","password":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/ResetPasswordRequest"},"example":"<ResetPasswordRequest> <token>string</token> <password>string</password> </ResetPasswordRequest>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/ResetPasswordRequest"},"example":{"token":"string","password":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ResetPasswordRequest"},"example":"<ResetPasswordRequest> <token>string</token> <password>string</password> </ResetPasswordRequest>"},"text/xml":{"schema":{"$ref":"#/components/schemas/ResetPasswordRequest"},"example":"<ResetPasswordRequest> <token>string</token> <password>string</password> </ResetPasswordRequest>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"},"example":{"ok":true,"result":{},"messages":[{"type":"string","description":"string","title":"string","details":"string"}]}},"application/xml":{"schema":{"$ref":"#/components/schemas/Response"},"example":"<Response> <ok>true</ok> <result /> <messages> <type>string</type> <description>string</description> <title>string</title> <details>string</details> </messages> </Response>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/webhooks":{"get":{"tags":["webhooks"],"summary":"Get all webhooks","description":"Get all webhooks","operationId":"WebHooks_Get","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiWebhooksGet200ApplicationJsonResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiWebhooksGet200ApplicationXmlResponse"},"example":"<ApiWebhooksGet200ApplicationXmlResponse />"}}}}},"post":{"tags":["webhooks"],"summary":"Add a webhook","description":"Add a webhook","operationId":"WebHooks_Post","parameters":[{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebHookDto"},"example":{"Uri":"string","Entity":"string","Action":"None","Secret":"string","IsPaused":true,"ApplicationName":"string","Description":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/WebHookDto"},"example":{"Uri":"string","Entity":"string","Action":"None","Secret":"string","IsPaused":true,"ApplicationName":"string","Description":"string"}},"text/html":{"schema":{"$ref":"#/components/schemas/WebHookDto"},"example":"<WebHookDto> <Uri>string</Uri> <Entity>string</Entity> <Action>None</Action> <Secret>string</Secret> <IsPaused>true</IsPaused> <ApplicationName>string</ApplicationName> <Description>string</Description> </WebHookDto>"},"application/vnd.wkes+json":{"schema":{"$ref":"#/components/schemas/WebHookDto"},"example":{"Uri":"string","Entity":"string","Action":"None","Secret":"string","IsPaused":true,"ApplicationName":"string","Description":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/WebHookDto"},"example":"<WebHookDto> <Uri>string</Uri> <Entity>string</Entity> <Action>None</Action> <Secret>string</Secret> <IsPaused>true</IsPaused> <ApplicationName>string</ApplicationName> <Description>string</Description> </WebHookDto>"},"text/xml":{"schema":{"$ref":"#/components/schemas/WebHookDto"},"example":"<WebHookDto> <Uri>string</Uri> <Entity>string</Entity> <Action>None</Action> <Secret>string</Secret> <IsPaused>true</IsPaused> <ApplicationName>string</ApplicationName> <Description>string</Description> </WebHookDto>"},"application/x-www-form-urlencoded":{}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiWebhooksPost200ApplicationJsonResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiWebhooksPost200ApplicationXmlResponse"},"example":"<ApiWebhooksPost200ApplicationXmlResponse />"}}}}}},"/api/webhooks/{id}":{"get":{"tags":["webhooks"],"summary":"Get a webhook","description":"Get a webhook","operationId":"WebHooks_GetById","parameters":[{"name":"id","in":"path","description":"Webhook id","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiWebhooksIdGet200ApplicationJsonResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiWebhooksIdGet200ApplicationXmlResponse"},"example":"<ApiWebhooksIdGet200ApplicationXmlResponse />"}}}}},"delete":{"tags":["webhooks"],"summary":"Delete a webhook","description":"Delete a webhook","operationId":"WebHooks_Delete","parameters":[{"name":"id","in":"path","description":"Webhook id","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiWebhooksIdDelete200ApplicationJsonResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiWebhooksIdDelete200ApplicationXmlResponse"},"example":"<ApiWebhooksIdDelete200ApplicationXmlResponse />"}}}}}},"/api/withholdingkeys":{"get":{"tags":["withholdingkeys"],"summary":"Get all with holding keys","description":"Get all with holding keys","operationId":"WithHoldingKeys_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithHoldingKeyDTOArray"},"example":[{"id":0,"code":"string","description":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/WithHoldingKeyDTOArray"},"example":"<WithHoldingKeyDTOArray> <id>0</id> <code>string</code> <description>string</description> </WithHoldingKeyDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/withholdingsubkeys":{"get":{"tags":["withholdingsubkeys"],"summary":"Get all with holding sub keys","description":"Get all with holding sub keys","operationId":"WithHoldingSubKeys_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithHoldingSubKeyDTOArray"},"example":[{"id":0,"code":"string","description":"string","withHoldingKeyId":0,"percentage":0,"dateFrom":"string","dateTo":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/WithHoldingSubKeyDTOArray"},"example":"<WithHoldingSubKeyDTOArray> <id>0</id> <code>string</code> <description>string</description> <withHoldingKeyId>0</withHoldingKeyId> <percentage>0</percentage> <dateFrom>string</dateFrom> <dateTo>string</dateTo> </WithHoldingSubKeyDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/zipcodes/{code}":{"get":{"tags":["zipcodes"],"summary":"Get a zip code by code","description":"Get a zip code by code","operationId":"ZipCodes_GetByCode","parameters":[{"name":"code","in":"path","description":"zip code code","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZipCodeDTO"},"example":{"id":0,"code":"string","provinceCode":"string","town":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ZipCodeDTO"},"example":"<ZipCodeDTO> <id>0</id> <code>string</code> <provinceCode>string</provinceCode> <town>string</town> </ZipCodeDTO>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/zipcodes":{"get":{"tags":["zipcodes"],"summary":"Get all zip codes","description":"Get all zip codes","operationId":"ZipCodes_Get","parameters":[{"name":"pageNumber","in":"query","description":"Page number","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of items","schema":{"type":"integer","format":"int32"}},{"name":"selection","in":"query","description":"Collection of properties","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by","schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"Generic search","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"api-version","in":"header","description":"The requested API version","required":true,"schema":{"type":"string","default":"2.0"}}],"responses":{"200":{"description":"Ok","headers":{"x-pagination":{"description":"Pagination information","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZipCodeDTOArray"},"example":[{"id":0,"code":"string","provinceCode":"string","town":"string"}]},"application/xml":{"schema":{"$ref":"#/components/schemas/ZipCodeDTOArray"},"example":"<ZipCodeDTOArray> <id>0</id> <code>string</code> <provinceCode>string</provinceCode> <town>string</town> </ZipCodeDTOArray>"}}},"400":{"description":"Bad request","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}}},"components":{"schemas":{"SelectRequest":{"type":"object","properties":{"pageNumber":{"type":"integer","description":"Page number","format":"int32"},"pageSize":{"type":"integer","description":"Number of items","format":"int32"},"selection":{"type":"string","description":"Collection of properties"},"orderBy":{"type":"string","description":"Order by"},"searchBy":{"type":"string","description":"Generic search"},"filter":{"type":"string","description":"Filter"}},"description":"Query definition"},"AccountDTO":{"type":"object","properties":{"description":{"type":"string"},"code":{"type":"string"},"id":{"type":"string"},"legacyId":{"type":"integer","format":"int32"}}},"Response":{"type":"object","properties":{"ok":{"type":"boolean","description":"Command was ok?"},"result":{"type":"object","description":"Command result"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/Message"},"description":"Error messages"}},"description":"Response"},"Message":{"type":"object","properties":{"type":{"type":"string","description":"type"},"description":{"type":"string","description":"description"},"title":{"type":"string","description":"Title"},"details":{"type":"string","description":"Details"}}},"ActivityDTO":{"required":["code","name","epigraphId","regimen","taxation"],"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"code":{"type":"string","description":"Code"},"name":{"type":"string","description":"Name"},"ecoCompany":{"type":"string","description":"Código de empresa a3ASESOR|eco (5 posiciones numéricas y longitud fija)"},"ecoActivity":{"type":"string","description":"Código de actividad a3ASESOR|eco.\r\n2 posiciones numéricas\r\nRango de valores: del 01-10"},"epigraphId":{"type":"integer","description":"Epigraph id","format":"int32"},"epigraphCode":{"type":"string","description":"Epigraph code. ReadOnly"},"epigraphDescription":{"type":"string","description":"Epigraph description. ReadOnly"},"regimen":{"type":"integer","description":"Regimen (1 - General, 2 - Simplificado, 3 - Recargo de equivalencia)","format":"int32"},"taxation":{"type":"integer","description":"Tributación (1 - Estatal, 2 - Canarias)","format":"int32"},"description":{"type":"string","description":"Descripción (aplica a a3InnuvaERP)"},"adhereToTicketBai":{"type":"boolean","description":"AdhereToTicketBai for Canarian Taxation"}},"description":"Activity"},"PatchOperation":{"type":"object","properties":{"op":{"enum":["replace"],"type":"string","description":"Operation type"},"path":{"type":"string","description":"Property name"},"value":{"type":"object","description":"Property value"}},"description":"Represent the opertation to apply to a resource"},"FlatActivityDTO":{"required":["code","name","epigraphId","regimen","taxation"],"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"code":{"type":"string","description":"Code"},"name":{"type":"string","description":"Name"},"ecoCompany":{"type":"string","description":"Código de empresa a3ASESOR|eco (5 posiciones numéricas y longitud fija)"},"ecoActivity":{"type":"string","description":"Código de actividad a3ASESOR|eco.\r\n2 posiciones numéricas\r\nRango de valores: del 01-10"},"epigraphId":{"type":"integer","description":"Epigraph id","format":"int32"},"epigraphCode":{"type":"string","description":"Epigraph code. ReadOnly"},"epigraphDescription":{"type":"string","description":"Epigraph description. ReadOnly"},"regimen":{"type":"integer","description":"Regimen (1 - General, 2 - Simplificado, 3 - Recargo de equivalencia)","format":"int32"},"taxation":{"type":"integer","description":"Tributación (1 - Estatal, 2 - Canarias)","format":"int32"},"description":{"type":"string","description":"Descripción (aplica a a3InnuvaERP)"},"adhereToTicketBai":{"type":"boolean","description":"AdhereToTicketBai for Canarian Taxation"},"isLAFTDisabled":{"type":"boolean","description":"IsLAFTDisabled (default false), false = in RSIF, true = non RSIF"},"laftDisabledConfirmation":{"type":"boolean","description":"Confirmation Disabled Antifraud, when IsLAFTDisabled is true should be true"},"antifraudNonComplianceReason":{"type":"integer","description":"Reason why the activity is not compliant with the antifraud law\r\nNone = 0,\r\nAcogido al SII = 1,\r\nActividad fuera de España = 2,\r\nSolicitud de no aplicacion Art5 = 3","format":"int32"},"resignationCode":{"type":"string","description":"Indicates Resignation Code"}}},"ActivityAntifraudConfigDTO":{"type":"object","properties":{"isLAFTDisabled":{"type":"boolean","description":"IsLAFTDisabled (default false), false = in RSIF, true = non RSIF"},"laftDisabledConfirmation":{"type":"boolean","description":"Confirmation Disabled Antifraud, when IsLAFTDisabled is true should be true"},"antifraudNonComplianceReason":{"type":"integer","description":"Reason why the activity is not compliant with the antifraud law\r\nNone = 0,\r\nAcogido al SII = 1,\r\nActividad fuera de España = 2,\r\nSolicitud de no aplicacion Art5 = 3","format":"int32"},"resignationCode":{"type":"string","description":"Indicates Resignation Code"}}},"AdditionalModuleDTO":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"subscribeEndPoint":{"type":"string"},"unsubscribeEndPoint":{"type":"string"},"partnerName":{"type":"string"},"state":{"type":"integer","format":"int32"},"frontOfficeURL":{"type":"string"},"logo":{"type":"array"}},"description":"properties of a module in a3factura"},"AntifraudLawConfigurationDTO":{"required":["activation","veriFactuActivation"],"type":"object","properties":{"activation":{"type":"boolean","description":"Si esta Acogido al Reglamento de la Ley Antifraude."},"veriFactuActivation":{"type":"boolean","description":"Si verifactu esta activado o no"},"veriFactuEndDate":{"type":"string","description":"If we abandon verifactu we will stop sending invoices to the verifactu system at this date","format":"date-time"},"motiveNotUse":{"type":"integer","description":"Motivo no Acogido a LAF\r\nAcogido al Sii = 1,\r\nEmpresa fuera Espana= 2,\r\nEmpresa estabelecida pais Vasco y Sujeta a TicketBai = 3,\r\nEmpresa estabelecida Navarra = 4,\r\nSolicitud de no aplicacion Art5 = 5\r\nFuera del ámbito subjetivo del artículo 3.1 = 6","format":"int32"},"codeResignation":{"type":"string","description":"Código suministrado por Hacienda"},"confirmationNotRequiredToUse":{"type":"boolean","description":"Confirmacion si realmente no esta acogido a LAF\r\nRequerido si informa motivo de no acogido"},"acceptationDate":{"type":"string","format":"date-time"},"isProvisional":{"type":"boolean"},"isRepresentationAuthorized":{"type":"boolean"},"configuredTimes":{"type":"integer","description":"Indica el número de veces que se ha configurado la ley antifraude en la empresa.","format":"int32"},"digitalCertificateSigned":{"type":"boolean"},"deadlineNewUsers":{"type":"string","format":"date-time"},"corporateDeadlineDate":{"type":"string","format":"date-time"},"generalEffectiveDate":{"type":"string","format":"date-time"},"provisionalDate":{"type":"string","format":"date-time"}}},"AntifraudLawCheckingIncidentsInRecordsDto":{"required":["initialDate","endDate","type"],"type":"object","properties":{"initialDate":{"type":"string","description":"Initial Date","format":"date-time"},"endDate":{"type":"string","description":"End Date","format":"date-time"},"type":{"type":"integer","description":"LatfCheckingIncidentsType\r\n InvoiceIntegrityVerification = 0,\r\n InvoiceIntegrityVerificationHash = 1,\r\n InvoiceIntegrityVerificationSignature = 2,\r\n InvoiceIntegrityVerificationPreviousRecord = 3,\r\n InvoiceIntegrityVerificationInvalidDate = 4,\r\n InvoiceExport = 5,\r\n EventIntegrityVerification = 6,\r\n EventIntegrityVerificationHash = 7 ,\r\n EventIntegrityVerificationSignature = 8,\r\n EventIntegrityVerificationPreviousRecord = 9 ,\r\n EventIntegrityVerificationInvalidDate = 10,\r\n EventExport = 11","format":"int32"}}},"ProductInfoDto":{"type":"object","properties":{"canShowAntifraudeInvoiceStatus":{"type":"boolean","description":"true: display column with state of registry associated to invoice\r\nfalse: do not display"},"idCDA":{"type":"string","description":"IdCDA"},"description":{"type":"string","description":"Description"},"userPersona":{"type":"integer","description":"User Persona \r\nNone = 0,\r\nAdministrator = 1,\r\nGuest = 2,\r\nAdvisor = 3,","format":"int32"},"type":{"type":"integer","description":"Product Type \r\nNone = 0,\r\nGoFromAdvisor = 1,\r\nGoDirectSale = 2, \r\nProFromAdvisor = 3, \r\nProDirectSale = 4","format":"int32"},"licensingStatus":{"type":"integer","description":"Licensing Status \r\nNone = 0,\r\nActivo = 1,\r\nBaja = 2,\r\nTry=3,\r\nFueraDeMantenimiento = 5","format":"int32"},"status":{"type":"string","description":"Product status"},"isLinked":{"type":"boolean","description":"IsLinked"},"additionalUsers":{"type":"integer","description":"Additional users","format":"int32"},"tryDays":{"type":"integer","description":"Try days","format":"int32"},"hasAdvisorInvitation":{"type":"boolean","description":"Return if the company has an advisor invitation"},"features":{"type":"array","items":{"type":"string"},"description":"Feature list"},"applicationsInfoDto":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationInfoDto"},"description":"List of aplication with their own information"},"softwareVersion":{"type":"string","description":"Software version"},"isActiveInTicketBai":{"type":"boolean","description":"Return if the company is active in ticketbai"},"ticketBaiErrors":{"type":"integer","description":"Number of errors in ticketbai tracking","format":"int32"},"isActiveLeyAntifraude":{"type":"boolean"},"isSuiteInitialSynchronization":{"type":"boolean","description":"Return if the company is synchronization with innuva"},"isActiveVeriFactu":{"type":"boolean"},"realFakeCompanyType":{"type":"integer","description":"Return if the company a real company, a dummy one for testing,\r\nor if the company type is unknown","format":"int32"},"migrationStatus":{"type":"integer","description":"Return if the company is migrating data","format":"int32"},"innuvaTenantId":{"type":"string","description":"Innuva Tenant when suite version"},"innuvaPartitionClientId":{"type":"string","description":"Innuva LegalEntityId when suite version"},"migrationScenario":{"type":"integer","description":"Migration scenario","format":"int32"},"isAntifraudWizardShown":{"type":"boolean","description":"Whether to display wizard to configure LATF"},"isNotNowButtonEnabled":{"type":"boolean","description":"Wheter to display NowNow button in LATF wizard"},"hasLaftAlertCancellation":{"type":"boolean","description":"Whether to display alert LATF"},"hasLaftAlertSumbission":{"type":"boolean","description":"Whether to display alert LATF"},"hasLaftAlertEvent":{"type":"boolean","description":"Whether to display alert LATF"},"latfProvisionalDate":{"type":"string","format":"date-time"},"hasLaftIsProvisional":{"type":"boolean"},"provisionalAlreadyBeenUse":{"type":"boolean"},"oldWizardConfiguration":{"type":"boolean"},"latfConfiguredWithDigitalCertificate":{"type":"boolean"},"isAntifraudLawConfigured":{"type":"boolean","description":"Gets or sets a value indicating whether the Anti-fraud Law is configured."},"latfDeadlineDateOldLegalEntities":{"type":"string","description":"Gets or sets the LATF deadline for old legal entities who are not yet configured.\r\nTemporary property to be removed after the date configured: [System].[Configuration]: LATFDeadline2 - 01/01/2026.","format":"date-time"},"latfDeadlineDateOldNaturalPersons":{"type":"string","description":"Gets or sets the LATF deadline for old natural entities who are not yet configured.\r\nTemporary property to be removed after the date configured: [System].[Configuration]: LATFDeadline3 - 01/07/2026.","format":"date-time"},"creationDateCompany":{"type":"string","format":"date-time"},"motiveNotUseProvisional":{"type":"integer","description":"Get the motive to be out of antifraud law when a provisional authorization representation document has been submitted","format":"int32"},"isAntifraudForcedToConfigure":{"type":"boolean","description":"Whether the antifraud configuration is forced for this tenant"},"latfForcedWithinDeadline":{"type":"boolean","description":"Whether the tenant has a forced antifraud configuration with a deadline greater than the current UTC datetime"}}},"ApplicationInfoDto":{"type":"object","properties":{"frontOfficeURL":{"type":"string"},"name":{"type":"string"}},"description":"Information about applications"},"NPSAnswerResource":{"type":"object","properties":{"Answer1":{"type":"integer","format":"int32"},"Answer2":{"type":"integer","format":"int32"},"Answer3":{"type":"integer","format":"int32"},"Answer4":{"type":"integer","format":"int32"}}},"BankDTO":{"required":["description","iban"],"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"code":{"type":"string","description":"Code"},"description":{"type":"string","description":"Description"},"iban":{"type":"string","description":"Iban"},"swift":{"type":"string","description":"SWIFT"},"isNational":{"type":"boolean","description":"Is national account"},"presenterSuffix":{"type":"string","description":"Presenter suffix"},"creditorSuffix":{"type":"string","description":"Creditor suffix"},"accountCode":{"type":"string","description":"Account code"},"accountId":{"type":"string","description":"Account Id"},"legacyId":{"type":"integer","format":"int32"},"isEnabled":{"type":"boolean","description":"Gets a value indicating whether the bank is enabled.","readOnly":true}},"description":"Bank"},"ChatbotDTO":{"required":["productCode"],"type":"object","properties":{"customerAssetCode":{"type":"string","description":"Customer Asset Code"},"productCode":{"type":"string","description":"Product Code"}}},"ChatbotResponse":{"type":"object","properties":{"chatBotToken":{"type":"string"}}},"CompanyDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Company name"},"idCDA":{"type":"string","description":"CDA"},"default":{"type":"boolean","description":"Default company"},"companyStatus":{"enum":["Updating","Active","Blocked","Error","MustBeUpdated","Creating","ProcessInProgress","PendingToDelete","None"],"type":"string","description":"Company status"}}},"SelectCompanyResponse":{"type":"object","properties":{"companyStatus":{"enum":["Updating","Active","Blocked","Error","MustBeUpdated","Creating","ProcessInProgress","PendingToDelete","None"],"type":"string"},"token":{"type":"string"},"refreshToken":{"type":"string"},"productType":{"type":"integer","format":"int32"}}},"CompanyDataDTO":{"required":["emailFromName","emailReplyToAddress"],"type":"object","properties":{"personType":{"type":"string","description":"Person Type"},"vatNumber":{"type":"string","description":"Vat Number"},"companyName":{"type":"string","description":"Company Name"},"name":{"type":"string","description":"Name"},"surname":{"type":"string","description":"Surname"},"businessName":{"type":"string","description":"Business name"},"address":{"type":"string","description":"Address"},"town":{"type":"string","description":"Town"},"zipCode":{"type":"string","description":"Zip code"},"provinceCode":{"type":"string","description":"Province code"},"countryCode":{"type":"string","description":"Country code"},"phone":{"type":"string","description":"Phone"},"phone2":{"type":"string","description":"Phone 2"},"mail":{"type":"string","description":"e-Mail"},"web":{"type":"string","description":"Web"},"emailCompanyActivated":{"type":"boolean","description":"Email Company Activated"},"emailFromName":{"type":"string","description":"Email From Name"},"emailReplyToAddress":{"type":"string","description":"e-Mail reply to address"},"companyRegimen":{"type":"integer","description":"Regimen","format":"int32"},"invoiceEmittedByThirdParty":{"type":"boolean","description":"Las facturas están emitidas por un tercero (Sí/No)"},"thirdPartyVatNumberType":{"type":"integer","description":"Tipo de documento del tercero\r\nNone = 0,\r\nCif = 1,\r\nNif = 2,\r\nNie = 3,\r\nNifIntracom = 4,\r\nOther = 5,\r\nPassport = 6,\r\nResidenceCountryOfficialDocument = 7,\r\nTaxResidenceCertificate = 8","format":"int32"},"thirdPartyVatNumber":{"type":"string","description":"VAT number del tercero"},"thirdPartyName":{"type":"string","description":"Nombre del tercero"},"thirdPartyCountryCode":{"type":"string","description":"Codigo del pais del tercero"}}},"CompanySettingsDTO":{"required":["irpfCode"],"type":"object","properties":{"activityId":{"type":"string","description":"Activity id"},"saleOperationType":{"type":"string","description":"Sale operation type"},"purchaseOperationType":{"type":"string","description":"Purchase operation type"},"saleVatType":{"type":"string","description":"Sale vat type"},"purchaseVatType":{"type":"string","description":"Purchase vat type id"},"includedTax":{"type":"boolean","description":"Included vat"},"irpfPercentage":{"maximum":100,"minimum":0,"type":"number","description":"IRPF Percentage","format":"double"},"irpfCode":{"type":"string","description":"IRPF Code"},"bankId":{"type":"string","description":"Bank id"},"paymentTypeId":{"type":"string","description":"Payment type id"},"paymentMethodId":{"type":"string","description":"Payment method id"},"saleFeeId":{"type":"string","description":"Sale rate id"},"purchaseRateId":{"type":"string","description":"Purchase rate id"},"quotaCharacter":{"type":"string","description":"Quota character"},"saleInvoiceType":{"type":"string","description":"Sale invoice type"},"saleOfferSerieId":{"type":"string","description":"Sale offer serie id"},"saleOrderSerieId":{"type":"string","description":"Sale order serie id"},"saleDeliveryNoteSerieId":{"type":"string","description":"Sale delivery note serie id"},"saleInvoiceSerieId":{"type":"string","description":"Sale invoice serie id"},"rectificationSaleInvoiceSerieId":{"type":"string","description":"Rectification sale invoice serie id"},"purchaseInvoiceSerieId":{"type":"string","description":"Purchase invoice serie id"},"rectificationPurchaseInvoiceSerieId":{"type":"string","description":"Rectification purchase invoice serie id"},"purchaseDeliveryNoteSerieId":{"type":"string","description":"Purchase delivery note serie id"},"purchaseOrderSerieId":{"type":"string","description":"Purchase order serie id"},"decimalUnits":{"maximum":4,"minimum":0,"type":"integer","description":"Decimals units","format":"int32"},"decimalPrices":{"maximum":4,"minimum":2,"type":"integer","description":"Decimals prices","format":"int32"},"mercantileRegistry":{"type":"string","description":"Mercantile registry"},"gdpr":{"type":"string","description":"General Data Protection Regulation"},"saleOfferTemplateCode":{"type":"string","description":"Sale Offer Template Code"},"saleOrderTemplateCode":{"type":"string","description":"Sale Order Template Code"},"saleDeliveryNoteTemplateCode":{"type":"string","description":"Sale Delivery Note Template Code"},"saleInvoiceTemplateCode":{"type":"string","description":"Sale Invoice Template Code"},"currencyCode":{"type":"string","description":"Currency code"},"allAffectStock":{"type":"boolean","description":"All Affect Stock"},"defaultValuationInProduct":{"type":"string","description":"Default valuation in product:\r\n StandartPrice = \"PEST\"\r\n CostPrice = \"PCOS\"\r\n LastPrice = \"PCOM\""},"allowNegativeStock":{"type":"boolean","description":"Allow Negative Stock"},"accountingPlanConfiguration":{"type":"integer","description":"Accounting configuration plan","format":"int32"},"companyRegimen":{"type":"integer","description":"Regimen","format":"int32"},"confidentiality":{"type":"boolean","description":"Has confidentiality"},"defaultDeliveryLabelTemplateCode":{"type":"string"},"warehouseCorrelationId":{"type":"string"},"lowStockAlert":{"type":"boolean","description":"Low stock alert: show warnings when stock goes below zero\r\n    When AllowNegativeStock is set to false, this values sets automatically to false"},"batches":{"type":"boolean","description":"Has Batches"},"expirationDates":{"type":"boolean","description":"Has Expired Dates"},"allowExpiredDates":{"type":"boolean","description":"Has Allow Expired Dates"},"serialNumbers":{"type":"boolean","description":"Has Serial Numbers"},"allocatedCostsCriteria":{"type":"string","description":"Indicates how the total allocated costs for a document are distributed among its affecting stock lines.\r\n    By base amount = \"B\"\r\n    By units : \"U\""},"saleDiscountId":{"type":"string","description":"Sale discount identifier","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"purchaseDiscountId":{"type":"string","description":"Purchase discount identifier","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"validationAEAT":{"type":"boolean","description":"AEAT validation setting"},"draftTemplateCode":{"type":"string","description":"Draft template code (e.g., \"DraftWord.00001\")"}}},"TBAIInfoDTO":{"required":["companyRegime"],"type":"object","properties":{"manufacture":{"type":"string","description":"Manufacture"},"manufactureVat":{"type":"string","description":"ManufactureVat"},"product":{"type":"string","description":"Product"},"softwareVersion":{"type":"string","description":"SoftwareVersion"},"activationDate":{"type":"string","description":"ActivationDate","format":"date-time"},"taxAdministration":{"type":"integer","description":"TaxAdministration","format":"int32"},"epigraph":{"type":"string","description":"Epigraph"},"lroeType":{"type":"string","description":"LROE Type"},"companyRegime":{"type":"integer","description":"Regimen\r\nGeneral = 1,\r\nSimplified = 2,\r\nEquivalence Surcharge = 3","format":"int32"}},"description":"TBAIInfo"},"ElectronicBillActivationDTO":{"required":["vatNumber","companyName","taxAdministration","activationDate","invoiceTemplate","companyRegime","zipCode"],"type":"object","properties":{"vatNumber":{"type":"string","description":"Vat Number"},"companyName":{"type":"string","description":"Company Name"},"taxAdministration":{"type":"integer","description":"Associated Tax Administration\r\nAraba = 1,\r\nBizkaia = 2,\r\nGipuzkoa = 3","format":"int32"},"activationDate":{"type":"string","description":"TickateBAI activation date","format":"date-time"},"invoiceTemplate":{"type":"string","description":"Report template name for ticketbai invoices"},"epigraph":{"type":"string","description":"TickateBAI Epigraph"},"lroeType":{"type":"integer","description":"TickateBAI LROE Type","format":"int32"},"acceptTerms":{"type":"boolean","description":"Accept terms"},"companyRegime":{"type":"integer","description":"Regimen\r\nGeneral = 1,\r\nSimplified = 2,\r\nEquivalence Surcharge = 3","format":"int32"},"confidentiality":{"type":"boolean","description":"Has confidentiality"},"zipCode":{"type":"string","description":"Company Name"}}},"FakeRealCompanyConfigurationDto":{"type":"object","properties":{"realFakeCompanyType":{"type":"integer","description":"CompanyType\r\nUnknown = 0,\r\nReal = 1,\r\nFake = 2","format":"int32"}}},"ConfigurationValueDTO":{"type":"object","properties":{"key":{"type":"string","description":"Key name"},"value":{"type":"object","description":"Value"}},"description":"Configuration value"},"ReportTemplateDTO":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"},"title":{"type":"string"},"tags":{"type":"string"}}},"AccountsGroupDTO":{"type":"object","properties":{"code":{"type":"string","description":"Code"},"description":{"type":"string","description":"Description"}}},"CompanySettingsAntifraudDTO":{"type":"object","properties":{"allowed":{"type":"boolean"},"reason":{"type":"string"}}},"CompanyInitialSettingDto":{"type":"object","properties":{"realFakeCompanyType":{"type":"integer","description":"CompanyTypI\r\nUnknown = 0,\r\nReal = 1,\r\nFake = 2","format":"int32"},"companyVatNumber":{"type":"string","description":"Company Vat Number"},"companyName":{"type":"string","description":"Company Name"},"personType":{"type":"string","description":"Person Type"}}},"CountryDTO":{"type":"object","properties":{"code":{"type":"string","description":"Code"},"description":{"type":"string","description":"Description"},"vatNumberCode":{"type":"string","description":"Code to identify country from vat number"}},"description":"Country"},"CurrencyDTO":{"type":"object","properties":{"code":{"type":"string","description":"Code"},"iso":{"type":"string","description":"Iso code"},"iso3166":{"type":"string","description":"Iso code 3166"},"description":{"type":"string","description":"Description"},"symbol":{"type":"string","description":"Currency symbol"}},"description":"Currency"},"CustomerDTO":{"required":["name","businessName"],"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"creationDate":{"type":"string","description":"Creation date. Read only.","format":"date-time"},"vatNumber":{"type":"string","description":"VAT number"},"vatNumberType":{"type":"integer","description":"Vat number type\r\nNone = 0,\r\nCif = 1,\r\nNif = 2,\r\nNie = 3,\r\nNifIntracom = 4,\r\nOther = 5,\r\nPassport = 6,\r\nResidenceCountryOfficialDocument = 7,\r\nTaxResidenceCertificate = 8","format":"int32"},"code":{"type":"string","description":"Code"},"name":{"type":"string","description":"TaxName"},"businessName":{"type":"string","description":"Name"},"web":{"type":"string","description":"Web"},"address":{"$ref":"#/components/schemas/AddressDTO"},"phone":{"type":"string","description":"Phone"},"mail":{"type":"string","description":"e-Mail"},"mailCC":{"type":"string","description":"e-Mail CC"},"isSameAddress":{"type":"boolean","description":"Is same address"},"businessAddress":{"$ref":"#/components/schemas/AddressDTO"},"businessPhone":{"type":"string","description":"Business phone"},"businessMail":{"type":"string","description":"Business e-Mail"},"businessMailCC":{"type":"string","description":"Business e-Mail CC"},"annotations":{"type":"string","description":"The annotations attribute."},"rateId":{"type":"string","description":"Rate identifier"},"discountId":{"type":"string","description":"Discount identifier","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"discountPercentage":{"maximum":100,"minimum":0,"type":"number","description":"Discount percentage attribute.","format":"double"},"bankId":{"type":"string","description":"Bank identifier"},"paymentTypeId":{"type":"string","description":"Payment document id"},"paymentMethodId":{"type":"string","description":"Payment method id"},"paymentDay1":{"type":"integer","description":"Payment day 1 attribute.","format":"int32"},"paymentDay2":{"type":"integer","description":"Payment day 2 attribute.","format":"int32"},"paymentDay3":{"type":"integer","description":"Payment day 3 attribute.","format":"int32"},"operationType":{"type":"string","description":"Operation type attribute."},"taxType":{"type":"string","description":"Tax type attribute."},"taxIncluded":{"type":"boolean","description":"Tax included attribute."},"applyIRPF":{"type":"boolean","description":"Apply IRPF attribute."},"sendPdfByEmail":{"type":"boolean","description":"Send PDF by email attribute."},"directDebit":{"$ref":"#/components/schemas/DirectDebitDTO"},"mandateType":{"type":"string","description":"The mandate type attribute."},"mandateReference":{"type":"string","description":"The mandate reference attribute."},"mandateSignatureDate":{"type":"string","description":"The date of the signature attribute.","format":"date-time"},"mandateDebType":{"type":"string","description":"The deb type of the mandate attribute."},"contact":{"$ref":"#/components/schemas/ContactDTO"},"representativeId":{"type":"string","description":"Representative identifier. The identifier of an existing Representative."},"representativeName":{"type":"string","description":"Representative name. The name of an existing Representative."},"source":{"type":"string","description":"Entity source"},"sourceId":{"type":"string","description":"Source entity identifier"},"saleOfferTemplateId":{"type":"string","description":"Sale Offer Template Code"},"saleOrderTemplateId":{"type":"string","description":"Sale Order Template Code"},"saleDeliveryNoteTemplateId":{"type":"string","description":"Sale Delivery Note Template Code"},"saleInvoiceTemplateId":{"type":"string","description":"Sale Invoice Template Code"},"customProperties":{"type":"array","items":{"$ref":"#/components/schemas/CustomPropertyDTO"},"description":"Custom properties"},"accountCode":{"type":"string","description":"Account code"},"accountId":{"type":"string","description":"Account id"},"customerFaceData":{"$ref":"#/components/schemas/CustomerFaceDataDto"},"transactionType":{"type":"integer","description":"Transaction type inferred from the VAT number.\r\nUnknown = 0,\r\nNifOrNie = 1,\r\nB2BNational = 2,\r\nB2G = 3 ,\r\nIntracommunity = 4,\r\nExport = 5","format":"int32"}},"description":"Customer"},"AddressDTO":{"type":"object","properties":{"correlationId":{"type":"string","description":"Read Only\r\nGUID Correlation Id"},"street":{"type":"string","description":"MainAddress"},"town":{"type":"string","description":"Town"},"zipCode":{"type":"string","description":"ZipCode"},"provinceCode":{"type":"string","description":"Province code"},"provinceName":{"type":"string","description":"Province name"},"countryCode":{"type":"string","description":"Country code"},"localization":{"type":"string","description":"Localization"}}},"DirectDebitDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"name":{"type":"string","description":"Name"},"account":{"type":"string","description":"Direct Debit"},"isNational":{"type":"boolean","description":"Is national"},"bicswift":{"type":"string","description":"BIC/SWIFT"},"isDefault":{"type":"boolean","description":"Is default"},"mandateType":{"type":"string","description":"The mandate type"},"mandateReference":{"type":"string","description":"The mandate reference"},"mandateSignatureDate":{"type":"string","description":"The date of the signature","format":"date-time"},"mandateDebType":{"type":"string","description":"The deb type of the mandate\r\nFirst = \"F\"\r\nRecurring = \"R\""}}},"ContactDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"name":{"type":"string","description":"Name"},"mail":{"type":"string","description":"e-Mail"},"phone":{"type":"string","description":"Phone"},"source":{"type":"string","description":"Entity source"},"sourceId":{"type":"string","description":"Source entity identifier"}}},"CustomPropertyDTO":{"type":"object","properties":{"propertyName":{"type":"string","description":"PropertyName"},"propertyValue":{"type":"object","description":"PropertyValue"}},"description":"CustomPropertiesDTO"},"CustomerFaceDataDto":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"accountingOfficeCode":{"type":"string","description":"Accounting Office Code"},"accountingOffice":{"type":"string","description":"Accounting Office Description"},"organManagingCode":{"type":"string","description":"Organ Managing Code"},"organManaging":{"type":"string","description":"Organ Managing Description"},"processingUnitCode":{"type":"string","description":"Processing Unit Code"},"processingUnit":{"type":"string","description":"Processing Unit Description"},"proposingOrganCode":{"type":"string","description":"Proposing Organ Code"},"proposingOrgan":{"type":"string","description":"Proposing Organ Description"}}},"FeeDTO":{"required":["description","invoiceType","taxTypeCode","operationTypeCode","incomeTypeId"],"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"productId":{"type":"string","description":"Product identifier"},"description":{"type":"string","description":"Description"},"price":{"type":"number","description":"Price","format":"double"},"discountPercentage":{"type":"number","description":"Discount percentage","format":"double"},"serieId":{"type":"string","description":"Serie identifier"},"invoiceType":{"type":"string","description":"Invoice type: 'B': Goods. 'S': Services. 'F': Real state. 'I': Real inversion"},"isIndependentInvoice":{"type":"boolean","description":"Is Independent Invoice"},"taxTypeCode":{"type":"string","description":"Tax Type Code"},"operationTypeCode":{"type":"string","description":"Operation type identifier"},"incomeTypeId":{"type":"string","description":"Income type identifier"},"taxBase":{"type":"number","description":"Tax base","format":"double"},"applyJanuary":{"type":"boolean","description":"Apply January"},"applyFebruary":{"type":"boolean","description":"Apply February"},"applyMarch":{"type":"boolean","description":"Apply March"},"applyApril":{"type":"boolean","description":"Apply April"},"applyMay":{"type":"boolean","description":"Apply May"},"applyJune":{"type":"boolean","description":"Apply June"},"applyJuly":{"type":"boolean","description":"Apply July"},"applyAugust":{"type":"boolean","description":"Apply August"},"applySeptember":{"type":"boolean","description":"Apply September"},"applyOctober":{"type":"boolean","description":"Apply October"},"applyNovember":{"type":"boolean","description":"Apply November"},"applyDecember":{"type":"boolean","description":"Apply December"},"lastEmission":{"type":"string","description":"Last emission","format":"date-time"},"lastEmissionState":{"type":"integer","description":"Last emission state: '0': Not generated. '1': Invoice generated. '2': Invoice generated with modifications.","format":"int32"},"nextEmission":{"type":"string","description":"Next emission","format":"date-time"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/FeeTagDTO"},"description":"Custom properties"},"activityId":{"type":"string","description":"Activity identifier"},"lastEmissionIsDraft":{"type":"boolean","description":"Last fee emission is draft"},"isObsolete":{"type":"boolean","description":"Is obsolete"}}},"FeeTagDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"tagId":{"type":"string","description":"Identifier"},"description":{"type":"string","description":"Description"}}},"CustomerAddressDTO":{"required":["types","correlationId"],"type":"object","properties":{"street":{"type":"string","description":"MainAddress"},"town":{"type":"string","description":"Town"},"zipCode":{"type":"string","description":"ZipCode"},"provinceCode":{"type":"string","description":"Province code"},"provinceName":{"type":"string","description":"Province name"},"countryCode":{"type":"string","description":"Country code"},"localization":{"type":"string","description":"Localization"},"phone":{"type":"string","description":"Phone"},"mail":{"type":"string","description":"e-Mail"},"mailCC":{"type":"string","description":"e-Mail CC"},"carrierId":{"type":"string","description":"Carrier Id","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"types":{"type":"array","items":{"type":"integer","format":"int32"},"description":"Address types\r\nCommercial = 1\r\nTax = 2\r\nDefault delivery = 3\r\nDelivery = 4"},"correlationId":{"type":"string","description":"GUID Correlation Id"}}},"CustomerContactDTO":{"required":["name"],"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"name":{"type":"string","description":"Name"},"mail":{"type":"string","description":"e-Mail"},"phone":{"type":"string","description":"Phone"},"phone2":{"type":"string","description":"Phone2"}}},"FlatCustomerDTO":{"type":"object","properties":{"id":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"vatNumber":{"type":"string"},"vatNumberType":{"type":"integer","format":"int32"},"code":{"type":"string"},"name":{"type":"string"},"businessName":{"type":"string"},"web":{"type":"string"},"street":{"type":"string"},"zipCode":{"type":"string"},"town":{"type":"string"},"province":{"type":"string"},"phone":{"type":"string"},"mail":{"type":"string"},"businessStreet":{"type":"string"},"businessZipCode":{"type":"string"},"businessTown":{"type":"string"},"businessProvince":{"type":"string"},"businessPhone":{"type":"string"},"businessMail":{"type":"string"},"accountCode":{"type":"string"},"accountId":{"type":"string"},"source":{"type":"string","description":"Source"},"sourceId":{"type":"string","description":"Source identifier"},"enabled":{"type":"boolean","description":"Enabled"},"legacyId":{"type":"integer","format":"int32"},"transactionType":{"type":"integer","format":"int32"},"sendPdfByEmail":{"type":"integer","format":"int32"}}},"ExportDataRequest":{"type":"object","properties":{"format":{"enum":["Excel"],"type":"string","description":"Export format"},"headers":{"type":"string","description":"Headers"},"title":{"type":"string","description":"Title"},"pageNumber":{"type":"integer","description":"Page number","format":"int32"},"pageSize":{"type":"integer","description":"Number of items","format":"int32"},"selection":{"type":"string","description":"Collection of properties"},"orderBy":{"type":"string","description":"Order by"},"searchBy":{"type":"string","description":"Generic search"},"filter":{"type":"string","description":"Filter"}},"description":"Export data request"},"CustomSchemaDTO":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Dictionay name"},"description":{"type":"string","description":"Dictionay description"},"applicationId":{"type":"integer","description":"Application","format":"int32"}},"description":"Schema class"},"CustomSchemaCreateDTO":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Dictionay name"},"description":{"type":"string","description":"Dictionay description"}},"description":"Schema class"},"CustomSchemaUpdateDTO":{"type":"object","properties":{"description":{"type":"string","description":"Dictionay description"}},"description":"Schema class"},"EntityDTO":{"type":"object","properties":{"name":{"type":"string","description":"Entity name"},"description":{"type":"string","description":"Entity description"}},"description":"Entity class"},"PropertyDTO":{"required":["propertyName","type","label"],"type":"object","properties":{"propertyName":{"type":"string","description":"Property name"},"type":{"type":"integer","description":"Property type\r\nBool = 1\r\nDate = 2   \r\nDecimal = 3\r\nText = 4\r\nCombo = 5,\r\nValueSet = 6","format":"int32"},"values":{"type":"string","description":"Values"},"defaultValue":{"type":"string","description":"Default value"},"isSystem":{"type":"boolean","description":"Is system"},"label":{"type":"string","description":"Label"}},"description":"Custom property definition"},"PropertyUpdateDTO":{"required":["label"],"type":"object","properties":{"values":{"type":"string","description":"Values"},"defaultValue":{"type":"string","description":"Default value"},"isSystem":{"type":"boolean","description":"Is system"},"label":{"type":"string","description":"Label"}},"description":"Property Update definition"},"DraftDTO":{"type":"object","properties":{"id":{"type":"string"},"date":{"type":"string","format":"date-time"},"type":{"enum":["None","Invoice","PurchaseInvoice"],"type":"string"},"user":{"type":"string"},"processId":{"type":"string"},"status":{"enum":["Active","Deleted","Invoiced"],"type":"string"},"draftNumber":{"type":"integer","format":"int64"},"content":{"type":"string"},"massiveProcessId":{"type":"string"},"sourceType":{"enum":["Unknown","Offer","Order","DeliveryNote","Invoice","PurchaseDeliveryNote","PurchaseInvoice","PurchaseOrder","InvoiceDraft","Fee"],"type":"string"},"documentNumber":{"type":"string"}}},"PrintCommand":{"type":"object","properties":{"templateId":{"type":"string","description":"Template Identifier"},"searchBy":{"type":"string","description":"SearchBy"},"filter":{"type":"string","description":"Filter"},"selectedIds":{"type":"array","items":{"type":"string"},"description":"List of selected invoices"},"excludedIds":{"type":"array","items":{"type":"string"},"description":"List of excluded invoices"},"state":{"type":"integer","description":"State: \r\nIndeterminate = 0,\r\nChecked = 1,\r\nUnchecked = 2","format":"int32"}}},"DeleteDraftsCommand":{"type":"object","properties":{"type":{"enum":["None","Invoice","PurchaseInvoice"],"type":"string"},"searchBy":{"type":"string","description":"SearchBy"},"filter":{"type":"string","description":"Filter"},"selectedIds":{"type":"array","items":{"type":"string"},"description":"List of selected invoices"},"excludedIds":{"type":"array","items":{"type":"string"},"description":"List of excluded invoices"},"state":{"type":"integer","description":"State: \r\nIndeterminate = 0,\r\nChecked = 1,\r\nUnchecked = 2","format":"int32"}}},"BillDraftsCommand":{"type":"object","properties":{"invoiceDate":{"type":"string","format":"date-time"},"transactionDateBehavior":{"type":"integer","format":"int32"},"transactionDate":{"type":"string","format":"date-time"},"type":{"enum":["None","Invoice","PurchaseInvoice"],"type":"string"},"searchBy":{"type":"string","description":"SearchBy"},"filter":{"type":"string","description":"Filter"},"selectedIds":{"type":"array","items":{"type":"string"},"description":"List of selected invoices"},"excludedIds":{"type":"array","items":{"type":"string"},"description":"List of excluded invoices"},"state":{"type":"integer","description":"State: \r\nIndeterminate = 0,\r\nChecked = 1,\r\nUnchecked = 2","format":"int32"}}},"ChargeDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"date":{"type":"string","description":"Date","format":"date-time"},"chargeDate":{"type":"string","description":"Charge Date","format":"date-time"},"returnDate":{"type":"string","description":"Return Date","format":"date-time"},"invoiceDate":{"type":"string","description":"Invoice Date","format":"date-time"},"amount":{"type":"number","description":"Amount","format":"double"},"currency":{"type":"string","description":"Currency"},"bankId":{"type":"string","description":"Bank Id"},"payDocumentId":{"type":"string","description":"Pay Document Id"},"payDocumentDescription":{"type":"string","description":"Pay Document Description"},"payDocumentRemittable":{"type":"boolean","description":"Pay Document Remitted"},"directDebitId":{"type":"string","description":"Direct debit Id"},"state":{"type":"number","description":"State","format":"double"},"customerName":{"type":"string","description":"Customer name"},"invoiceNumber":{"type":"string","description":"Invoice number"},"directDebitBankAccount":{"type":"string","description":"Direct debit account"},"directDebitDescription":{"type":"string","description":"Direct debit description"},"directDebitSwift":{"type":"string","description":"Direct debit Swift"},"directDebitIsNacional":{"type":"boolean","description":"Direct debit is nacional"},"bankDescription":{"type":"string","description":"Bank description"},"remitted":{"type":"boolean","description":"Remitted"},"remittanceNumber":{"type":"string","description":"Remittance Number"},"mandateType":{"type":"string","description":"Mandate Type"},"mandateReference":{"type":"string","description":"Mandate Type"},"bankStatementCorrelationId":{"type":"string","description":"Bank statment Id"},"customerId":{"type":"string","description":"Customer Id"},"invoiceId":{"type":"string","description":"saleInvoice Id"},"remittanceId":{"type":"string","description":"Remittance Id"},"isMigrated":{"type":"boolean","description":"IsMigrated. Read only."},"journala3InnuvaId":{"type":"string","description":"Journal a3InnuvaId. Read only."},"returnJournala3InnuvaId":{"type":"string","description":"Return Journal a3InnuvaId. Read only."}}},"PaymentDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"date":{"type":"string","description":"Date","format":"date-time"},"payDate":{"type":"string","description":"Charge Date","format":"date-time"},"invoiceDate":{"type":"string","description":"Invoice Date","format":"date-time"},"amount":{"type":"number","description":"Amount","format":"double"},"currency":{"type":"string","description":"Currency"},"bankId":{"type":"string","description":"Bank Id"},"payDocumentId":{"type":"string","description":"Pay Document Id"},"payDocumentDescription":{"type":"string","description":"Pay Document Description"},"directDebitId":{"type":"string","description":"Direct debit Id"},"state":{"type":"number","description":"State","format":"double"},"supplierName":{"type":"string","description":"Supplier name"},"invoiceNumber":{"type":"string","description":"Invoice number"},"supplierInvoiceNumber":{"type":"string","description":"Supplier invoice number"},"directDebitBankAccount":{"type":"string","description":"Direct debit account"},"directDebitDescription":{"type":"string","description":"Direct debit description"},"directDebitSwift":{"type":"string","description":"Direct debit Swift"},"directDebitIsNacional":{"type":"boolean","description":"Direct debit is nacional"},"bankDescription":{"type":"string","description":"Bank description"},"supplierId":{"type":"string","description":"Supplier Id"},"invoiceId":{"type":"string","description":"Puchase Invoice Id"},"isInmediatePayment":{"type":"boolean","description":"Puchase Invoice is inmediate Payment"},"isMigrated":{"type":"boolean","description":"IsMigrated. Read only."},"journala3InnuvaId":{"type":"string","description":"Journal a3InnuvaId. Read only."},"returnJournala3InnuvaId":{"type":"string","description":"Return Journal a3InnuvaId. Read only."},"bankStatementCorrelationId":{"type":"string"}},"description":"PaymentDTO"},"DueDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"date":{"type":"string","description":"Date","format":"date-time"},"chargeDate":{"type":"string","description":"Charge Date","format":"date-time"},"returnDate":{"type":"string","description":"Return Date","format":"date-time"},"invoiceDate":{"type":"string","description":"Invoice Date","format":"date-time"},"amount":{"type":"number","description":"Amount","format":"double"},"currency":{"type":"string","description":"Currency"},"bankId":{"type":"string","description":"Bank Id"},"payDocumentId":{"type":"string","description":"Pay Document Id"},"payDocumentDescription":{"type":"string","description":"Pay Document Description"},"payDocumentRemittable":{"type":"boolean","description":"Pay Document Remitted"},"directDebitId":{"type":"string","description":"Direct debit Id"},"state":{"type":"number","description":"State","format":"double"},"customerName":{"type":"string","description":"Customer name"},"customerDocument":{"type":"string","description":"Customer document"},"supplierDocument":{"type":"string","description":"Supplier document"},"invoiceNumber":{"type":"string","description":"Invoice number"},"directDebitBankAccount":{"type":"string","description":"Direct debit account"},"directDebitDescription":{"type":"string","description":"Direct debit description"},"directDebitSwift":{"type":"string","description":"Direct debit Swift"},"directDebitIsNacional":{"type":"boolean","description":"Direct debit is nacional"},"customerTown":{"type":"string","description":"Town"},"customerCountry":{"type":"string","description":"Country"},"customerMainAddress":{"type":"string","description":"Main address"},"customerPostalCode":{"type":"string","description":"Postal code"},"bankDescription":{"type":"string","description":"Bank description"},"remitted":{"type":"boolean","description":"Remitted"},"remittanceNumber":{"type":"string","description":"Remittance Number"},"mandateType":{"type":"string","description":"Mandate Type"},"mandateReference":{"type":"string","description":"Mandate Type"},"customerId":{"type":"string","description":"Customer Id"},"invoiceId":{"type":"string","description":"saleInvoice Id"},"purchaseInvoiceId":{"type":"string"},"remittanceId":{"type":"string","description":"Remittance Id"},"parentDueId":{"type":"string","description":"ParentDue Id"},"bankStatementCorrelationId":{"type":"string","description":"Bank statment Id"},"purchaseReference":{"type":"string","description":"Reference"},"journala3InnuvaId":{"type":"string","description":"Journal a3InnuvaId. Read only."},"returnJournala3InnuvaId":{"type":"string","description":"Return Journal a3InnuvaId. Read only."}}},"ChargesByCriteriaDto":{"type":"object","properties":{"amount":{"type":"number","format":"double"},"statementDate":{"type":"string","format":"date-time"},"concept":{"type":"string"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"}}},"BankPaymentDto":{"type":"object","properties":{"id":{"type":"string","description":"Identity"},"invoiceId":{"type":"string","description":"purchaseInvoice Id"},"invoiceNumber":{"type":"string","description":"Invoice number"},"date":{"type":"string","format":"date-time"},"dateAsString":{"type":"string"},"effectiveDate":{"type":"string","format":"date-time"},"effectiveDateAsString":{"type":"string"},"invoicePersonaDocument":{"type":"string","description":"VATNumber Invoice Supplier"},"invoicePersonaName":{"type":"string","description":"Name Invoice Client"},"amount":{"type":"number","description":"Amount","format":"double"},"amountAsString":{"type":"string","description":"Amount"},"state":{"type":"integer","description":"State     \r\nPending = 1\r\nCharged  = 2\r\nReturned = 3","format":"int32"},"source":{"type":"string","description":"Data Origin"},"bankStatementCorrelationId":{"type":"string","description":"Bank Statement CorrelationId"}}},"BankChargeDto":{"type":"object","properties":{"id":{"type":"string","description":"Identity"},"invoiceId":{"type":"string","description":"saleInvoice Id"},"invoiceNumber":{"type":"string","description":"Invoice number"},"date":{"type":"string","format":"date-time"},"effectiveDate":{"type":"string","format":"date-time"},"dateAsString":{"type":"string"},"effectiveDateAsString":{"type":"string"},"invoicePersonaDocument":{"type":"string","description":"VATNumber Invoice Client"},"invoicePersonaName":{"type":"string","description":"Name Invoice Client"},"amount":{"type":"number","description":"Amount","format":"double"},"amountAsString":{"type":"string","description":"Amount"},"state":{"type":"integer","description":"State     \r\nPending = 1\r\nCharged  = 2\r\nReturned = 3","format":"int32"},"source":{"type":"string","description":"Data Origin"},"bankStatementCorrelationId":{"type":"string","description":"Bank Statement CorrelationId"}}},"ReconcileDto":{"required":["maturitiesIds","bankStatement"],"type":"object","properties":{"difference":{"$ref":"#/components/schemas/DifferenceDto"},"validation":{"$ref":"#/components/schemas/ValidationDto"},"maturitiesIds":{"type":"array","items":{"type":"string"},"description":"Dues correlation ids"},"bankStatement":{"$ref":"#/components/schemas/BankStatementDto"}}},"DifferenceDto":{"required":["amount"],"type":"object","properties":{"amount":{"type":"number","description":"Difference amount","format":"double"},"accountingAccount":{"type":"string","description":"Account associated to the difference amount"}}},"ValidationDto":{"type":"object","properties":{"date":{"type":"string","description":"Validation date","format":"date-time"},"isBankStatementUnmanaged":{"type":"boolean","description":"Boolean indicating if the bank statement is unmanaged"}}},"BankStatementDto":{"required":["id","amount","depositDate","bankAccount"],"type":"object","properties":{"id":{"type":"string","description":"BankStatement Correlation Id"},"amount":{"type":"number","description":"BankStatement amount","format":"double"},"depositDate":{"type":"string","description":"Bank account","format":"date-time"},"bankAccount":{"type":"string","description":"BankStatement amount"}}},"DeconciliateDto":{"type":"object","properties":{"bankStatementCorrelationId":{"type":"string","description":"BankStatement Correlation Id"}}},"ReconciliateDto":{"required":["bankStatementCorrelationId","duesCorrelationIds","totalAmount","totalCommissionAmount","bankCode","depositeDate","date"],"type":"object","properties":{"bankStatementCorrelationId":{"type":"string","description":"BankStatement Correlation Id"},"duesCorrelationIds":{"type":"array","items":{"type":"string"},"description":"Dues correlation ids"},"totalAmount":{"type":"number","description":"Conciliation amount","format":"double"},"totalCommissionAmount":{"type":"number","description":"Commission amount","format":"double"},"commissionAccountCode":{"type":"string","description":"Commission account code"},"bankCode":{"type":"string","description":"Iban"},"depositeDate":{"type":"string","description":"Deposite Date","format":"date-time"},"date":{"type":"string","description":"Bank date","format":"date-time"},"document":{"type":"string","description":"Bank document"}}},"EpigraphDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Id","format":"int32"},"epigraphCode":{"type":"string","description":"Invoice type description"},"ticketBaiCode":{"type":"string","description":"DocumentNumber"},"descriptionES":{"type":"string","description":"Customer name"},"descriptionEUS":{"type":"string","description":"Log status description"}},"description":"EpigraphDTO"},"ExpenseTypeDTO":{"required":["description"],"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"description":{"type":"string","description":"Name"},"accountsGroupCode":{"type":"string","description":"Accounts group code"},"accountCode":{"type":"string","description":"Account code"},"accountId":{"type":"string","description":"Account id"},"creditAccountCode":{"type":"string","description":"Credit account code"},"creditAccountId":{"type":"string","description":"Credit account id"},"isSystem":{"type":"boolean","description":"Is system. Read only"},"legacyId":{"type":"integer","format":"int32"}}},"ExpenseTypeSaveDTO":{"required":["description"],"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"description":{"type":"string","description":"Name"},"accountsGroupCode":{"type":"string","description":"Accounts group code"},"accountId":{"type":"string","description":"Account id"},"creditAccountId":{"type":"string","description":"Credit account id"},"typeSaveMode":{"enum":["ByLicense","ByAccountIds","ByGroupCodes"],"type":"string"}}},"ExportJSONCommand":{"required":["vatNumber","accountCodeLength","year","startMonth","endMonth","activity"],"type":"object","properties":{"vatNumber":{"type":"string","description":"The company VAT Number"},"accountCodeLength":{"type":"integer","description":"Account code length","format":"int32"},"accountingPeriodStart":{"type":"string","description":"The day where the accounting period starts (if not informed January 1st will be assumed)","format":"date-time"},"year":{"type":"integer","description":"Year to export","format":"int32"},"startMonth":{"type":"integer","description":"Start month to export","format":"int32"},"endMonth":{"type":"integer","description":"End month to export","format":"int32"},"activity":{"type":"string","description":"Company activity Id","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"cashManagementLocation":{"type":"string"}}},"ExportSuEnlaceCommand":{"required":["companyECOCode","startYear","startMonth","endYear","endMonth"],"type":"object","properties":{"companyECOCode":{"type":"string","description":"Company ECO Code"},"startYear":{"maximum":9999,"minimum":1900,"type":"integer","description":"Start year","format":"int32"},"startMonth":{"maximum":12,"minimum":1,"type":"integer","description":"Start month","format":"int32"},"endYear":{"maximum":9999,"minimum":1900,"type":"integer","description":"End year","format":"int32"},"endMonth":{"maximum":12,"minimum":1,"type":"integer","description":"End month","format":"int32"},"activityId":{"type":"string","description":"Activity identifier"}}},"FeedbackResource":{"required":["windowTitle","comment","isPositive","feedbackType","ratio"],"type":"object","properties":{"window":{"type":"string","description":"Gets or sets the window."},"windowTitle":{"type":"string","description":"Gets or sets the window."},"comment":{"type":"string","description":"Gets or sets the description."},"isPositive":{"type":"boolean","description":"Gets or sets the description."},"feedbackType":{"type":"string","description":"Query = 1,\r\nError = 2,\r\nImprovement = 3,\r\nTraining = 4,\r\nOINV=5"},"ratio":{"type":"integer","description":"Gets or sets the description.","format":"int32"},"image":{"type":"array","description":"Gets or sets the description."}},"description":"The telemetry resource."},"FeePeriodLogDTO":{"type":"object","properties":{"period":{"type":"integer","description":"Period","format":"int32"},"year":{"type":"integer","description":"Year","format":"int32"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/FeeTagDTO"},"description":"Tags"},"draftId":{"type":"integer","description":"Draft identifier","format":"int32"}}},"PeriodFeeDTO":{"required":["description","invoiceType","taxTypeCode","operationTypeCode","incomeTypeId"],"type":"object","properties":{"customerName":{"type":"string","description":"Customer identifier"},"feeTags":{"type":"array","items":{"type":"string"},"description":"Fee Tags"},"id":{"type":"string","description":"Identifier"},"productId":{"type":"string","description":"Product identifier"},"description":{"type":"string","description":"Description"},"price":{"type":"number","description":"Price","format":"double"},"discountPercentage":{"type":"number","description":"Discount percentage","format":"double"},"serieId":{"type":"string","description":"Serie identifier"},"invoiceType":{"type":"string","description":"Invoice type: 'B': Goods. 'S': Services. 'F': Real state. 'I': Real inversion"},"isIndependentInvoice":{"type":"boolean","description":"Is Independent Invoice"},"taxTypeCode":{"type":"string","description":"Tax Type Code"},"operationTypeCode":{"type":"string","description":"Operation type identifier"},"incomeTypeId":{"type":"string","description":"Income type identifier"},"taxBase":{"type":"number","description":"Tax base","format":"double"},"applyJanuary":{"type":"boolean","description":"Apply January"},"applyFebruary":{"type":"boolean","description":"Apply February"},"applyMarch":{"type":"boolean","description":"Apply March"},"applyApril":{"type":"boolean","description":"Apply April"},"applyMay":{"type":"boolean","description":"Apply May"},"applyJune":{"type":"boolean","description":"Apply June"},"applyJuly":{"type":"boolean","description":"Apply July"},"applyAugust":{"type":"boolean","description":"Apply August"},"applySeptember":{"type":"boolean","description":"Apply September"},"applyOctober":{"type":"boolean","description":"Apply October"},"applyNovember":{"type":"boolean","description":"Apply November"},"applyDecember":{"type":"boolean","description":"Apply December"},"lastEmission":{"type":"string","description":"Last emission","format":"date-time"},"lastEmissionState":{"type":"integer","description":"Last emission state: '0': Not generated. '1': Invoice generated. '2': Invoice generated with modifications.","format":"int32"},"nextEmission":{"type":"string","description":"Next emission","format":"date-time"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/FeeTagDTO"},"description":"Custom properties"},"activityId":{"type":"string","description":"Activity identifier"},"lastEmissionIsDraft":{"type":"boolean","description":"Last fee emission is draft"},"isObsolete":{"type":"boolean","description":"Is obsolete"}}},"BillFeesCommand":{"required":["feesId","generationYear","generationPeriod"],"type":"object","properties":{"feesId":{"type":"array","items":{"type":"string"},"description":"List of fees id"},"date":{"type":"string","description":"Document Date","format":"date-time"},"operationDate":{"type":"string","description":"Operation Date","format":"date-time"},"generationYear":{"maximum":9999,"minimum":1900,"type":"integer","description":"Generation year","format":"int32"},"generationPeriod":{"maximum":12,"minimum":1,"type":"integer","description":"Generation period","format":"int32"}}},"IncomeTypeDTO":{"required":["description"],"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"description":{"type":"string","description":"Name"},"accountsGroupCode":{"type":"string","description":"Accounts group code"},"accountCode":{"type":"string","description":"Account code"},"accountId":{"type":"string","description":"Account id"},"creditAccountCode":{"type":"string","description":"Credit account code"},"creditAccountId":{"type":"string","description":"Credit account id"},"isSystem":{"type":"boolean","description":"Is system. Read only"},"legacyId":{"type":"integer","format":"int32"}}},"IncomeTypeSaveDTO":{"required":["description"],"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"description":{"type":"string","description":"Name"},"accountsGroupCode":{"type":"string","description":"Accounts group code"},"accountId":{"type":"string","description":"Account id"},"creditAccountId":{"type":"string","description":"Credit account id"},"typeSaveMode":{"enum":["ByLicense","ByAccountIds","ByGroupCodes"],"type":"string"}}},"InventoryDtoWithWarehouse":{"type":"object","properties":{"warehouseCode":{"type":"string"},"warehouseDescription":{"type":"string"},"isEditable":{"type":"boolean"},"id":{"type":"string","description":"Identifier"},"date":{"type":"string","description":"Date","format":"date-time"},"reason":{"type":"string","description":"Reason"},"warehouseCorrelationId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}},"InventoryDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"date":{"type":"string","description":"Date","format":"date-time"},"reason":{"type":"string","description":"Reason"},"warehouseCorrelationId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}},"description":"Inventory"},"InventoryLineDto":{"type":"object","properties":{"correlationId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"productId":{"type":"integer","format":"int32"},"productCorrelationId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"productCode":{"type":"string"},"productDescription":{"type":"string"},"stockUnits":{"type":"number","format":"double"},"stockUnitsCalculated":{"type":"number","format":"double"},"traceabilityDetails":{"type":"array","items":{"$ref":"#/components/schemas/TraceabilityDetailDto"}}}},"TraceabilityDetailDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the traceability detail.\r\n     \r\n- Required for update."},"batch":{"maxLength":25,"minLength":0,"type":"string","description":"Batch associated with a product. \r\n     \r\n- Required if the doucment line product is configured to use batches.\r\n- Maximum length of 25 characters."},"expirationDate":{"type":"string","description":"Expiration date of the batch. \r\n\r\n- Required if the document line product is configured to use expiration dates.","format":"date-time"},"serialNumber":{"maxLength":25,"minLength":0,"type":"string","description":"Serial number of the product. \r\n      \r\n- Required and unique if the document line product is configured to use serial numbers.\r\n- Maximum length of 25 characters."},"units":{"type":"number","description":"Units of the batch or serial number of a product. \r\n\r\n- Required if the document line product is configured to use serial numbers.\r\n- The units must be 1 if the product uses serial numbers.\r\n- the units can't be zero","format":"double"},"entryDate":{"type":"string","description":"Entry date. \r\n\r\n- Required for out operations when the expiration date is not configured.","format":"date-time"},"packages":{"pattern":"^-?(0|[1-9]\\d*)$","type":"number","description":"Packages. Default value is 0","format":"double"},"bundles":{"pattern":"^-?(0|[1-9]\\d*)$","type":"number","description":"Bundles. Default value is 0","format":"double"}},"description":"Represents the traceability detail of an document line."},"KpiDTO":{"type":"object","properties":{"key":{"type":"string","description":"Parameter name"},"value":{"type":"string","description":"Parameter Value"}},"description":"Represent a parameter"},"LegalRepresentativeDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Id numerico","format":"int32"},"name":{"type":"string","description":"Nombre del representante legal"},"nif":{"type":"string","description":"NIF del representante"},"town":{"type":"string","description":"Poblacion del representante"},"address":{"type":"string","description":"Direccion del representante"},"correlationId":{"type":"string","description":"CorrelationId del representante","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"personType":{"type":"string","description":"PersonaFisica = 'P',\r\nPersonaJuridica = 'E',"}}},"LicenseDTO":{"type":"object","properties":{"licenses":{"type":"integer","format":"int32"},"state":{"type":"integer","format":"int32"},"gamma":{"type":"integer","format":"int32"},"endDate":{"type":"string","format":"date-time"}}},"StartMigrationCommand":{"type":"object","properties":{"TenantId":{"type":"string"},"ProcessId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"CorrelationId":{"type":"string"},"Id":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"Emitted":{"type":"string","format":"date-time"},"EmittedStamp":{"type":"integer","format":"int64"},"Headers":{"type":"object","additionalProperties":{"type":"string"}},"FromTenantId":{"type":"string"},"SyncItems":{"type":"array","items":{"$ref":"#/components/schemas/SyncItem"}},"MigrationScenario":{"type":"integer","format":"int32"}}},"SyncItem":{"type":"object","properties":{"Entity":{"type":"string"},"SourceCorrelationId":{"type":"string"},"TargetCorrelationId":{"type":"string"}}},"ModuleTokenDTO":{"type":"object","properties":{"application":{"$ref":"#/components/schemas/ApplicationDTO"},"idcda":{"type":"string"},"companyName":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"frontOfficeURL":{"type":"string"},"backOfficeURL":{"type":"string"},"price":{"type":"number","format":"double"},"state":{"type":"integer","format":"int32"},"changeStateInfo":{"type":"string"},"credentials":{"type":"string"}}},"ApplicationDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"eMail":{"type":"string"}}},"ModuleTokenPUTDTO":{"type":"object","properties":{"frontOfficeURL":{"type":"string"},"backOfficeURL":{"type":"string"},"price":{"type":"number","format":"double"},"state":{"type":"integer","description":"Configuring = 3,\r\nActive = 4,\r\nRejected = 5\r\nRejectedInProgress = 6","format":"int32"},"changeStateInfo":{"type":"string"}}},"TokenDTO":{"type":"object","properties":{"access_token":{"type":"string"},"refresh_token":{"type":"string"},"expires_in":{"type":"integer","format":"int32"},"token_type":{"type":"string"}}},"ApplicationTokenDTO":{"type":"object","properties":{"id":{"type":"string"},"application":{"$ref":"#/components/schemas/ApplicationDTO"},"company":{"$ref":"#/components/schemas/CompanyDTO"},"token":{"type":"string"},"refresh":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"frontOfficeURL":{"type":"string"},"backOfficeURL":{"type":"string"}}},"OrganizationDTO":{"required":["name"],"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"name":{"type":"string","description":"Name"},"vatNumber":{"type":"string","description":"VAT Number"},"phone":{"type":"string","description":"Tax Phone"},"mail":{"type":"string","description":"Tax e-Mail"},"street":{"type":"string","description":"Tax street"},"town":{"type":"string","description":"Tax Town"},"zipCode":{"type":"string","description":"Tax ZipCode"},"provinceCode":{"type":"string","description":"Tax Province code"},"countryCode":{"type":"string","description":"Tax Country code"},"vatNumberType":{"type":"integer","description":"Vat number type\r\nNone = 0,\r\nCif = 1,\r\nNif = 2,\r\nNie = 3,\r\nNifIntracom = 4,\r\nOther = 5,\r\nPassport = 6,\r\nResidenceCountryOfficialDocument = 7,\r\nTaxResidenceCertificate = 8","format":"int32"},"addressCorrelationId":{"type":"string","description":"Read Only\r\nTax address correlation Id"}},"description":"Persona"},"PaymentMethodDTO":{"required":["code","description"],"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"code":{"type":"string","description":"Code"},"description":{"type":"string","description":"Name"},"promptPaymentDiscountPercentage":{"maximum":100,"minimum":0,"type":"number","description":"Prompt payment discount percentage\r\nValue must be between 0.00 and 100.00.","format":"double"},"financialChargePercentage":{"maximum":100,"minimum":0,"type":"number","description":"Financial charge percentage\r\nValue must be between 0.00 and 100.00.","format":"double"},"numberOfDues":{"maximum":10,"minimum":1,"type":"integer","description":"Number of dues. Value must be between 1 and 10.","format":"int32"},"firstPeriod":{"maximum":365,"minimum":0,"type":"integer","description":"First period. Value must be between 0 and 365.","format":"int32"},"nextPeriod":{"maximum":365,"minimum":0,"type":"integer","description":"Next period. Value must be between 0 and 365.","format":"int32"},"calculationMethod":{"type":"integer","description":"Calculation method","format":"int32"},"automaticPayment":{"type":"boolean","description":"Charge or pay automatically on create invoice process"}},"description":"Payment Method"},"SerieDTO":{"required":["code","description"],"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"code":{"type":"string","description":"Code"},"description":{"type":"string","description":"Name"},"a3InnuvaActivityId":{"type":"string","description":"A3InnuvaActivityId (Deprecated)"}},"description":"Serie"},"PaymentTypeDTO":{"required":["code","description"],"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"code":{"type":"string","description":"Code"},"description":{"type":"string","description":"Name"},"remittable":{"type":"boolean","description":"Can be included in a remittance"}},"description":"Payment Type"},"ProcessLogDTO":{"type":"object","properties":{"processId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"correlationId":{"type":"string"},"id":{"type":"string"},"tenantId":{"type":"string"},"processType":{"type":"integer","format":"int32"},"processStatus":{"type":"integer","format":"int32"},"createdDate":{"type":"string","format":"date-time"},"startDate":{"type":"string","format":"date-time"},"endDate":{"type":"string","format":"date-time"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ProcessResultDTO"}},"processName":{"type":"string"},"params":{"type":"string"},"userName":{"type":"string"},"parentId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"processDescriptions":{"type":"object","additionalProperties":{"type":"string"}}}},"ProcessResultDTO":{"type":"object","properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"}}},"ProcessLogFlatDTO":{"type":"object","properties":{"processId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"id":{"type":"string"},"tenantId":{"type":"string"},"processType":{"type":"integer","format":"int32"},"processStatus":{"type":"integer","format":"int32"},"createdDate":{"type":"string","format":"date-time"},"startDate":{"type":"string","format":"date-time"},"endDate":{"type":"string","format":"date-time"},"processName":{"type":"string"},"params":{"type":"string"},"userName":{"type":"string"},"parentId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"processTypeDescription":{"type":"string"},"processStatusDescription":{"type":"string"}}},"InboxProcessNotification":{"type":"object","properties":{"ProcessId":{"type":"string"},"HasErrors":{"type":"boolean"},"ProcessName":{"type":"string"},"TenantId":{"type":"string"},"User":{"type":"string"}}},"DeleteProcessLogDto":{"type":"object","properties":{"filter":{"type":"string","description":"Filter"},"searchBy":{"type":"string","description":"Search by"},"selectedIds":{"type":"array","items":{"type":"string"},"description":"List of selected invoices"},"excludedIds":{"type":"array","items":{"type":"string"},"description":"List of excluded invoices"},"state":{"type":"integer","description":"State: \r\nIndeterminate = 0,\r\nChecked = 1,\r\nUnchecked = 2","format":"int32"}}},"ProductDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"code":{"type":"string","description":"Code"},"description":{"type":"string","description":"Description.\r\nIf the product is a variant, this field will be read-only"},"alternativeProductId":{"type":"string","description":"Alternative product code"},"supplierId":{"type":"string","description":"Supplier id"},"supplierReference":{"type":"string","description":"Alternative product code"},"isSale":{"type":"boolean","description":"Is sale"},"incomeTypeId":{"type":"string","description":"Income type Id"},"saleTaxCode":{"type":"string","description":"Sale tax code. The SaleTaxCode field will be ignored if the product is a kit"},"isPurchase":{"type":"boolean","description":"Is purchase"},"expenseTypeId":{"type":"string","description":"Expense type Id"},"purchaseTaxCode":{"type":"string","description":"Purchase tax code. The PurchaseTaxCode field will be ignored if the product is a kit"},"blocked":{"type":"boolean","description":"Blocked"},"blockedReason":{"type":"string","description":"Blocked reason"},"affectsStock":{"type":"boolean","description":"Affects stock.\r\nWill always be false if UseDimensions is true"},"stockUnits":{"type":"number","description":"Stock units. Read only","format":"double"},"unitsInPackage":{"type":"number","description":"Units in package","format":"double"},"packagesInBundle":{"type":"integer","description":"Packages in bundle","format":"int32"},"standardPrice":{"type":"number","description":"Standard price","format":"double"},"lastPurchaseDate":{"type":"string","description":"Last purchase date. Read only","format":"date-time"},"lastUnitPurchasePrice":{"type":"number","description":"Last purchase price. Read only","format":"double"},"lastPurchaseDiscount":{"type":"number","description":"Last purchase discount. Read only","format":"double"},"lastNetPurchasePrice":{"type":"number","description":"Last net purchase price. Read only","format":"double"},"criteriaValuation":{"type":"string","description":"Default criteria valuation:\r\n StandartPrice = \"PEST\"\r\n CostPrice = \"PCOS\"\r\n LastPrice = \"PCOM\"\r\n AccordingOptions = \"OPTN\"\r\n PMP = \"PMP\""},"unitValuation":{"type":"number","description":"Unit valuation. Read only","format":"double"},"stockValuation":{"type":"number","description":"Stock valuation. Read only","format":"double"},"salePrice":{"type":"number","description":"Sale price","format":"double"},"saleCurrency":{"type":"string","description":"Sale currency. Read only"},"purchasePrice":{"type":"number","description":"Purchase price","format":"double"},"purchaseCurrency":{"type":"string","description":"Purchase currency. Read only"},"annotations":{"type":"string","description":"Annotations"},"creationDate":{"type":"string","description":"Creation date. Read only","format":"date-time"},"source":{"type":"string","description":"Entity source"},"sourceId":{"type":"string","description":"Source entity identifier"},"customProperties":{"type":"array","items":{"$ref":"#/components/schemas/CustomPropertyDTO"},"description":"Custom properties"},"confidentiality":{"type":"boolean","description":"Confidentiality.\r\nDefault false.\r\nNot applies if is kit"},"isKit":{"type":"boolean","description":"Is Kit.\r\nRead only"},"excludedEquivalenceSurcharge":{"type":"boolean","description":"Is excluded of equivalence surcharge"},"batches":{"type":"boolean","description":"Indicates if batches are used in traceability.\r\nDefault value is false"},"expirationDates":{"type":"boolean","description":"Indicates if expired dates are used in traceability.\r\nDefault value is false"},"allowExpiredDates":{"type":"boolean","description":"Indicates if expired dates are allowed in traceability.\r\nDefault value is false"},"expiredFormat":{"type":"integer","description":"Specifies the format for expired dates used in traceability.\r\nPossible values:\r\n  dd_mm_aaaa = 0,\r\n  dd_mm_aa = 1,\r\n  mm_aaaa = 2,\r\n  mm_aa = 3,\r\n  BeforeEndOf_aaaa = 4\r\nDefault value is dd_mm_aaaa = 0","format":"int32"},"serialNumbers":{"type":"boolean","description":"Indicates if serial numbers are used in traceability.\r\nDefault value is false"},"salesCriteria":{"type":"integer","description":"Sales Criteria field determines whether product sales traceability is automatic or manual.\r\n Automatic = 0\r\n Manual = 1\r\nDefault value is Automatic = 0","format":"int32"},"useDimensions":{"type":"boolean","description":"Use Dimensions.\r\nRead only"},"variantsAffectStock":{"type":"boolean","description":"Variant inherits properties from the parent product\r\nDetermines whether the product variants affects stock.\r\nOnly used when UseDimensions is true.\r\nCannot be modified once the variants have been created"},"parentProductId":{"type":"string","description":"Identifier of the parent product.\r\nRead only","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"isInheritingFromParent":{"type":"boolean","description":"Variant configuration details for the product, including parent relationship and inheritance settings"}},"description":"Product"},"KitProductConfigurationDto":{"required":["useKitIncomeType","useKitPrice","components"],"type":"object","properties":{"useKitIncomeType":{"type":"boolean","description":"Behavior used for income type. By default <strong>True</strong>\r\n- False: if you want to get income type of components, kit income type will be ignored\r\n- True: if you want to get income type of kit, components income types will be ignored"},"useKitPrice":{"type":"boolean","description":"Behavior used to calculate prices. By default <strong>True</strong>\r\n- False: if you want to get price of components, kit price will be ignored\r\n- True: if you want to get price of kit, components prices will be ignored"},"components":{"type":"array","items":{"$ref":"#/components/schemas/ComponentProductDto"},"description":"Kit component products"}},"description":"Product Kit Configuration"},"ComponentProductDto":{"required":["productId","units"],"type":"object","properties":{"productId":{"type":"string","description":"Component existing product identifier","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"units":{"type":"number","description":"Units. The value must be greater than 0","format":"double"}},"description":"Components Products to KitProductConfigurationDTO"},"SaleRateDTO":{"required":["rateId","price"],"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"rateId":{"type":"string","description":"Rate"},"price":{"type":"number","description":"Price","format":"double"}},"description":"Sale rate"},"StockInformationDTO":{"type":"object","properties":{"stockUnits":{"type":"number","description":"Stock Units","format":"double"},"purchaseReservationUnits":{"type":"number","description":"Purchase reservation units","format":"double"},"saleReservationUnits":{"type":"number","description":"Sale reservation units","format":"double"},"reservationUnits":{"type":"number","description":"Reservation units","format":"double"}}},"FlatProductDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"code":{"type":"string","description":"Code"},"description":{"type":"string","description":"Description"},"incomeTypeDescription":{"type":"string","description":"Income type Id"},"salePrice":{"type":"number","description":"Sale price","format":"double"},"saleCurrency":{"type":"string","description":"Sale currency"},"purchaseTypeDescription":{"type":"string","description":"Expense type Id"},"purchasePrice":{"type":"number","description":"Purchase price","format":"double"},"purchaseCurrency":{"type":"string","description":"Purchase currency"},"creationDate":{"type":"string","description":"Create date","format":"date-time"},"affectsStock":{"type":"boolean","description":"Affects stock"},"stockUnits":{"type":"number","description":"Stock units. Read only","format":"double"},"unitsInPackage":{"type":"number","description":"Units in packages","format":"double"},"packagesInBundle":{"type":"number","description":"Packages in bundles","format":"double"},"source":{"type":"string","description":"Source"},"sourceId":{"type":"string","description":"Source identifier"},"isKit":{"type":"boolean","description":"Is kit"},"hasTraceability":{"type":"boolean","description":"Has traceability"},"salesCriteria":{"type":"integer","description":"Sales Criteria field determines whether product sales traceability is automatic or manual.\r\n Automatic = 0\r\n Manual = 1\r\nDefault value is Automatic = 0","format":"int32"},"useDimensions":{"type":"boolean","description":"Use Dimensions"}},"description":"flat product dto"},"ProductVariantsDto":{"type":"object","properties":{"attributes":{"type":"array","items":{"$ref":"#/components/schemas/ProductVariantDto"}}}},"ProductVariantDto":{"type":"object","properties":{"dimensionId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"attributeId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}},"ProvinceDTO":{"type":"object","properties":{"code":{"type":"string","description":"Code"},"description":{"type":"string","description":"Description"}},"description":"Province"},"PurchaseDeliveryNoteDTO":{"required":["lines"],"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"date":{"type":"string","description":"Date. If null, system date is used.","format":"date-time"},"receptionDate":{"type":"string","description":"Reception date. If null, system date is used.","format":"date-time"},"supplierId":{"type":"string","description":"Supplier identifier. The identifier of an existing Supplier."},"activityId":{"type":"string","description":"Activity identifier. Null = Default activity selected in options. Other values = An existing activity of the company."},"serieId":{"type":"string","description":"Serie identifier. Null = Default serie selected in options. Other values = An existing serie of the company."},"number":{"type":"integer","description":"Number","format":"int64"},"documentNumber":{"type":"string","description":"DocumentNumber. Read only."},"reference":{"type":"string","description":"Reference"},"paymentMethodId":{"type":"string","description":"Payment Method identifier. Null = Default payment method selected in supplier. Other values = An existing payment method of the company."},"paymentTypeId":{"type":"string","description":"Payment Type identifier. Null= Default payment type selected in supplier. Other values = An existing payment type of the company."},"vatNumber":{"type":"string","description":"Vat number"},"name":{"type":"string","description":"Name"},"email":{"type":"string","description":"Email"},"emailCC":{"type":"string","description":"Email"},"address":{"type":"string","description":"Tax address"},"zipCode":{"type":"string","description":"Tax zip code"},"town":{"type":"string","description":"Tax town"},"provinceCode":{"type":"string","description":"Tax province code"},"provinceName":{"type":"string","description":"Tax province name"},"countryCode":{"type":"string","description":"Tax country code"},"addressDetails":{"type":"string","description":"Tax address details"},"operationTypeCode":{"type":"string","description":"Sale operation type code"},"isTaxIncluded":{"type":"boolean","description":"Is tax included in the order"},"isTaxBaseAffected":{"type":"boolean","description":"Is tax base affected in the order"},"promptPaymentPercentage":{"maximum":100,"minimum":0,"type":"number","description":"Prompt payment percentage","format":"double"},"financialSurchargePercentage":{"maximum":100,"minimum":0,"type":"number","description":"Financial surcharge percentage","format":"double"},"annotations":{"type":"string","description":"Annotations"},"taxBase":{"type":"number","description":"Delivery note tax base. Read only.","format":"double"},"totalTax":{"type":"number","description":"Delivery note total tax. Read only.","format":"double"},"total":{"type":"number","description":"Delivery note total. Read only.","format":"double"},"source":{"type":"string","description":"Entity source."},"sourceId":{"type":"string","description":"Source entity identifier."},"version":{"type":"string","description":"Document version. Read only"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/PurchaseDeliveryNoteLineDto"},"description":"Lines"},"customProperties":{"type":"array","items":{"$ref":"#/components/schemas/CustomPropertyDTO"},"description":"List of custom properties"},"billable":{"type":"boolean","description":"Billable"},"situation":{"type":"string","description":"Situation. Read only"},"totalPromptPayment":{"type":"number","description":"Total prompt payment","format":"double"},"totalFinancialSurcharge":{"type":"number","description":"Total financial surcharge","format":"double"},"currency":{"type":"string","description":"Currency. Read only"},"taxRetentionPercentage":{"maximum":100,"minimum":0,"type":"number","description":"Tax retention percentage","format":"double"},"taxRetentionBase":{"type":"number","description":"Tax retention base","format":"double"},"totalRetention":{"type":"number","description":"Delivery note total retention. Read only","format":"double"},"warehouseCorrelationId":{"type":"string","description":"Warehouse CorrelationId","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"rateId":{"type":"string","description":"nullable: true\r\nPurchase Rate Identifier. Non-mandatory field. Required when Purchase Rates functionality is enabled in the company.","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"discountId":{"type":"string","description":"Purchase Discount identifier. Null = No discount applied. Other values = An existing discount of the company.","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}},"PurchaseDeliveryNoteLineDto":{"type":"object","properties":{"id":{"type":"string","description":"Id"},"description":{"type":"string","description":"Description"},"units":{"type":"number","description":"Units. Default value is 1.","format":"double"},"servedUnits":{"type":"number","description":"Served units. Read only","format":"double"},"cancelledUnits":{"type":"number","description":"Cancelled units. Read only","format":"double"},"price":{"type":"number","description":"Price. Default value is 0.","format":"double"},"discountRate1":{"maximum":100,"minimum":0,"type":"number","description":"Discount rate. Default value is the client discount.","format":"double"},"productId":{"type":"string","description":"Id Product. Default value is null"},"productCode":{"type":"string","description":"Product code. Only for display purposes. Read only."},"taxTypeCode":{"type":"string","description":"Tax type code"},"taxRate":{"type":"number","description":"Tax rate. Read only.","format":"double"},"taxSurchargeRate":{"type":"number","description":"Tax surcharge","format":"double"},"isExpense":{"type":"boolean","description":"Expenses paid on behalf of the client?"},"taxBase":{"type":"number","description":"Tax base. Read only.","format":"double"},"annotations":{"type":"string","description":"Annotations"},"expenseTypeId":{"type":"string","description":"Id Expense type. Default value is null"},"customProperties":{"type":"array","items":{"$ref":"#/components/schemas/CustomPropertyDTO"},"description":"List of custom properties"},"situation":{"type":"string","description":"Situation. Read only\r\nA = Active\r\nS = Served"},"sourceDocument":{"$ref":"#/components/schemas/DocumentLineInfoDTO"},"warehouseCorrelationId":{"type":"string","description":"Warehouse CorrelationId","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"traceabilityDetails":{"type":"array","items":{"$ref":"#/components/schemas/TraceabilityDetailDto"},"description":"This collection contains the specific traceability information for the product in the invoice line. \r\n   \r\nIt is mandatory to inform whether the product has traceability, and the sum of the quantities of these details must be equal to the number of units in the line."},"priceOrigin":{"type":"string","description":"Price origin: None, Rate, Product, Manual"},"discountOrigin":{"type":"string","description":"Discount origin: None, Discount, Supplier, Manual"},"supplierProductReferenceCode":{"type":"string"},"supplierProductReferenceDescription":{"type":"string"}},"description":"Sale delivery note line"},"DocumentLineInfoDTO":{"type":"object","properties":{"id":{"type":"string","description":"Id Document"},"documentType":{"type":"integer","description":"Offer = 0,\r\nOrder = 1,\r\nDeliveryNote = 3,\r\nInvoice = 4,","format":"int32"},"number":{"type":"string","description":"Document number"},"units":{"type":"number","description":"line units","format":"double"},"date":{"type":"string","description":"Creation document date","format":"date-time"},"reference":{"type":"string","description":"Document reference"},"lineId":{"type":"string","description":"LineId Document"}}},"CircuitInfoDTO":{"type":"object","properties":{"lineId":{"type":"string","description":"Id of the line"},"description":{"type":"string","description":"Description"},"units":{"type":"number","description":"Units","format":"double"},"lineBase":{"type":"number","description":"Price","format":"double"},"situation":{"type":"integer","description":"Situation\r\nUnknown = 0,\r\nPending = 1,\r\nIn circuit = 2,\r\nPartially in circuit = 3","format":"int32"},"cancelledUnits":{"type":"number","description":"Cancelled units.","format":"double"},"pendingUnits":{"type":"number","description":"Pending units.","format":"double"},"confirmedUnits":{"type":"number","description":"Confirmed units.","format":"double"},"deliveredUnits":{"type":"number","description":"Delivered units.","format":"double"},"billedUnits":{"type":"number","description":"Billed units.","format":"double"}}},"FlatPurchaseDeliveryNoteDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"number":{"type":"string","description":"Number"},"date":{"type":"string","description":"Date","format":"date-time"},"receptionDate":{"type":"string","description":"Delivery Date.","format":"date-time"},"reference":{"type":"string","description":"Reference"},"supplierVATNumber":{"type":"string","description":"Supplier VATNumber."},"supplierName":{"type":"string","description":"Supplier name"},"email":{"type":"string","description":"Document email"},"taxBase":{"type":"number","description":"Tax base","format":"double"},"taxTotal":{"type":"number","description":"Tax total","format":"double"},"total":{"type":"number","description":"Total","format":"double"},"currency":{"type":"string","description":"Currency"},"purchaseOperationTypeCode":{"type":"string","description":"Purchase operation type code"},"purchaseOperationTypeDescription":{"type":"string","description":"Purchase operation type description"},"situation":{"type":"string","description":"Situation\r\nActive = \"A\"\r\nPartially Served = \"P\"\r\nServed = \"S\""},"billable":{"type":"boolean","description":"Billable"},"source":{"type":"string","description":"Source"},"sourceId":{"type":"string","description":"Source identifier"},"activityId":{"type":"string","description":"Activity identifier"},"activityDescription":{"type":"string","description":"Activity description"}}},"ServeDocumentCommand":{"type":"object","properties":{"date":{"type":"string","description":"Date to serve new document","format":"date-time"},"reference":{"type":"string","description":"Reference to serve new document"},"cancelRest":{"type":"boolean","description":"Cancel rest"},"sourceLines":{"type":"array","items":{"$ref":"#/components/schemas/SourceLineDTO"},"description":"List of lines to serve"},"serie":{"type":"string","description":"Document serie"}}},"SourceLineDTO":{"required":["lineId","units"],"type":"object","properties":{"lineId":{"type":"string","description":"Id of the line to serve"},"units":{"type":"number","description":"units to serve","format":"double"},"bundles":{"pattern":"^-?(0|[1-9]\\d*)$","type":"number","description":"Bundles to serve. Default value is 0.","format":"double"},"packages":{"pattern":"^-?(0|[1-9]\\d*)$","type":"number","description":"Pacakages to serve. Default value is 0.","format":"double"},"traceabilityDetails":{"type":"array","items":{"$ref":"#/components/schemas/SourceTraceabilityDetailDto"},"description":"This collection contains the specific traceability information for the product in the invoice line. \r\n   \r\nIt is mandatory to inform whether the product has traceability, and the sum of the quantities of these details must be equal to the number of units in the line."},"componentsLine":{"type":"array","items":{"$ref":"#/components/schemas/SourceLineDTO"},"description":"This collection contais the component lines with their tracebaility if the line is a kit"}}},"SourceTraceabilityDetailDto":{"type":"object","properties":{"batch":{"maxLength":25,"minLength":0,"type":"string","description":"Batch associated with a product. \r\n     \r\n- Required if the doucment line product is configured to use batches.\r\n- Maximum length of 25 characters."},"expirationDate":{"type":"string","description":"Expiration date of the batch. \r\n\r\n- Required if the document line product is configured to use expiration dates.","format":"date-time"},"serialNumber":{"maxLength":25,"minLength":0,"type":"string","description":"Serial number of the product. \r\n      \r\n- Required and unique if the document line product is configured to use serial numbers.\r\n- Maximum length of 25 characters."},"units":{"type":"number","description":"Units of the batch or serial number of a product. \r\n\r\n- Required if the document line product is configured to use serial numbers.\r\n- The units must be 1 if the product uses serial numbers.\r\n- the units can't be zero","format":"double"},"entryDate":{"type":"string","description":"Entry date. \r\n\r\n- Required for out operations when the expiration date is not configured.","format":"date-time"}},"description":"Represents the traceability detail of an document line."},"PurchaseDocumentDTO":{"required":["lines"],"type":"object","properties":{"id":{"type":"string","description":"Identifier."},"documentType":{"type":"integer","description":"Source entity kind\r\nInvoice = 0,\r\nSupply = 1","format":"int32"},"date":{"type":"string","description":"Date. If null, system date is used.","format":"date-time"},"accountingDate":{"type":"string","description":"Date. If null, system date is used.","format":"date-time"},"supplierId":{"type":"string","description":"Supplier identifier."},"activityId":{"type":"string","description":"Activity identifier. Null = Default activity selected in options. Other values = An existing activity of the company."},"serieId":{"type":"string","description":"Serie identifier. Null = Default serie selected in options. Other values = An existing serie of the company."},"number":{"type":"integer","description":"Number","format":"int64"},"documentNumber":{"type":"string","description":"DocumentNumber"},"reference":{"type":"string","description":"Reference."},"bankId":{"type":"string","description":"Bank identifier. Null = Default bank selected in supplier.  Other values = An existing bank of the company."},"paymentMethodId":{"type":"string","description":"Payment Method identifier. Null = Default payment method selected in supplier. Other values = An existing payment method of the company."},"paymentTypeId":{"type":"string","description":"Payment Type identifier. Null= Default payment type selected in supplier. Other values = An existing payment type of the company."},"vatNumber":{"type":"string","description":"Vat number"},"vatNumberType":{"type":"integer","description":"Vat number type\r\nNone = 0,\r\nCif = 1,\r\nNif = 2,\r\nNie = 3,\r\nNifIntracom = 4,\r\nOther = 5,\r\nPassport = 6,\r\nResidenceCountryOfficialDocument = 7,\r\nTaxResidenceCertificate = 8","format":"int32"},"name":{"type":"string","description":"Name"},"email":{"type":"string","description":"Email"},"emailCC":{"type":"string","description":"Email"},"address":{"type":"string","description":"Tax address"},"zipCode":{"type":"string","description":"Tax zip code"},"town":{"type":"string","description":"Tax town"},"provinceCode":{"type":"string","description":"Tax province code"},"provinceName":{"type":"string","description":"Tax province name"},"countryCode":{"type":"string","description":"Tax country code"},"addressDetails":{"type":"string","description":"Tax address details"},"directDebitId":{"type":"string","description":"Direct debit identifier."},"operationTypeCode":{"type":"string","description":"Purchase operation type code"},"invoiceType":{"type":"string","description":"Invoice type\r\nCommon services = \"S\"\r\nCommon goods = \"C\"\r\nInvestments = \"I\""},"isRent":{"type":"boolean","description":"Is rent invoice"},"isTaxIncluded":{"type":"boolean","description":"Is tax included in the invoice"},"isTaxBaseAffected":{"type":"boolean","description":"Is tax base affected in the invoice"},"totalPromptPayment":{"type":"number","description":"Total prompt payment","format":"double"},"promptPaymentPercentage":{"maximum":100,"minimum":0,"type":"number","description":"Prompt payment percentage","format":"double"},"totalFinancialSurcharge":{"type":"number","description":"Total financial surcharge","format":"double"},"financialSurchargePercentage":{"maximum":100,"minimum":0,"type":"number","description":"Financial surcharge percentage","format":"double"},"taxRetentionBase":{"type":"number","description":"Tax retention base","format":"double"},"withholdingPercentage":{"maximum":100,"minimum":0,"type":"number","description":"Withholding percentage","format":"double"},"withholdingModel":{"type":"string","description":"Withholding model\r\nModel 111 = \"110\"\r\nModel 115/180 = \"115\"\r\nModel 123 = \"123\"\r\nOther models = \"OTR\""},"withholdingKeyId":{"type":"integer","description":"Withholding key id","format":"int32"},"withholdingSubKeyId":{"type":"integer","description":"Withholding subkey id","format":"int32"},"annotations":{"type":"string","description":"Annotations"},"taxBase":{"type":"number","description":"Invoice tax base. Read only.","format":"double"},"totalTax":{"type":"number","description":"Invoice total tax. Read only.","format":"double"},"totalRetention":{"type":"number","description":"Invoice total retention.","format":"double"},"total":{"type":"number","description":"Invoice total. Read only.","format":"double"},"purchaseCurrency":{"type":"string","description":"Purchase currency. Read only."},"situation":{"type":"integer","description":"Situation","format":"int32"},"source":{"type":"string","description":"Entity source"},"sourceId":{"type":"string","description":"Source entity identifier"},"version":{"type":"string","description":"Document version. Read only."},"isInmediatePayment":{"type":"boolean","description":"Is inmediate payment"},"hasAttachment":{"type":"boolean","description":"Has attachment"},"isRectificative":{"type":"boolean","description":"Is rectificative. Read only."},"rectifiedId":{"type":"string","description":"rectified id"},"rectifiedDate":{"type":"string","description":"rectified date. Read only.","format":"date-time"},"rectifiedNumber":{"type":"string","description":"rectified number. Read only."},"isRectified":{"type":"boolean","description":"Is rectified. Read only."},"rectificativeId":{"type":"string","description":"rectificative id. Read only."},"rectificativeDate":{"type":"string","description":"rectificative date. Read only.","format":"date-time"},"rectificativeNumber":{"type":"string","description":"rectificative number. Read only."},"deductionDate":{"type":"string","description":"Deduction date.","format":"date-time"},"duaNumber":{"type":"string","description":"Dua Number."},"importSupplierId":{"type":"string","description":"Import supplier identifier."},"importTaxLines":{"type":"array","items":{"$ref":"#/components/schemas/ImportTaxLineDto"},"description":"Import Tax Lines."},"lines":{"type":"array","items":{"$ref":"#/components/schemas/PurchaseInvoiceLineDTO"},"description":"Lines."},"customProperties":{"type":"array","items":{"$ref":"#/components/schemas/CustomPropertyDTO"},"description":"List of custom properties"},"siiData":{"$ref":"#/components/schemas/PurchaseInvoiceSiiDataDto"},"warehouseCorrelationId":{"type":"string","description":"Warehouse CorrelationId","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"isMigrated":{"type":"boolean","description":"IsMigrated. Read only."},"hasPendingCostAllocationProcesses":{"type":"boolean","description":"Indicates if there are pending cost allocation processes for this invoice.\r\nThis counter shows whether additional costs are currently being calculated.\r\nRead only."},"allocatedCostsDistributionCriteria":{"type":"string","description":"Criteria used for the distribution of allocated costs.\r\nRead only."},"rateId":{"type":"string","description":"nullable: true\r\nPurchase Rate Identifier. Non-mandatory field. Required when Purchase Rates functionality is enabled in the company.","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"discountId":{"type":"string","description":"Purchase Discount identifier. Null = No discount applied. Other values = An existing discount of the company.","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}},"ImportTaxLineDto":{"type":"object","properties":{"base":{"type":"number","description":"Base.","format":"double"},"taxType":{"type":"string","description":"TaxType."},"percentage":{"type":"number","description":"Percentage. Read only","format":"double"},"total":{"type":"number","description":"Total.","format":"double"}}},"PurchaseInvoiceLineDTO":{"type":"object","properties":{"id":{"type":"string","description":"Id"},"description":{"type":"string","description":"Description"},"units":{"type":"number","description":"Units. Default value is 1.","format":"double"},"price":{"type":"number","description":"Price. Default value is 0.","format":"double"},"discountRate1":{"maximum":100,"minimum":0,"type":"number","description":"Discount rate. Default value is the supplier discount.","format":"double"},"productId":{"type":"string","description":"Id Product. Default value is null"},"productCode":{"type":"string","description":"Product code. Read only."},"expenseTypeId":{"type":"string","description":"Id Expense type. Default value is null"},"taxDeductionType":{"type":"string","description":"Tax deductionType\r\nNon deductible = \"N\"\r\nDeductible = \"D\""},"taxTypeCode":{"type":"string","description":"Tax type code"},"taxRate":{"type":"number","description":"Tax rate. Read only.","format":"double"},"taxSurchargeRate":{"type":"number","description":"Tax surcharge","format":"double"},"isExpense":{"type":"boolean","description":"Expenses paid on behalf of the supplier?"},"taxBase":{"type":"number","description":"Tax base. Read only.","format":"double"},"sourceDocument":{"$ref":"#/components/schemas/DocumentLineInfoDTO"},"annotations":{"type":"string","description":"Annotations"},"affectStock":{"type":"boolean","description":"Line affects stock. Read only."},"idFeePeriodLog":{"type":"string"},"additionalCost":{"type":"number","description":"Additional cost calculated to the allocated unit cost.Read only.","format":"double"},"customProperties":{"type":"array","items":{"$ref":"#/components/schemas/CustomPropertyDTO"},"description":"List of custom properties"},"warehouseCorrelationId":{"type":"string","description":"Warehouse CorrelationId","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"traceabilityDetails":{"type":"array","items":{"$ref":"#/components/schemas/TraceabilityDetailDto"},"description":"This collection contains the specific traceability information for the product in the invoice line. \r\n   \r\nIt is mandatory to inform whether the product has traceability, and the sum of the quantities of these details must be equal to the number of units in the line."},"priceOrigin":{"type":"string","description":"Price origin: None, Rate, Product, Manual"},"discountOrigin":{"type":"string","description":"Discount origin: None, Discount, Supplier, Manual"},"rectifiedId":{"type":"string","description":"RectifiedCorrelationId"},"supplierProductReferenceCode":{"type":"string"},"supplierProductReferenceDescription":{"type":"string"}}},"PurchaseInvoiceSiiDataDto":{"type":"object","properties":{"id":{"type":"string","description":"Identifier."},"documentId":{"type":"integer","description":"Document Id","format":"int32"},"invoiceDescription":{"type":"string","description":"Invoice Description"},"numberInitialInvoice":{"type":"string","description":"Number initial invoice"},"numberFinalInvoice":{"type":"string","description":"Number final invoice"},"invoiceSpecialRegime":{"type":"boolean","description":"Is invoice in special regime?"},"taxBaseAtCost":{"type":"number","description":"Tax base at cost","format":"double"},"siiRegistrationDate":{"type":"string","description":"Sii Registration Date","format":"date-time"},"regimeCode":{"type":"string","description":"Regime type"},"documentTypeCode":{"type":"string","description":"Document type"},"a3InnuvaId":{"type":"string","description":"A3InnuvaId","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}},"FlatPurchaseDocumentDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"documentType":{"type":"string","description":"Document Type"},"purchaseKind":{"type":"integer","description":"Purchase Kind\r\nInvoice = 0,\r\nSupply = 1","format":"int32"},"number":{"type":"string","description":"Number"},"reference":{"type":"string","description":"Reference"},"date":{"type":"string","description":"Date","format":"date-time"},"accountingDate":{"type":"string","description":"Date","format":"date-time"},"supplierId":{"type":"string","description":"Supplier SupplierId."},"supplierVATNumber":{"type":"string","description":"VATNumber."},"supplierName":{"type":"string","description":"Name"},"email":{"type":"string","description":"Document email"},"taxBase":{"type":"number","description":"Tax base","format":"double"},"taxTotal":{"type":"number","description":"Tax total","format":"double"},"withholdingTotal":{"type":"number","description":"Withholding total","format":"double"},"total":{"type":"number","description":"Total","format":"double"},"purchaseCurrency":{"type":"string","description":"Purchase currency"},"purchaseOperationTypeCode":{"type":"string","description":"Purchase operation type code"},"purchaseOperationTypeDescription":{"type":"string","description":"Purchase operation type description"},"invoiceType":{"type":"string","description":"Invoice type"},"situation":{"type":"integer","description":"Situation","format":"int32"},"isInmediatePayment":{"type":"boolean","description":"Is inmediate payment"},"isRectificative":{"type":"boolean","description":"Is rectificative"},"rectifiedId":{"type":"string","description":"rectified id"},"rectifiedDate":{"type":"string","description":"rectified date","format":"date-time"},"rectifiedNumber":{"type":"string","description":"rectified number"},"isRectified":{"type":"boolean","description":"Is rectified"},"rectificativeId":{"type":"string","description":"rectificative id"},"rectificativeDate":{"type":"string","description":"rectificative date","format":"date-time"},"rectificativeNumber":{"type":"string","description":"rectificative number"},"hasAttachment":{"type":"boolean","description":"Has attachment"},"hasAttachmentToExport":{"type":"string","description":"Has attachment to export"},"activityId":{"type":"string","description":"Activity identifier"},"activityDescription":{"type":"string","description":"Activity description"},"isMigrated":{"type":"boolean","description":"IsMigrated. Read only."}}},"PortfolioPurchaseInvoiceDTO":{"type":"object","properties":{"payments":{"type":"array","items":{"$ref":"#/components/schemas/PaymentDTO"}}}},"PayCommand":{"type":"object","properties":{"date":{"type":"string","description":"Cash date","format":"date-time"},"ammount":{"type":"number","description":"Amount","format":"double"},"bankId":{"type":"string","description":"Pay due bank"},"paymentDocumentId":{"type":"string","description":"Payment document id"},"directDebitId":{"type":"string","description":"Direct debit id"}}},"PurchaseInvoiceDTO":{"required":["lines"],"type":"object","properties":{"id":{"type":"string","description":"Identifier."},"date":{"type":"string","description":"Date. If null, system date is used.","format":"date-time"},"accountingDate":{"type":"string","description":"Date. If null, system date is used.","format":"date-time"},"supplierId":{"type":"string","description":"Supplier identifier."},"activityId":{"type":"string","description":"Activity identifier. Null = Default activity selected in options. Other values = An existing activity of the company."},"serieId":{"type":"string","description":"Serie identifier. Null = Default serie selected in options. Other values = An existing serie of the company."},"number":{"type":"integer","description":"Number","format":"int64"},"documentNumber":{"type":"string","description":"DocumentNumber. Read only."},"reference":{"type":"string","description":"Reference."},"bankId":{"type":"string","description":"Bank identifier. Null = Default bank selected in supplier.  Other values = An existing bank of the company."},"paymentMethodId":{"type":"string","description":"Payment Method identifier. Null = Default payment method selected in supplier. Other values = An existing payment method of the company."},"paymentTypeId":{"type":"string","description":"Payment Type identifier. Null= Default payment type selected in supplier. Other values = An existing payment type of the company."},"vatNumber":{"type":"string","description":"Vat number"},"vatNumberType":{"type":"integer","description":"Vat number type\r\nNone = 0,\r\nCif = 1,\r\nNif = 2,\r\nNie = 3,\r\nNifIntracom = 4,\r\nOther = 5,\r\nPassport = 6,\r\nResidenceCountryOfficialDocument = 7,\r\nTaxResidenceCertificate = 8","format":"int32"},"name":{"type":"string","description":"Name"},"email":{"type":"string","description":"Email"},"emailCC":{"type":"string","description":"Email"},"address":{"type":"string","description":"Tax address"},"zipCode":{"type":"string","description":"Tax zip code"},"town":{"type":"string","description":"Tax town"},"provinceCode":{"type":"string","description":"Tax province code"},"provinceName":{"type":"string","description":"Tax province name"},"countryCode":{"type":"string","description":"Tax country code"},"addressDetails":{"type":"string","description":"Tax address details"},"directDebitId":{"type":"string","description":"Direct debit identifier."},"operationTypeCode":{"type":"string","description":"Purchase operation type code"},"invoiceType":{"type":"string","description":"Invoice type\r\nCommon services = \"S\"\r\nCommon goods = \"C\"\r\nInvestments = \"I\""},"isRent":{"type":"boolean","description":"Is rent invoice"},"isTaxIncluded":{"type":"boolean","description":"Is tax included in the invoice"},"isTaxBaseAffected":{"type":"boolean","description":"Is tax base affected in the invoice"},"totalPromptPayment":{"type":"number","description":"Total prompt payment","format":"double"},"promptPaymentPercentage":{"maximum":100,"minimum":0,"type":"number","description":"Prompt payment percentage","format":"double"},"totalFinancialSurcharge":{"type":"number","description":"Total financial surcharge","format":"double"},"financialSurchargePercentage":{"maximum":100,"minimum":0,"type":"number","description":"Financial surcharge percentage","format":"double"},"taxRetentionBase":{"type":"number","description":"Tax retention base","format":"double"},"withholdingPercentage":{"maximum":100,"minimum":0,"type":"number","description":"Withholding percentage","format":"double"},"withholdingModel":{"type":"string","description":"Withholding model\r\nModel 111 = \"110\"\r\nModel 115/180 = \"115\"\r\nModel 123 = \"123\"\r\nOther models = \"OTR\""},"withholdingKeyId":{"type":"integer","description":"Withholding key id","format":"int32"},"withholdingSubKeyId":{"type":"integer","description":"Withholding subkey id","format":"int32"},"annotations":{"type":"string","description":"Annotations"},"taxBase":{"type":"number","description":"Invoice tax base. Read only.","format":"double"},"totalTax":{"type":"number","description":"Invoice total tax. Read only.","format":"double"},"totalRetention":{"type":"number","description":"Invoice total retention.","format":"double"},"total":{"type":"number","description":"Invoice total. Read only.","format":"double"},"purchaseCurrency":{"type":"string","description":"Purchase currency. Read only."},"situation":{"type":"integer","description":"Situation. Read only.","format":"int32"},"source":{"type":"string","description":"Entity source."},"sourceId":{"type":"string","description":"Source entity identifier."},"version":{"type":"string","description":"Document version. Read only."},"isRectificative":{"type":"boolean","description":"Is rectificative. Read only."},"rectifiedId":{"type":"string","description":"rectified id. Read only."},"rectifiedDate":{"type":"string","description":"rectified date. Read only.","format":"date-time"},"rectifiedNumber":{"type":"string","description":"rectified number. Read only."},"isRectified":{"type":"boolean","description":"Is rectified. Read only."},"rectificativeId":{"type":"string","description":"rectificative id. Read only."},"rectificativeDate":{"type":"string","description":"rectificative date. Read only.","format":"date-time"},"rectificativeNumber":{"type":"string","description":"rectificative number. Read only."},"deductionDate":{"type":"string","description":"Deduction date.","format":"date-time"},"duaNumber":{"type":"string","description":"Dua Number."},"importSupplierId":{"type":"string","description":"Import supplier identifier."},"importTaxLines":{"type":"array","items":{"$ref":"#/components/schemas/ImportTaxLineDto"},"description":"Import Tax Lines."},"lines":{"type":"array","items":{"$ref":"#/components/schemas/PurchaseInvoiceLineDTO"},"description":"Lines."},"customProperties":{"type":"array","items":{"$ref":"#/components/schemas/CustomPropertyDTO"},"description":"List of custom properties"},"siiData":{"$ref":"#/components/schemas/PurchaseInvoiceSiiDataDto"},"warehouseCorrelationId":{"type":"string","description":"Warehouse CorrelationId","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"isMigrated":{"type":"boolean","description":"IsMigrated. Read only."},"hasPendingCostAllocationProcesses":{"type":"boolean","description":"Indicates if there are pending cost allocation processes for this invoice.\r\nThis counter shows whether additional costs are currently being calculated.\r\nRead only."},"allocatedCostsDistributionCriteria":{"type":"string","description":"Criteria used for the distribution of allocated costs.\r\nRead only."},"rateId":{"type":"string","description":"nullable: true\r\nPurchase Rate Identifier. Non-mandatory field. Required when Purchase Rates functionality is enabled in the company.","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"discountId":{"type":"string","description":"Purchase Discount identifier. Null = No discount applied. Other values = An existing discount of the company.","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}},"SiiRegimeTypeDTO":{"type":"object","properties":{"code":{"type":"string","description":"Regime types codes when not rectifying:\r\nCLAVE_REGIMEN_GENERAL, \r\nCLAVE_AGENCIAS_VIAJES,\r\nCLAVE_COBROS_HONORARIOS (Only for sale invoices),\r\nCLAVE_CERTIFICADOS_ADM_PUBLICA (Only for sale invoices),\r\nCLAVE_TRACTO_SUCESIVO (Only for sale invoices),\r\nCLAVE_AGENCIAS_VIAJE_MEDIADOR (Only for sale invoices),\r\nCLAVE_AGENCIAS_VIAJES_MEDIACION (Only for purchase invoices) \r\nRegime types codes when rectifying:\r\nCLAVE_RECT_REGIMEN_GENERAL,\r\nCLAVE_RECT_AGENCIAS_VIAJES,\r\nCLAVE_RECT_COBROS_HONORARIOS (Only for sale invoices),\r\nCLAVE_RECT_CERTIFICADOS_ADM_PUBLICA (Only for sale invoices),\r\nCLAVE_RECT_TRACTO_SUCESIVO (Only for sale invoices),\r\nCLAVE_RECT_AGENCIAS_VIAJE_MEDIADOR (Only for sale invoices),\r\nCLAVE_RECT_AGENCIAS_VIAJES_MEDIACION (Only for purchase invoices)"},"description":{"type":"string","description":"Description"},"orderUI":{"type":"integer","description":"Order","format":"int32"},"correlationId":{"type":"string","description":"GUID Correlation Id","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"isRectifying":{"type":"boolean"},"documentType":{"type":"integer","format":"int32"}}},"SiiInvoiceTypeDTO":{"type":"object","properties":{"code":{"type":"string","description":"Invoice types codes when not rectifying:\r\nTIPO_FACTURA_COMPLETA, \r\nTIPO_SIMPLIFICADA,\r\nTIPO_FACTURA_SIN_NIF (only for sales invoices),\r\nTIPO_JUSTIFICANTES_CONTABLES (only for purchase invoices)\r\nInvoice types codes when rectifying:\r\nTIPO_RECT_ERROR_FUNDADO,\r\nTIPO_RECT_CONCURSO,\r\nTIPO_RECT_DEUDA_INCOBRABLE,\r\nTIPO_RECT_RESTO,\r\nTIPO_RECT_SIMPLIFICADA,"},"description":{"type":"string","description":"Description"},"orderUI":{"type":"integer","description":"Order","format":"int32"},"correlationId":{"type":"string","description":"GUID Correlation Id","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"isRectifying":{"type":"boolean","description":"Rectifying"},"documentType":{"type":"integer","format":"int32"}}},"FlatPurchaseInvoiceDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"number":{"type":"string","description":"Number"},"date":{"type":"string","description":"Date","format":"date-time"},"accountingDate":{"type":"string","description":"Date","format":"date-time"},"reference":{"type":"string","description":"Reference"},"supplierId":{"type":"string","description":"Supplier SupplierId."},"supplierVATNumber":{"type":"string","description":"VATNumber."},"supplierName":{"type":"string","description":"Name"},"email":{"type":"string","description":"Document email"},"taxBase":{"type":"number","description":"Tax base","format":"double"},"taxTotal":{"type":"number","description":"Tax total","format":"double"},"total":{"type":"number","description":"Total","format":"double"},"purchaseCurrency":{"type":"string","description":"Purchase currency"},"purchaseOperationTypeCode":{"type":"string","description":"Purchase operation type code"},"purchaseOperationTypeDescription":{"type":"string","description":"Purchase operation type description"},"invoiceType":{"type":"string","description":"Invoice type"},"situation":{"type":"integer","description":"Situation","format":"int32"},"isRectificative":{"type":"boolean","description":"Is rectificative"},"rectifiedId":{"type":"string","description":"rectified id"},"rectifiedDate":{"type":"string","description":"rectified date","format":"date-time"},"rectifiedNumber":{"type":"string","description":"rectified number"},"isRectified":{"type":"boolean","description":"Is rectified"},"rectificativeId":{"type":"string","description":"rectificative id"},"rectificativeDate":{"type":"string","description":"rectificative date","format":"date-time"},"rectificativeNumber":{"type":"string","description":"rectificative number"},"source":{"type":"string","description":"Source"},"sourceId":{"type":"string","description":"Source identifier"},"isMigrated":{"type":"boolean","description":"IsMigrated. Read only."}}},"PurchaseOperationTypeDTO":{"type":"object","properties":{"code":{"type":"string","description":"Code"},"description":{"type":"string","description":"Description"},"applyTax":{"type":"boolean","description":"Is Tax applied?"},"applyEquivalenceSurcharge":{"type":"boolean","description":"Is Equivalence Surcharge applied?"},"applyWithholdingAlsoOverTax":{"type":"boolean","description":"Is withholding applied over tax?"},"addTaxToTotal":{"type":"boolean","description":"Tax is added to total?"}},"description":"Purchase operation type"},"PurchaseOrderDTO":{"required":["lines"],"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"date":{"type":"string","description":"Date. If null, system date is used.","format":"date-time"},"deliveryDate":{"type":"string","description":"Delivery date. If null, system date is used.","format":"date-time"},"supplierId":{"type":"string","description":"Supplier identifier. The identifier of an existing Customer."},"activityId":{"type":"string","description":"Activity identifier. Null = Default activity selected in options. Other values = An existing activity of the company."},"serieId":{"type":"string","description":"Serie identifier. Null = Default serie selected in options. Other values = An existing serie of the company."},"number":{"type":"integer","description":"Number","format":"int64"},"documentNumber":{"type":"string","description":"DocumentNumber. Read only."},"reference":{"type":"string","description":"Reference"},"paymentMethodId":{"type":"string","description":"Payment Method identifier. Null = Default payment method selected in customer. Other values = An existing payment method of the company."},"paymentTypeId":{"type":"string","description":"Payment Type identifier. Null= Default payment type selected in customer. Other values = An existing payment type of the company."},"vatNumber":{"type":"string","description":"Vat number"},"name":{"type":"string","description":"Name"},"email":{"type":"string","description":"Email"},"emailCC":{"type":"string","description":"Email"},"address":{"type":"string","description":"Tax address"},"zipCode":{"type":"string","description":"Tax zip code"},"town":{"type":"string","description":"Tax town"},"provinceCode":{"type":"string","description":"Tax province code"},"provinceName":{"type":"string","description":"Tax province name"},"countryCode":{"type":"string","description":"Tax country code"},"addressDetails":{"type":"string","description":"Tax address details"},"operationTypeCode":{"type":"string","description":"Purchase operation type code"},"isTaxIncluded":{"type":"boolean","description":"Is tax included in the order"},"isTaxBaseAffected":{"type":"boolean","description":"Is tax base affected in the order"},"promptPaymentPercentage":{"maximum":100,"minimum":0,"type":"number","description":"Prompt payment percentage","format":"double"},"financialSurchargePercentage":{"maximum":100,"minimum":0,"type":"number","description":"Financial surcharge percentage","format":"double"},"annotations":{"type":"string","description":"Annotations"},"taxBase":{"type":"number","description":"Order tax base. Read only.","format":"double"},"totalTax":{"type":"number","description":"Order total tax. Read only.","format":"double"},"total":{"type":"number","description":"Order total. Read only.","format":"double"},"source":{"type":"string","description":"Entity source."},"sourceId":{"type":"string","description":"Source entity identifier."},"version":{"type":"string","description":"Document version. Read only"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/PurchaseOrderLineDTO"},"description":"Lines"},"customProperties":{"type":"array","items":{"$ref":"#/components/schemas/CustomPropertyDTO"},"description":"List of custom properties"},"situation":{"type":"string","description":"Situation. Read only"},"totalPromptPayment":{"type":"number","description":"Total prompt payment","format":"double"},"totalFinancialSurcharge":{"type":"number","description":"Total financial surcharge","format":"double"},"purchaseCurrency":{"type":"string","description":"Purchase currency. Read only"},"taxRetentionPercentage":{"maximum":100,"minimum":0,"type":"number","description":"tax retention percentage","format":"double"},"taxRetentionBase":{"type":"number","description":"Tax retention base","format":"double"},"totalRetention":{"type":"number","description":"Order total retention. Read only","format":"double"},"warehouseCorrelationId":{"type":"string","description":"Warehouse CorrelationId","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"rateId":{"type":"string","description":"nullable: true\r\nPurchase Rate Identifier. Non-mandatory field. Required when Purchase Rates functionality is enabled in the company.","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"discountId":{"type":"string","description":"Purchase Discount identifier. Null = No discount applied. Other values = An existing discount of the company.","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}},"PurchaseOrderLineDTO":{"type":"object","properties":{"id":{"type":"string","description":"Id"},"description":{"type":"string","description":"Description"},"units":{"type":"number","description":"Units. Default value is 1.","format":"double"},"servedUnits":{"type":"number","description":"Served units. Read only","format":"double"},"cancelledUnits":{"type":"number","description":"Cancelled units. Read only","format":"double"},"price":{"type":"number","description":"Price. Default value is 0.","format":"double"},"discountRate1":{"maximum":100,"minimum":0,"type":"number","description":"Discount rate. Default value is the client discount.","format":"double"},"productId":{"type":"string","description":"Id Product. Default value is null"},"productCode":{"type":"string","description":"Product code. Only for display purposes. Read only."},"taxTypeCode":{"type":"string","description":"Tax type code"},"taxRate":{"type":"number","description":"Tax rate. Read only","format":"double"},"taxSurchargeRate":{"type":"number","description":"Tax surcharge","format":"double"},"isExpense":{"type":"boolean","description":"Expenses paid on behalf of the client?"},"taxBase":{"type":"number","description":"Tax base. Read only.","format":"double"},"annotations":{"type":"string","description":"Annotations"},"expenseTypeId":{"type":"string","description":"Id Expense type. Default value is null"},"customProperties":{"type":"array","items":{"$ref":"#/components/schemas/CustomPropertyDTO"},"description":"List of custom properties"},"situation":{"type":"string","description":"Situation. Read only\r\nA = Active\r\nS = Served"},"sourceDocument":{"$ref":"#/components/schemas/DocumentLineInfoDTO"},"warehouseCorrelationId":{"type":"string","description":"Warehouse CorrelationId","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"priceOrigin":{"type":"string","description":"Price origin: None, Rate, Product, Manual"},"discountOrigin":{"type":"string","description":"Discount origin: None, Discount, Supplier, Manual"},"supplierProductReferenceCode":{"type":"string","description":"Supplier's product reference code associated with the line. Read only."},"supplierProductReferenceDescription":{"type":"string","description":"Description of the supplier's product reference associated with the line. Read only."}},"description":"Purchase order line"},"FlatPurchaseOrderDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"number":{"type":"string","description":"Number"},"date":{"type":"string","description":"Date","format":"date-time"},"deliveryDate":{"type":"string","description":"Delivery Date.","format":"date-time"},"reference":{"type":"string","description":"Reference"},"supplierVATNumber":{"type":"string","description":"Supplier VATNumber."},"supplierName":{"type":"string","description":"Supplier name"},"email":{"type":"string","description":"Document email"},"taxBase":{"type":"number","description":"Tax base","format":"double"},"taxTotal":{"type":"number","description":"Tax total","format":"double"},"total":{"type":"number","description":"Total","format":"double"},"currency":{"type":"string","description":"Currency"},"purchaseOperationTypeCode":{"type":"string","description":"Purchase operation type code"},"purchaseOperationTypeDescription":{"type":"string","description":"Purchase operation type description"},"situation":{"type":"string","description":"Situation\r\nActive = \"A\"\r\nPartially Served = \"P\"\r\nServed = \"S\""},"source":{"type":"string","description":"Source"},"sourceId":{"type":"string","description":"Source identifier"},"activityId":{"type":"string","description":"Activity identifier"},"activityDescription":{"type":"string","description":"Activity description"}}},"ReportRequest":{"type":"object","properties":{"template":{"type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/ReportParameter"}}}},"ReportParameter":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"object"}}},"MigrationMonitoringDto":{"type":"object","properties":{"description":{"type":"string","description":""},"current":{"type":"string","description":""},"total":{"type":"string","description":""},"state":{"type":"integer","description":"","format":"int32"}}},"RateDTO":{"required":["code","description"],"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"code":{"type":"string","description":"Code"},"description":{"type":"string","description":"Description"}},"description":"FeeDTO"},"AntifraudLawFootPrintDTO":{"type":"object","properties":{"identifier":{"type":"string","description":"Identifier"},"qrImage":{"type":"array","description":"QRImage"},"qrCode":{"type":"string","description":"QRCode"}},"description":"AntifraudLawFootPrint"},"AntifraudLawInvoiceLogDTO":{"type":"object","properties":{"id":{"type":"string"},"operationDescription":{"type":"string"},"logDate":{"type":"string","format":"date-time"},"invoiceDate":{"type":"string","format":"date-time"},"invoiceNumber":{"type":"string"},"customerName":{"type":"string"},"invoiceAmount":{"type":"number","format":"double"},"logStatus":{"type":"integer","format":"int32"},"logStatusDescription":{"type":"string"},"invoiceType":{"type":"integer","format":"int32"},"sentDate":{"type":"string","format":"date-time"},"eInvoiceLogAnomalies":{"type":"array","items":{"$ref":"#/components/schemas/EInvoiceLogAnomalyDTO"}},"customerVATCode":{"type":"string"},"aeatResponseCode":{"type":"string"},"aeatResponseDescription":{"type":"string"}}},"EInvoiceLogAnomalyDTO":{"type":"object","properties":{"correlationId":{"type":"string"},"anomalyDate":{"type":"string","format":"date-time"},"anomaliesEventType":{"type":"integer","format":"int32"},"description":{"type":"string"},"eInvoiceLogId":{"type":"integer","format":"int32"}}},"RegularizationDTO":{"type":"object","properties":{"id":{"type":"string","description":"Id"},"productId":{"type":"string","description":"Product id"},"units":{"type":"number","description":"Units","format":"double"},"date":{"type":"string","description":"Date","format":"date-time"},"reason":{"type":"string","description":"Reason"},"annotations":{"type":"string","description":"Annotations"}},"description":"Regularization"},"RemittanceDTO":{"required":["dues"],"type":"object","properties":{"id":{"type":"string","description":"Identifier."},"number":{"type":"string","description":"Number."},"bankId":{"type":"string","description":"Bank Identifier."},"bankName":{"type":"string","description":"BankName."},"date":{"type":"string","description":"Data","format":"date-time"},"situation":{"type":"integer","description":"Situation.     \r\nCharged = 1\r\nPartiallyCharged  = 2\r\nPending = 3\r\nChargeTotal = 4","format":"int32"},"amount":{"type":"number","description":"Amount","format":"double"},"chargedAmount":{"type":"number","description":"ChargedAmount","format":"double"},"chargeDate":{"type":"string","description":"ChargeDate.","format":"date-time"},"mandateType":{"type":"string","description":"MandateType"},"isMediaGenerated":{"type":"boolean","description":"IsMediaGenerated."},"annotations":{"type":"string","description":"Annotations."},"isFullyPaidAtOnce":{"type":"boolean","description":"IsFullyPaidAtOnce."},"maxAmount":{"type":"number","description":"MaxAmount.","format":"double"},"hasMaxAmount":{"type":"boolean","description":"HasMaxAmount."},"currency":{"type":"string","description":"Currency."},"dues":{"type":"array","items":{"$ref":"#/components/schemas/DueDTO"},"description":"Dues."},"activityId":{"type":"string","description":"Activity Id"},"isMigrated":{"type":"boolean","description":"IsMigrated. Read only."},"journala3InnuvaId":{"type":"string","description":"Return Journala3InnuvaId. Read only."}}},"FlatRemittanceDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier."},"bankId":{"type":"string","description":"Bank Identifier."},"date":{"type":"string","description":"Data","format":"date-time"},"mandateType":{"type":"string","description":"MandateType"},"amount":{"type":"number","description":"Amount","format":"double"},"chargeAmount":{"type":"number","description":"ChargeAmount.","format":"double"},"chargeDate":{"type":"string","description":"ChargeDate.","format":"date-time"},"number":{"type":"string","description":"Number."},"annotations":{"type":"string","description":"Annotations."},"situation":{"type":"integer","description":"Situation.     \r\nCharged = 1\r\nPartiallyCharged  = 2\r\nPending = 3\r\nChargeTotal = 4","format":"int32"},"isFullyPaidAtOnce":{"type":"boolean","description":"IsFullyPaidAtOnce."},"currency":{"type":"string","description":"Currency."},"bankName":{"type":"string","description":"BankAgencyName."},"isMediaGenerated":{"type":"boolean","description":"IsMediaGenerated."},"isPaid":{"type":"boolean"},"chargedDues":{"type":"integer","format":"int32"},"returnedDues":{"type":"integer","format":"int32"},"activityId":{"type":"string","description":"Activity Id","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"isMigrated":{"type":"boolean","description":"IsMigrated. Read only."},"journala3InnuvaId":{"type":"string","description":"Journal a3InnuvaId. Read only."}}},"RemittanceUpdateDTO":{"required":["duesIds"],"type":"object","properties":{"id":{"type":"string","description":"Identifier."},"annotations":{"type":"string","description":"Annotations."},"duesIds":{"type":"array","items":{"type":"string"},"description":"Dues."}}},"RemittanceNewDTO":{"required":["duesIds"],"type":"object","properties":{"id":{"type":"string","description":"Identifier."},"bankId":{"type":"string","description":"Bank Identifier."},"date":{"type":"string","description":"Data","format":"date-time"},"mandateType":{"type":"string","description":"MandateType"},"annotations":{"type":"string","description":"Annotations."},"maxAmount":{"type":"number","description":"MaxAmount.","format":"double"},"hasMaxAmount":{"type":"boolean","description":"HasMaxAmount."},"duesIds":{"type":"array","items":{"type":"string"},"description":"Dues."},"activityId":{"type":"string"}}},"SepaCommand":{"required":["preparationDate","chargeDate","useChargeDate"],"type":"object","properties":{"preparationDate":{"type":"string","description":"Preparation date","format":"date-time"},"chargeDate":{"type":"string","description":"Charge date","format":"date-time"},"useChargeDate":{"type":"boolean","description":"Use charge date"}}},"ChargeRemittanceCommand":{"type":"object","properties":{"effectiveDate":{"type":"string","description":"Effective date","format":"date-time"}}},"ChargeDuesRemittanceCommand":{"type":"object","properties":{"effectiveDate":{"type":"string","description":"Effective date","format":"date-time"},"duesIds":{"type":"array","items":{"type":"string"},"description":"Dues IDs"}}},"ReturnDuesRemittanceCommand":{"type":"object","properties":{"date":{"type":"string","description":"Return date","format":"date-time"},"duesIds":{"type":"array","items":{"type":"string"},"description":"Dues IDs"}}},"CancelChargeDuesRemittanceCommand":{"type":"object","properties":{"dues":{"type":"array","items":{"type":"string"},"description":"Cash date"}}},"CancelReturnDuesRemittanceCommand":{"type":"object","properties":{"duesId":{"type":"array","items":{"type":"string"},"description":"Dues Id"}}},"RepresentativeDTO":{"required":["name","commissionPercentage"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"Name"},"mail":{"type":"string","description":"Mail"},"phone":{"type":"string","description":"Phone"},"commissionPercentage":{"maximum":100,"minimum":0,"type":"number","description":"CommissionPercentage","format":"double"},"applyOver":{"type":"integer","description":"Apply over. Read only.\r\nPrice = 1,\r\nMargin = 2,","format":"int32"},"commissionWhen":{"type":"integer","description":"Comission when. Read only.\r\nInvoiced = 1,\r\nCharged = 2,","format":"int32"},"annotations":{"type":"string","description":"Anotations"}}},"ComissionsReportCommand":{"required":["startDate","endDate"],"type":"object","properties":{"representativeId":{"type":"string","description":"Representative Identifier"},"startDate":{"type":"string","description":"Start date","format":"date-time"},"endDate":{"type":"string","description":"End date","format":"date-time"}}},"ValidationValue":{"type":"object","properties":{"_type":{"type":"string","description":"Entity name. The friendly name of the owner of values to validate"},"isNew":{"type":"boolean","description":"New entity"},"values":{"type":"array","items":{"$ref":"#/components/schemas/FieldValue"},"description":"Set of values to validate"}},"description":"Represents a set of values to validate"},"FieldValue":{"type":"object","properties":{"path":{"type":"string","description":"Property name"},"value":{"type":"object","description":"Property value"}},"description":"Represents a property value"},"SaleDeliveryNoteDTO":{"required":["lines"],"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"date":{"type":"string","description":"Date. If null, system date is used.","format":"date-time"},"receptionDate":{"type":"string","description":"Reception date. If null, system date is used.","format":"date-time"},"customerId":{"type":"string","description":"Customer identifier. The identifier of an existing Customer."},"activityId":{"type":"string","description":"Activity identifier. Null = Default activity selected in options. Other values = An existing activity of the company."},"serieId":{"type":"string","description":"Serie identifier. Null = Default serie selected in options. Other values = An existing serie of the company."},"number":{"type":"integer","description":"Number","format":"int64"},"documentNumber":{"type":"string","description":"DocumentNumber. Read only."},"reference":{"type":"string","description":"Reference"},"paymentMethodId":{"type":"string","description":"Payment Method identifier. Null = Default payment method selected in customer. Other values = An existing payment method of the company."},"paymentTypeId":{"type":"string","description":"Payment Type identifier. Null= Default payment type selected in customer. Other values = An existing payment type of the company."},"vatNumber":{"type":"string","description":"Vat number"},"name":{"type":"string","description":"Name"},"email":{"type":"string","description":"Email"},"emailCC":{"type":"string","description":"Email"},"address":{"type":"string","description":"Tax address"},"zipCode":{"type":"string","description":"Tax zip code"},"town":{"type":"string","description":"Tax town"},"provinceCode":{"type":"string","description":"Tax province code"},"provinceName":{"type":"string","description":"Tax province name"},"countryCode":{"type":"string","description":"Tax country code"},"addressDetails":{"type":"string","description":"Tax address details"},"operationTypeCode":{"type":"string","description":"Sale operation type code"},"isTaxIncluded":{"type":"boolean","description":"Is tax included in the order"},"rateId":{"type":"string","description":"Sale rate identifier. Null = Default sale rate selected in customer. Other values = An existing sale rate of the company."},"isTaxBaseAffected":{"type":"boolean","description":"Is tax base affected in the order"},"promptPaymentPercentage":{"maximum":100,"minimum":0,"type":"number","description":"Prompt payment percentage","format":"double"},"financialSurchargePercentage":{"maximum":100,"minimum":0,"type":"number","description":"Financial surcharge percentage","format":"double"},"annotations":{"type":"string","description":"Annotations"},"taxBase":{"type":"number","description":"Delivery note tax base. Read only.","format":"double"},"totalTax":{"type":"number","description":"Delivery note total tax. Read only.","format":"double"},"total":{"type":"number","description":"Delivery note total. Read only.","format":"double"},"source":{"type":"string","description":"Entity source."},"sourceId":{"type":"string","description":"Source entity identifier."},"version":{"type":"string","description":"Document version. Read only"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/SaleDeliveryNoteLineDto"},"description":"Lines"},"customProperties":{"type":"array","items":{"$ref":"#/components/schemas/CustomPropertyDTO"},"description":"List of custom properties"},"billable":{"type":"boolean","description":"Billable"},"situation":{"type":"string","description":"Situation. Read only"},"totalPromptPayment":{"type":"number","description":"Total prompt payment","format":"double"},"totalFinancialSurcharge":{"type":"number","description":"Total financial surcharge","format":"double"},"saleCurrency":{"type":"string","description":"Sale currency. Read only"},"taxRetentionPercentage":{"maximum":100,"minimum":0,"type":"number","description":"Tax retention percentage","format":"double"},"taxRetentionBase":{"type":"number","description":"Tax retention base","format":"double"},"totalRetention":{"type":"number","description":"Delivery note total retention. Read only","format":"double"},"processId":{"type":"string"},"deliveryAddressId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"carrierId":{"type":"string","description":"Carrier Id","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"phone":{"type":"string"},"warehouseCorrelationId":{"type":"string","description":"Warehouse CorrelationId","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"discountId":{"type":"string","description":"Sale Discount identifier. Null = No discount applied. Other values = An existing discount of the company.","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}},"SaleDeliveryNoteLineDto":{"type":"object","properties":{"id":{"type":"string","description":"Id"},"description":{"type":"string","description":"Description"},"units":{"type":"number","description":"Units. Default value is 1.","format":"double"},"packages":{"pattern":"^-?(0|[1-9]\\d*)$","type":"number","description":"UnitsInPackage. Default value is 0.","format":"double"},"bundles":{"pattern":"^-?(0|[1-9]\\d*)$","type":"number","description":"PackagesInBundle. Default value is 0.","format":"double"},"servedUnits":{"type":"number","description":"Served units. Read only","format":"double"},"servedPackages":{"type":"number","description":"Served Packages. Read only.","format":"double"},"cancelledPackages":{"type":"number","description":"Cancelled Packages. Read only.","format":"double"},"servedBundles":{"type":"number","description":"Served Bundles. Read only.","format":"double"},"cancelledBundles":{"type":"number","description":"Cancelled Bundles. Read only.","format":"double"},"cancelledUnits":{"type":"number","description":"Cancelled units. Read only","format":"double"},"price":{"type":"number","description":"Price. Default value is 0.","format":"double"},"discountRate1":{"maximum":100,"minimum":0,"type":"number","description":"Discount rate. Default value is the client discount.","format":"double"},"productId":{"type":"string","description":"Id Product. Default value is null"},"productCode":{"type":"string","description":"Product code. Only for display purposes. Read only."},"taxTypeCode":{"type":"string","description":"Tax type code. If it's a kit, prevails the VAT of the components. If the components have different VAT rates, prevails the one from the largest tax base"},"taxRate":{"type":"number","description":"Tax rate. Read only.","format":"double"},"taxSurchargeRate":{"type":"number","description":"Tax surcharge","format":"double"},"isExpense":{"type":"boolean","description":"Expenses paid on behalf of the client?"},"taxBase":{"type":"number","description":"Tax base. Read only.","format":"double"},"annotations":{"type":"string","description":"Annotations"},"incomeTypeId":{"type":"string","description":"Id Income type. Default value is null"},"customProperties":{"type":"array","items":{"$ref":"#/components/schemas/CustomPropertyDTO"},"description":"List of custom properties"},"situation":{"type":"string","description":"Situation. Read only\r\nA = Active\r\nS = Served"},"sourceDocument":{"$ref":"#/components/schemas/DocumentLineInfoDTO"},"warehouseCorrelationId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"componentsLine":{"type":"array","items":{"$ref":"#/components/schemas/SaleDeliveryNoteLineDto"},"description":"List of SaleDeliveryNoteLineDto with kit components"},"kitProductBehaviours":{"$ref":"#/components/schemas/KitProductBehavioursDto"},"traceabilityDetails":{"type":"array","items":{"$ref":"#/components/schemas/TraceabilityDetailDto"},"description":"This collection contains the specific traceability information for the product in the invoice line. \r\n   \r\nIt is mandatory to inform whether the product has traceability, and the sum of the quantities of these details must be equal to the number of units in the line."},"priceBy":{"type":"string","description":"Price by: Units or Tiers"},"priceOrigin":{"type":"string","description":"Price origin: None, Rate, Product, Manual"},"unitPrice":{"type":"number","description":"UnitPrice. Default value is 0\r\nProperty is read only","format":"double"},"discountOrigin":{"type":"string","description":"Price origin: None, Discount, Product, Manual"}},"description":"Sale delivery note line"},"KitProductBehavioursDto":{"type":"object","properties":{"useKitIncomeTypes":{"type":"boolean","description":"Usage behavior for income type. \r\n\r\n- False: maintains entry type of each component\r\n- True: propagates input type of kit line to each component"},"calculateComponentsUnitsByKitUnits":{"type":"boolean","description":"Behaviour for unit calculation. Default false\r\n- False: holds the units of each component\r\n- True: multiplies units of each component by kit units"},"calculateKitPrice":{"type":"boolean","description":"Behavior used to calculate price. Default false. \r\n     \r\n- False: uses sum of component prices to calculate kit line price\r\n- True: use kit line price to calculate proportional component prices. The price distribution is based on a weighted formula, giving more proportional weight to the component whose gross base (price multiplied by units) is higher, and so on with the rest of the components."},"calculateKitDiscount":{"type":"boolean","description":"Behavior used to calculate discount. Default false. \r\n      \r\n- False: calculate the kit weighted discount and set to kit discount\r\n- True: propagates kit line discount to each component discount"}},"description":"Use these behaviours to adjust properties between kit line and components lines. Application order of these behaviours will be:\r\n\r\n1. useKitIncomeTypes \r\n\r\n2. calculateComponentsUnitsByKitUnits \r\n\r\n3. calculateKitPrice \r\n\r\n4. calculateKitDiscount"},"FlatSaleDeliveryNoteDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"number":{"type":"string","description":"Number"},"date":{"type":"string","description":"Date","format":"date-time"},"receptionDate":{"type":"string","description":"Delivery Date.","format":"date-time"},"reference":{"type":"string","description":"Reference"},"customerVATNumber":{"type":"string","description":"Customer VATNumber."},"customerName":{"type":"string","description":"Customer name"},"email":{"type":"string","description":"Document email"},"taxBase":{"type":"number","description":"Tax base","format":"double"},"taxTotal":{"type":"number","description":"Tax total","format":"double"},"total":{"type":"number","description":"Total","format":"double"},"saleCurrency":{"type":"string","description":"Sale currency"},"saleOperationTypeCode":{"type":"string","description":"Sale operation type code"},"saleOperationTypeDescription":{"type":"string","description":"Sale operation type description"},"situation":{"type":"string","description":"Situation\r\nActive = \"A\"\r\nPartially Served = \"P\"\r\nServed = \"S\""},"billable":{"type":"boolean","description":"Billable"},"source":{"type":"string","description":"Source"},"sourceId":{"type":"string","description":"Source identifier"},"activityId":{"type":"string","description":"Activity identifier"},"activityDescription":{"type":"string","description":"Activity description"},"processId":{"type":"string"},"emailCC":{"type":"string"}}},"MassiveSaleDeliveryNoteDTO":{"type":"object","properties":{"cancelRest":{"type":"boolean","description":"Cancel rest"},"saleDeliveryNoteIds":{"type":"array","items":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"description":"Sale delivery note Ids"},"documentDate":{"type":"string","description":"Document Date","format":"date-time"},"operationDate":{"type":"string","description":"Operation Date","format":"date-time"},"serie":{"type":"string","description":"Document serie","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"reference":{"type":"string","description":"Reference"},"serieCriteria":{"type":"boolean","description":"Serie grouping criteria"},"referenceCriteria":{"type":"boolean","description":"Reference grouping criteria"},"deliveryAddressCriteria":{"type":"boolean","description":"Delivery address grouping criteria"},"singleBillPerSaleDeliveryNoteCriteria":{"type":"boolean","description":"Single bill per sale delivery note grouping criteria"},"transactionDateBehavior":{"type":"integer","description":"TransactionDate billing options behavior (1 - DeliveryNote Date, 2 - Specific for all)","format":"int32"}}},"SaleInvoiceDTO":{"required":["lines"],"type":"object","properties":{"id":{"type":"string","description":"Identifier."},"date":{"type":"string","description":"Date. If null, system date is used.","format":"date-time"},"accountingDate":{"type":"string","format":"date-time"},"transactionDate":{"type":"string","format":"date-time"},"customerId":{"type":"string","description":"Customer identifier."},"activityId":{"type":"string","description":"Activity identifier. Null = Default activity selected in options. Other values = An existing activity of the company."},"serieId":{"type":"string","description":"Serie identifier. Null = Default serie selected in options. Other values = An existing serie of the company."},"number":{"type":"integer","description":"Number","format":"int64"},"documentNumber":{"type":"string","description":"DocumentNumber. Read only."},"reference":{"type":"string","description":"Reference."},"bankId":{"type":"string","description":"Bank identifier. Null = Default bank selected in customer.  Other values = An existing bank of the company."},"paymentMethodId":{"type":"string","description":"Payment Method identifier. Null = Default payment method selected in customer. Other values = An existing payment method of the company."},"paymentTypeId":{"type":"string","description":"Payment Type identifier. Null= Default payment type selected in customer. Other values = An existing payment type of the company."},"vatNumber":{"type":"string","description":"Vat number"},"vatNumberType":{"type":"integer","description":"Vat number type\r\nNone = 0,\r\nCif = 1,\r\nNif = 2,\r\nNie = 3,\r\nNifIntracom = 4,\r\nOther = 5,\r\nPassport = 6,\r\nResidenceCountryOfficialDocument = 7,\r\nTaxResidenceCertificate = 8","format":"int32"},"name":{"type":"string","description":"Name"},"email":{"type":"string","description":"Email"},"emailCC":{"type":"string","description":"Email"},"address":{"type":"string","description":"Tax address"},"zipCode":{"type":"string","description":"Tax zip code"},"town":{"type":"string","description":"Tax town"},"provinceCode":{"type":"string","description":"Tax province code"},"provinceName":{"type":"string","description":"Tax province name"},"countryCode":{"type":"string","description":"Tax country code"},"addressDetails":{"type":"string","description":"Tax address details"},"directDebitId":{"type":"string","description":"Direct debit identifier."},"operationTypeCode":{"type":"string","description":"Sale operation type code"},"invoiceType":{"type":"string","description":"Invoice type: 'B': Goods. 'S': Services. 'F': Real state. 'I': Real inversion"},"isRent":{"type":"boolean","description":"Is rent invoice"},"rateId":{"type":"string","description":"Sale rate identifier. Null = Default sale rate selected in customer. Other values = An existing sale rate of the company."},"discountId":{"type":"string","description":"Sale Discount identifier. Null = No discount applied. Other values = An existing discount of the company.","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"isTaxIncluded":{"type":"boolean","description":"Is tax included in the invoice"},"isTaxBaseAffected":{"type":"boolean","description":"Is tax base affected in the invoice"},"totalPromptPayment":{"type":"number","description":"Total prompt payment","format":"double"},"promptPaymentPercentage":{"maximum":100,"minimum":0,"type":"number","description":"Prompt payment percentage","format":"double"},"totalFinancialSurcharge":{"type":"number","description":"Total financial surcharge","format":"double"},"financialSurchargePercentage":{"maximum":100,"minimum":0,"type":"number","description":"Financial surcharge percentage","format":"double"},"taxRetentionBase":{"type":"number","description":"Tax retention base","format":"double"},"taxRetentionPercentage":{"maximum":100,"minimum":0,"type":"number","description":"tax retention percentage","format":"double"},"taxRetentionTypeCode":{"type":"string","description":"Tax retention type code."},"annotations":{"type":"string","description":"Annotations"},"taxBase":{"type":"number","description":"Invoice tax base. Read only.","format":"double"},"totalTax":{"type":"number","description":"Invoice total tax. Read only.","format":"double"},"totalRetention":{"type":"number","description":"Invoice total retention.","format":"double"},"total":{"type":"number","description":"Invoice total. Read only.","format":"double"},"saleCurrency":{"type":"string","description":"Sale currency. Read only."},"situation":{"type":"integer","description":"Situation. Read only.","format":"int32"},"source":{"type":"string","description":"Entity source."},"sourceId":{"type":"string","description":"Source entity identifier."},"representativeId":{"type":"string","description":"Representative identifier. The identifier of an existing Representative."},"representativeName":{"type":"string","description":"Representative name. The name of an existing Representative. Read only."},"version":{"type":"string","description":"Document version. Read only."},"isRectificative":{"type":"boolean","description":"Is rectificative. Read only."},"rectificationType":{"type":"integer","description":"Rectification type.","format":"int32"},"rectifiedId":{"type":"string","description":"rectified id. Read only."},"rectifiedDate":{"type":"string","description":"rectified date. Read only.","format":"date-time"},"rectifiedNumber":{"type":"string","description":"rectified number. Read only."},"isRectified":{"type":"boolean","description":"Is rectified. Read only."},"rectificativeId":{"type":"string","description":"rectificative id. Read only."},"rectificativeDate":{"type":"string","description":"rectificative date. Read only.","format":"date-time"},"rectificativeNumber":{"type":"string","description":"rectificative number. Read only."},"siiData":{"$ref":"#/components/schemas/SaleInvoiceSiiDataDto"},"faceData":{"$ref":"#/components/schemas/SaleInvoiceFaceDataDto"},"guaranteeRetentionData":{"$ref":"#/components/schemas/SaleInvoiceGuaranteeRetentionDataDto"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/SaleInvoiceLineDTO"},"description":"Lines."},"customProperties":{"type":"array","items":{"$ref":"#/components/schemas/CustomPropertyDTO"},"description":"List of custom properties"},"chargedAmounts":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceChargeDTO"},"description":"Charges to apply when de invoice is created"},"ticketBai":{"$ref":"#/components/schemas/TBAIFootPrintDTO"},"isAntiFraudRegistered":{"type":"boolean","description":"IsAntiFraudRegistered. Read only."},"warehouseCorrelationId":{"type":"string","description":"Warehouse CorrelationId","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"isMigrated":{"type":"boolean","description":"IsMigrated. Read only."},"extendedInformation":{"$ref":"#/components/schemas/SaleInvoiceExtendedInfoDTO"},"qrUrl":{"type":"string"},"logDateUtc":{"type":"string","format":"date-time"}}},"SaleInvoiceSiiDataDto":{"type":"object","properties":{"id":{"type":"string","description":"Identifier."},"invoiceDescription":{"type":"string","description":"Invoice Description"},"customerNifNoCensado":{"type":"boolean","description":"Customer Nif no censado"},"numberInitialInvoice":{"type":"string"},"numberFinalInvoice":{"type":"string","description":"Number initial invoice"},"invoiceSpecialRegime":{"type":"boolean","description":"Is invoice in special regime?"},"taxBaseAtCost":{"type":"number","description":"Tax base at cost","format":"double"},"invoiceEmittedByThirdParty":{"type":"boolean","description":"Is mitted by a third party?"},"manyRecipients":{"type":"boolean","description":"Has many recipients"},"bonusesOrDiscounts":{"type":"boolean","description":"Has bonuses or discounts?"},"a3InnuvaId":{"type":"string","description":"A3InnuvaId","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"regimeCode":{"type":"string","description":"Regime type"},"documentTypeCode":{"type":"string","description":"Document type"}}},"SaleInvoiceFaceDataDto":{"type":"object","properties":{"id":{"type":"string","description":"Identifier."},"accountingOfficeCode":{"type":"string","description":"Accounting Office Code"},"accountingOffice":{"type":"string","description":"Accounting Office"},"organManagingCode":{"type":"string","description":"Organ Managing Code"},"organManaging":{"type":"string","description":"Organ Managing"},"processingUnitCode":{"type":"string","description":"Processing Unit Code"},"processingUnit":{"type":"string","description":"Processing Unit"},"proposingOrganCode":{"type":"string","description":"Proposing Organ Code"},"proposingOrgan":{"type":"string","description":"Proposing Organ"},"fileReference":{"type":"string","description":"File Reference"}}},"SaleInvoiceGuaranteeRetentionDataDto":{"type":"object","properties":{"id":{"type":"string","description":"Identificador."},"hasGuaranteeRetention":{"type":"boolean","description":"Indica si aplica la retención por garantía de obra."},"workDelivery":{"type":"integer","description":"Tipo de entrega de la obra (p. ej., entregada, no entregada).","format":"int32"},"reference":{"type":"string","description":"Referencia opcional relacionada con la retención."},"amount":{"type":"number","description":"Importe total sujeto a retención.","format":"double"},"appliesVAT":{"type":"boolean","description":"Indica si la retención aplica IVA."},"retentionBase":{"type":"number","description":"Base utilizada para calcular la retención.","format":"double"},"retentionPercentage":{"type":"number","description":"Porcentaje de la retención.","format":"double"},"retentionAmount":{"type":"number","description":"Importe calculado de la retención.","format":"double"},"amountState":{"type":"boolean","description":"Indica si el importe total se calcula automáticamente."},"retentionBaseState":{"type":"boolean","description":"Indica si la base de retención se calcula automáticamente."},"retentionAmountState":{"type":"boolean","description":"Indica si el importe de la retención se calcula automáticamente."}},"description":"Representa los detalles de la retención por garantía en una factura de venta."},"SaleInvoiceLineDTO":{"type":"object","properties":{"id":{"type":"string","description":"Id"},"description":{"type":"string","description":"Description"},"units":{"type":"number","description":"Units. Default value is 1","format":"double"},"packages":{"pattern":"^-?(0|[1-9]\\d*)$","type":"number","description":"Packages. Default value is 0","format":"double"},"bundles":{"pattern":"^-?(0|[1-9]\\d*)$","type":"number","description":"Bundles. Default value is 0","format":"double"},"price":{"type":"number","description":"Price. Default value is 0","format":"double"},"discountRate1":{"maximum":100,"minimum":0,"type":"number","description":"Discount rate. Default value is the client discount","format":"double"},"productId":{"type":"string","description":"Id Product. Default value is null"},"productCode":{"type":"string","description":"Product code. Only for display purposes. Read only"},"incomeTypeId":{"type":"string","description":"Id Income type. Default value is null"},"taxTypeCode":{"type":"string","description":"Tax type code. If it's a kit, prevails the VAT of the components. If the components have different VAT rates, prevails the one from the largest tax base"},"taxRate":{"type":"number","description":"Tax rate. Read only","format":"double"},"taxSurchargeRate":{"type":"number","description":"Tax surcharge","format":"double"},"isExpense":{"type":"boolean","description":"Expenses paid on behalf of the client?"},"taxBase":{"type":"number","description":"Tax base. Read only","format":"double"},"sourceDocument":{"$ref":"#/components/schemas/DocumentLineInfoDTO"},"annotations":{"type":"string","description":"Annotations"},"affectStock":{"type":"boolean","description":"Line affects stock. Read only"},"commissionPercentage":{"type":"number","description":"Commission representative percentage","format":"double"},"idFeePeriodLog":{"type":"string","description":"Fee period log Id. Read only"},"confidentiality":{"type":"boolean","description":"Confidentiality. Default false. Read only, not applies if is kit"},"customProperties":{"type":"array","items":{"$ref":"#/components/schemas/CustomPropertyDTO"},"description":"List of custom properties"},"warehouseCorrelationId":{"type":"string","description":"Warehouse CorrelationId","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"traceabilityDetails":{"type":"array","items":{"$ref":"#/components/schemas/TraceabilityDetailDto"},"description":"This collection contains the specific traceability information for the product in the invoice line. \r\n   \r\nIt is mandatory to inform whether the product has traceability, and the sum of the quantities of these details must be equal to the number of units in the line."},"componentsLine":{"type":"array","items":{"$ref":"#/components/schemas/SaleInvoiceLineDTO"},"description":"List of SaleInvoiceLineDTOs with kit components"},"kitProductBehaviours":{"$ref":"#/components/schemas/KitProductBehavioursDto"},"priceBy":{"type":"string","description":"Price by: Units or Tiers"},"priceOrigin":{"type":"string","description":"Price origin: None, Rate, Product, Manual"},"unitPrice":{"type":"number","description":"UnitPrice. Default value is 0\r\nProperty is read only","format":"double"},"rectifiedId":{"type":"string","description":"RectifiedCorrelationId"},"discountOrigin":{"type":"string","description":"Discount origin: Discount, Manual, Fee, None, Customer, Supplie"}}},"InvoiceChargeDTO":{"type":"object","properties":{"amount":{"type":"number","format":"double"},"paymentTypeId":{"type":"string"},"bankId":{"type":"string"}}},"TBAIFootPrintDTO":{"type":"object","properties":{"identifier":{"type":"string","description":"Identifier"},"qrImage":{"type":"array","description":"QRImage"},"qrCode":{"type":"string","description":"QRCode"}},"description":"TBAIFootPrint"},"SaleInvoiceExtendedInfoDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Id of Extended Info","format":"int32"},"tenantId":{"type":"string","description":"Id of tenant"},"antiFraudeLogStatus":{"type":"integer","description":"status of the request to AEAT\r\nPendingToSend = 1,\r\nReceivedOk = 2,\r\nRejected = 3,\r\nReceivedWithWarnings = 4,\r\nError = 5,\r\nDontApply = 6,\r\nRegistered = 7,\r\nUnknown = 99","format":"int32"},"ticketBAILogStatus":{"type":"integer","description":"status of the request to TicketBAI\r\nPendingToSend = 1,\r\nReceivedOk = 2,\r\nRejected = 3,\r\nReceivedWithWarnings = 4,\r\nError = 5","format":"int32"},"aeatResponseDescription":{"type":"string","description":"Description of the response to AEAT"},"aeatResponseCode":{"type":"string","description":"Code of the response to AEAT"},"invoiceSent":{"type":"string","description":"Date of the request to AEAT","format":"date-time"},"sifNotApplyReason":{"type":"integer","description":"Reason to not apply status\r\nBelongSii = 1,\r\nBelongTicketBai = 2,\r\nExempt = 3,\r\nGeneratedByOtherSIF = 4 ,\r\nNavarra = 5,\r\nFueraDeEspanya = 6,\r\nOther = 7\r\nFueraAmbitoSubjetivoArticulo31 = 8","format":"int32"},"sifNotApplyDescriptionMessages":{"type":"string","description":"Description to not apply status"},"logDate":{"type":"string","description":"Date of log saved","format":"date-time"},"subsanacionRejected":{"type":"boolean","description":"indicates that it is a rejection of a correction(=true)."},"rectifiedDate":{"type":"string","description":"Gets or sets the rectified date associated with the current operation or entity.","format":"date-time"},"rectifiedDocumentNumber":{"type":"string","description":"Gets or sets the rectified document number associated with the current operation."},"rectifiedIssuer":{"type":"string","description":"Gets or sets the rectified issuer value."}}},"EditableInfoElectronicInvoiceLinesDTO":{"type":"object","properties":{"product":{"type":"boolean"},"units":{"type":"boolean"},"price":{"type":"boolean"},"taxType":{"type":"boolean"},"discount":{"type":"boolean"},"warehouse":{"type":"boolean"}}},"EditableInfoElectronicInvoiceHeaderDTO":{"type":"object","properties":{"nif":{"type":"boolean"},"name":{"type":"boolean"},"country":{"type":"boolean"},"selectExistingCustomer":{"type":"boolean"},"invoiceDate":{"type":"boolean"},"transactionDate":{"type":"boolean"},"serie":{"type":"boolean"},"activity":{"type":"boolean"},"invoiceNumber":{"type":"boolean"},"transactionType":{"type":"boolean"},"invoiceType":{"type":"boolean"},"taxIncluded":{"type":"boolean"},"rate":{"type":"boolean"},"baseAffect":{"type":"boolean"},"condition":{"type":"boolean"},"promptPayment":{"type":"boolean"},"financialSurchage":{"type":"boolean"},"retentionBase":{"type":"boolean"},"retention":{"type":"boolean"},"discount":{"type":"boolean"}}},"SentDocumentStatusDTO":{"type":"object","properties":{"eMail":{"type":"string"},"sentDate":{"type":"string","format":"date-time"},"downloadedDate":{"type":"string","format":"date-time"}}},"FlatSaleInvoiceDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"number":{"type":"string","description":"Number"},"date":{"type":"string","description":"Date","format":"date-time"},"accountingDate":{"type":"string","format":"date-time"},"transactionDate":{"type":"string","format":"date-time"},"reference":{"type":"string","description":"Reference"},"customerId":{"type":"string","description":"Customer CustomerId."},"customerVATNumber":{"type":"string","description":"Customer VATNumber."},"customerName":{"type":"string","description":"Customer name"},"email":{"type":"string","description":"Document email"},"taxBase":{"type":"number","description":"Tax base","format":"double"},"totalTax":{"type":"number","description":"Tax total","format":"double"},"total":{"type":"number","description":"Total","format":"double"},"saleCurrency":{"type":"string","description":"Sale currency"},"saleOperationTypeCode":{"type":"string","description":"Sale operation type code"},"saleOperationTypeDescription":{"type":"string","description":"Sale operation type description"},"invoiceType":{"type":"string","description":"Invoice type"},"situation":{"type":"integer","description":"Situation","format":"int32"},"isRectificative":{"type":"boolean","description":"Is rectificative"},"rectificationType":{"type":"integer","description":"Is rectificative","format":"int32"},"rectifiedId":{"type":"string","description":"rectified id"},"rectifiedDate":{"type":"string","description":"rectified date","format":"date-time"},"rectifiedNumber":{"type":"string","description":"rectified number"},"isRectified":{"type":"boolean","description":"Is rectified"},"rectificativeId":{"type":"string","description":"rectificative id"},"rectificativeDate":{"type":"string","description":"rectificative date","format":"date-time"},"rectificativeNumber":{"type":"string","description":"rectificative number"},"antiFraudeLogStatus":{"type":"integer","description":"Log status","format":"int32"},"aeatResponseCode":{"type":"string"},"aeatResponseDescription":{"type":"string"},"invoiceSent":{"type":"string","format":"date-time"},"sifNotApplyReason":{"type":"integer","description":"Reason to not apply status\r\nBelongSii = 1,\r\nBelongTicketBai = 2,\r\nExempt = 3,\r\nGeneratedByOtherSIF = 4 ,\r\nNavarra = 5,\r\nFueraDeEspanya = 6,\r\nOther = 7\r\nFueraAmbitoSubjetivoArticulo31 = 8","format":"int32"},"sifNotApplyDescriptionMessages":{"type":"string","description":"Description to not apply status"},"ticketBAILogStatus":{"type":"integer","description":"status of the request to TicketBAI\r\nPendingToSend = 1,\r\nReceivedOk = 2,\r\nRejected = 3,\r\nReceivedWithWarnings = 4,\r\nError = 5","format":"int32"},"ticketBAILogStatusDescription":{"type":"string","description":"Log status description"},"source":{"type":"string","description":"Source"},"sourceId":{"type":"string","description":"Source identifier"},"activityId":{"type":"string","description":"Activity identifier"},"activityDescription":{"type":"string","description":"Activity description"},"isMigrated":{"type":"boolean","description":"IsMigrated. Read only."},"logDate":{"type":"string","description":"Date of log saved","format":"date-time"}}},"PortfolioSaleInvoiceDTO":{"type":"object","properties":{"chargeDTOs":{"type":"array","items":{"$ref":"#/components/schemas/ChargeDTO"}}}},"SendCommand":{"type":"object","properties":{"templateId":{"type":"string","description":"Template Identifier"},"searchBy":{"type":"string","description":"SearchBy"},"filter":{"type":"string","description":"Filter"},"selectedIds":{"type":"array","items":{"type":"string"},"description":"List of selected invoices"},"excludedIds":{"type":"array","items":{"type":"string"},"description":"List of excluded invoices"},"state":{"type":"integer","description":"State: \r\nIndeterminate = 0,\r\nChecked = 1,\r\nUnchecked = 2","format":"int32"}}},"ChargeCommand":{"type":"object","properties":{"date":{"type":"string","description":"Cash date","format":"date-time"},"ammount":{"type":"number","description":"Amount","format":"double"},"bankId":{"type":"string","description":"Charge due bank"},"paymentDocumentId":{"type":"string","description":"Payment document id"},"directDebitId":{"type":"string","description":"Direct debit id"}}},"ReturnCommand":{"type":"object","properties":{"date":{"type":"string","description":"Return due date","format":"date-time"},"ammount":{"type":"number","description":"Return due amount","format":"double"},"paymentDocumentId":{"type":"string","description":"Payment document id"}}},"SaleOfferDTO":{"required":["lines"],"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"date":{"type":"string","description":"Date. If null, system date is used.","format":"date-time"},"expirationDate":{"type":"string","description":"Expiration date. If null, system date is used.","format":"date-time"},"state":{"type":"string","description":"States:\r\nAccepted = \"AC\"\r\nPending  = \"PA\"\r\nRejected = \"RE\""},"customerId":{"type":"string","description":"Customer identifier."},"activityId":{"type":"string","description":"Activity identifier. Null = Default activity selected in options. Other values = An existing activity of the company."},"serieId":{"type":"string","description":"Serie identifier. Null = Default serie selected in options. Other values = An existing serie of the company."},"number":{"type":"integer","description":"Number","format":"int64"},"documentNumber":{"type":"string","description":"DocumentNumber. Read only."},"reference":{"type":"string","description":"Reference"},"paymentMethodId":{"type":"string","description":"Payment Method identifier. Null = Default payment method selected in customer. Other values = An existing payment method of the company."},"paymentTypeId":{"type":"string","description":"Payment Type identifier. Null= Default payment type selected in customer. Other values = An existing payment type of the company."},"vatNumber":{"type":"string","description":"Vat number"},"name":{"type":"string","description":"Name"},"email":{"type":"string","description":"Email"},"emailCC":{"type":"string","description":"Email"},"address":{"type":"string","description":"Tax address"},"zipCode":{"type":"string","description":"Tax zip code"},"town":{"type":"string","description":"Tax town"},"provinceCode":{"type":"string","description":"Tax province code"},"provinceName":{"type":"string","description":"Tax province name"},"countryCode":{"type":"string","description":"Tax country code"},"addressDetails":{"type":"string","description":"Tax address details"},"operationTypeCode":{"type":"string","description":"Sale operation type code"},"isTaxIncluded":{"type":"boolean","description":"Is tax included in the offer"},"rateId":{"type":"string","description":"Sale rate identifier. Null = Default sale rate selected in customer. Other values = An existing sale rate of the company."},"isTaxBaseAffected":{"type":"boolean","description":"Is tax base affected in the offer"},"promptPaymentPercentage":{"maximum":100,"minimum":0,"type":"number","description":"Prompt payment percentage","format":"double"},"financialSurchargePercentage":{"maximum":100,"minimum":0,"type":"number","description":"Financial surcharge percentage","format":"double"},"annotations":{"type":"string","description":"Annotations"},"taxBase":{"type":"number","description":"Offer tax base. Read only.","format":"double"},"totalTax":{"type":"number","description":"Offer total tax. Read only.","format":"double"},"total":{"type":"number","description":"Offer total. Read only.","format":"double"},"source":{"type":"string","description":"Entity source."},"sourceId":{"type":"string","description":"Source entity identifier."},"version":{"type":"string","description":"Document version. Read only."},"lines":{"type":"array","items":{"$ref":"#/components/schemas/SaleOfferLineDTO"},"description":"Lines"},"customProperties":{"type":"array","items":{"$ref":"#/components/schemas/CustomPropertyDTO"},"description":"List of custom properties"},"situation":{"type":"string","description":"Situation. Read only."},"totalPromptPayment":{"type":"number","description":"Total prompt payment","format":"double"},"totalFinancialSurcharge":{"type":"number","description":"Total financial surcharge","format":"double"},"saleCurrency":{"type":"string","description":"Sale currency. Read only."},"taxRetentionPercentage":{"maximum":100,"minimum":0,"type":"number","description":"tax retention percentage","format":"double"},"taxRetentionBase":{"type":"number","description":"Tax retention base","format":"double"},"totalRetention":{"type":"number","description":"Offer total retention. Read only.","format":"double"},"representativeId":{"type":"string","description":"Representative identifier. The identifier of an existing Representative."},"representativeName":{"type":"string","description":"Representative name. The name of an existing Representative.Read only."},"discountId":{"type":"string","description":"Purchase Discount identifier. Null = No discount applied. Other values = An existing discount of the company.","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}},"description":"Sale offer"},"SaleOfferLineDTO":{"type":"object","properties":{"id":{"type":"string","description":"Id"},"description":{"type":"string","description":"Description"},"units":{"type":"number","description":"Units. Default value is 1.","format":"double"},"bundles":{"pattern":"^-?(0|[1-9]\\d*)$","type":"number","description":"Bundles. Default value is 0.","format":"double"},"packages":{"pattern":"^-?(0|[1-9]\\d*)$","type":"number","description":"Pacakages. Default value is 0.","format":"double"},"servedUnits":{"type":"number","description":"Served units. Read only.","format":"double"},"cancelledUnits":{"type":"number","description":"Cancelled units. Read only.","format":"double"},"servedPackages":{"type":"number","description":"Served Packages. Read only.","format":"double"},"cancelledPackages":{"type":"number","description":"Cancelled Packages. Read only.","format":"double"},"servedBundles":{"type":"number","description":"Served Bundles. Read only.","format":"double"},"cancelledBundles":{"type":"number","description":"Cancelled Bundles. Read only.","format":"double"},"price":{"type":"number","description":"Price. Default value is 0.","format":"double"},"discountRate1":{"maximum":100,"minimum":0,"type":"number","description":"Discount rate. Default value is the client discount.","format":"double"},"productId":{"type":"string","description":"Id Product. Default value is null"},"productCode":{"type":"string","description":"Product code. Only for display purposes. Read only."},"taxTypeCode":{"type":"string","description":"Tax type code. If it's a kit, prevails the VAT of the components. If the components have different VAT rates, prevails the one from the largest tax base"},"taxRate":{"type":"number","description":"Tax rate. Read only.","format":"double"},"taxSurchargeRate":{"type":"number","description":"Tax surcharge","format":"double"},"isExpense":{"type":"boolean","description":"Expenses paid on behalf of the client?"},"taxBase":{"type":"number","description":"Tax base. Read only.","format":"double"},"annotations":{"type":"string","description":"Annotations"},"incomeTypeId":{"type":"string","description":"Id Income type. Default value is null"},"customProperties":{"type":"array","items":{"$ref":"#/components/schemas/CustomPropertyDTO"},"description":"List of custom properties"},"situation":{"type":"string","description":"Situation. Read only.\r\nA = Active\r\nS = Served"},"warehouseCorrelationId":{"type":"string","description":"Warehouse CorrelationId","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"componentsLine":{"type":"array","items":{"$ref":"#/components/schemas/SaleOfferLineDTO"},"description":"List of SaleOfferLineDTO with the components of the kit"},"kitProductBehaviours":{"$ref":"#/components/schemas/KitProductBehavioursDto"},"priceBy":{"type":"string","description":"Price by: Units or Tiers"},"priceOrigin":{"type":"string","description":"Price origin: None, Rate, Product, Manual"},"unitPrice":{"type":"number","description":"UnitPrice. Default value is 0\r\nProperty is read only","format":"double"},"discountOrigin":{"type":"string","description":"Price origin: None, Discount, Product, Manual"}},"description":"Sale offer line"},"FlatSaleOfferDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"state":{"type":"string","description":"States:\r\nAccepted = \"AC\"\r\nPending  = \"PA\"\r\nRejected = \"RE\""},"situation":{"type":"string","description":"Situation"},"number":{"type":"string","description":"Number"},"reference":{"type":"string","description":"Reference"},"date":{"type":"string","description":"Date.","format":"date-time"},"expirationDate":{"type":"string","description":"Expiration Date.","format":"date-time"},"customerId":{"type":"string","description":"Customer CustomerId."},"customerVATNumber":{"type":"string","description":"Customer VAT Number."},"customerName":{"type":"string","description":"Customer Name."},"email":{"type":"string","description":"Document email"},"totalTax":{"type":"number","description":"Invoice total tax.","format":"double"},"taxBase":{"type":"number","description":"Offer tax base.","format":"double"},"total":{"type":"number","description":"Offer total.","format":"double"},"saleCurrency":{"type":"string","description":"Sale currency"},"saleOperationTypeCode":{"type":"string","description":"Sale operation type code"},"saleOperationTypeDescription":{"type":"string","description":"Sale operation type description"},"source":{"type":"string","description":"Source"},"sourceId":{"type":"string","description":"Source identifier"},"activityId":{"type":"string","description":"Activity identifier"},"activityDescription":{"type":"string","description":"Activity description"},"emailCC":{"type":"string"}}},"ServeDocumentCommandBill":{"type":"object","properties":{"operationDate":{"type":"string","description":"Operation date of the serve document","format":"date-time"},"date":{"type":"string","description":"Date to serve new document","format":"date-time"},"reference":{"type":"string","description":"Reference to serve new document"},"cancelRest":{"type":"boolean","description":"Cancel rest"},"sourceLines":{"type":"array","items":{"$ref":"#/components/schemas/SourceLineDTO"},"description":"List of lines to serve"},"serie":{"type":"string","description":"Document serie"}}},"StateCommand":{"required":["offerState"],"type":"object","properties":{"offerState":{"type":"string","description":"State to change in the offer \r\nAccepted = \"AC\"\r\nPending  = \"PA\"\r\nRejected = \"RE\""}}},"SaleOperationTypeDTO":{"type":"object","properties":{"code":{"type":"string","description":"Code"},"description":{"type":"string","description":"Description"},"applyTax":{"type":"boolean","description":"Is Tax applied?"},"applyEquivalenceSurcharge":{"type":"boolean","description":"Is Equivalence Surcharge applied?"}},"description":"Sale operation type"},"SaleOrderDTO":{"required":["lines"],"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"date":{"type":"string","description":"Date. If null, system date is used.","format":"date-time"},"deliveryDate":{"type":"string","description":"Delivery date. If null, system date is used.","format":"date-time"},"customerId":{"type":"string","description":"Customer identifier. The identifier of an existing Customer."},"activityId":{"type":"string","description":"Activity identifier. Null = Default activity selected in options. Other values = An existing activity of the company."},"serieId":{"type":"string","description":"Serie identifier. Null = Default serie selected in options. Other values = An existing serie of the company."},"number":{"type":"integer","description":"Number","format":"int64"},"documentNumber":{"type":"string","description":"DocumentNumber. Read only."},"reference":{"type":"string","description":"Reference"},"paymentMethodId":{"type":"string","description":"Payment Method identifier. Null = Default payment method selected in customer. Other values = An existing payment method of the company."},"paymentTypeId":{"type":"string","description":"Payment Type identifier. Null= Default payment type selected in customer. Other values = An existing payment type of the company."},"rateId":{"type":"string","description":"Rate identifier."},"vatNumber":{"type":"string","description":"Vat number"},"name":{"type":"string","description":"Name"},"email":{"type":"string","description":"Email"},"emailCC":{"type":"string","description":"Email"},"address":{"type":"string","description":"Tax address"},"zipCode":{"type":"string","description":"Tax zip code"},"town":{"type":"string","description":"Tax town"},"provinceCode":{"type":"string","description":"Tax province code"},"provinceName":{"type":"string","description":"Tax province name"},"countryCode":{"type":"string","description":"Tax country code"},"addressDetails":{"type":"string","description":"Tax address details"},"operationTypeCode":{"type":"string","description":"Sale operation type code"},"isTaxIncluded":{"type":"boolean","description":"Is tax included in the order"},"isTaxBaseAffected":{"type":"boolean","description":"Is tax base affected in the order"},"promptPaymentPercentage":{"maximum":100,"minimum":0,"type":"number","description":"Prompt payment percentage","format":"double"},"financialSurchargePercentage":{"maximum":100,"minimum":0,"type":"number","description":"Financial surcharge percentage","format":"double"},"annotations":{"type":"string","description":"Annotations"},"taxBase":{"type":"number","description":"Order tax base. Read only.","format":"double"},"totalTax":{"type":"number","description":"Order total tax. Read only.","format":"double"},"total":{"type":"number","description":"Order total. Read only.","format":"double"},"source":{"type":"string","description":"Entity source."},"sourceId":{"type":"string","description":"Source entity identifier."},"version":{"type":"string","description":"Document version. Read only"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/SaleOrderLineDTO"},"description":"Lines"},"customProperties":{"type":"array","items":{"$ref":"#/components/schemas/CustomPropertyDTO"},"description":"List of custom properties"},"situation":{"type":"string","description":"Situation. Read only"},"totalPromptPayment":{"type":"number","description":"Total prompt payment","format":"double"},"totalFinancialSurcharge":{"type":"number","description":"Total financial surcharge","format":"double"},"saleCurrency":{"type":"string","description":"Sale currency. Read only"},"taxRetentionPercentage":{"maximum":100,"minimum":0,"type":"number","description":"tax retention percentage","format":"double"},"taxRetentionBase":{"type":"number","description":"Tax retention base","format":"double"},"totalRetention":{"type":"number","description":"Order total retention. Read only","format":"double"},"deliveryAddressId":{"type":"string","description":"Delivery address identifier","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"phone":{"type":"string","description":"Document Phone"},"carrierId":{"type":"string","description":"Carrier Id","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"warehouseCorrelationId":{"type":"string","description":"Warehouse CorrelationId","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"discountId":{"type":"string","description":"Purchase Discount identifier. Null = No discount applied. Other values = An existing discount of the company.","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}},"SaleOrderLineDTO":{"type":"object","properties":{"id":{"type":"string","description":"Id"},"description":{"type":"string","description":"Description"},"units":{"type":"number","description":"Units. Default value is 1.","format":"double"},"packages":{"pattern":"^-?(0|[1-9]\\d*)$","type":"number","description":"Packages. Default value is 0.","format":"double"},"bundles":{"pattern":"^-?(0|[1-9]\\d*)$","type":"number","description":"Bundles. Default value is 0.","format":"double"},"servedUnits":{"type":"number","description":"Served units. Read only","format":"double"},"cancelledUnits":{"type":"number","description":"Cancelled units. Read only","format":"double"},"servedPackages":{"type":"number","description":"Served Packages. Read only.","format":"double"},"cancelledPackages":{"type":"number","description":"Cancelled Packages. Read only.","format":"double"},"servedBundles":{"type":"number","description":"Served Bundles. Read only.","format":"double"},"cancelledBundles":{"type":"number","description":"Cancelled Bundles. Read only.","format":"double"},"price":{"type":"number","description":"Price. Default value is 0.","format":"double"},"discountRate1":{"maximum":100,"minimum":0,"type":"number","description":"Discount rate. Default value is the client discount.","format":"double"},"productId":{"type":"string","description":"Id Product. Default value is null"},"productCode":{"type":"string","description":"Product code. Only for display purposes. Read only."},"taxTypeCode":{"type":"string","description":"Tax type code. If it's a kit, prevails the VAT of the components. If the components have different VAT rates, prevails the one from the largest tax base"},"taxRate":{"type":"number","description":"Tax rate. Read only","format":"double"},"taxSurchargeRate":{"type":"number","description":"Tax surcharge","format":"double"},"isExpense":{"type":"boolean","description":"Expenses paid on behalf of the client?"},"taxBase":{"type":"number","description":"Tax base. Read only.","format":"double"},"annotations":{"type":"string","description":"Annotations"},"incomeTypeId":{"type":"string","description":"Id Income type. Default value is null"},"customProperties":{"type":"array","items":{"$ref":"#/components/schemas/CustomPropertyDTO"},"description":"List of custom properties"},"situation":{"type":"string","description":"Situation. Read only\r\nA = Active\r\nS = Served"},"sourceDocument":{"$ref":"#/components/schemas/DocumentLineInfoDTO"},"warehouseCorrelationId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"componentsLine":{"type":"array","items":{"$ref":"#/components/schemas/SaleOrderLineDTO"},"description":"List of SaleOrderLineDTO with the components of the kit"},"kitProductBehaviours":{"$ref":"#/components/schemas/KitProductBehavioursDto"},"priceBy":{"type":"string","description":"Price by: Units or Tiers"},"priceOrigin":{"type":"string","description":"Price origin: None, Rate, Product, Manual"},"unitPrice":{"type":"number","description":"UnitPrice. Default value is 0\r\nProperty is read only","format":"double"},"discountOrigin":{"type":"string","description":"Price origin: None, Discount, Product, Manual"}},"description":"Sale order line"},"FlatSaleOrderDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"number":{"type":"string","description":"Number"},"date":{"type":"string","description":"Date","format":"date-time"},"deliveryDate":{"type":"string","description":"Delivery Date.","format":"date-time"},"reference":{"type":"string","description":"Reference"},"customerVATNumber":{"type":"string","description":"Customer VATNumber."},"customerName":{"type":"string","description":"Customer name"},"email":{"type":"string","description":"Document email"},"taxBase":{"type":"number","description":"Tax base","format":"double"},"taxTotal":{"type":"number","description":"Tax total","format":"double"},"total":{"type":"number","description":"Total","format":"double"},"saleCurrency":{"type":"string","description":"Sale currency"},"saleOperationTypeCode":{"type":"string","description":"Sale operation type code"},"saleOperationTypeDescription":{"type":"string","description":"Sale operation type description"},"situation":{"type":"string","description":"Situation\r\nActive = \"A\"\r\nPartially Served = \"P\"\r\nServed = \"S\""},"source":{"type":"string","description":"Source"},"sourceId":{"type":"string","description":"Source identifier"},"activityId":{"type":"string","description":"Activity identifier"},"activityDescription":{"type":"string","description":"Activity description"},"emailCC":{"type":"string"}}},"FlatSerieDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"code":{"type":"string","description":"Code"},"description":{"type":"string","description":"Name"},"a3InnuvaActivityId":{"type":"string","description":"A3InnuvaActivityId (Deprecated)"},"a3InnuvaActivityShortDescription":{"type":"string","description":"A3InnuvaActivityShortDescription (Deprecated)"},"isLAFTDisabled":{"type":"boolean","description":"IsLAFTDisabled (default false), false = in RSIF, true = non RSIF"},"laftDisabledConfirmation":{"type":"boolean","description":"Confirmation Disabled Antifraud, when IsLAFTDisabled is true should by true"}}},"SerieAntifraudConfigDTO":{"type":"object","properties":{"isLAFTDisabled":{"type":"boolean","description":"IsLAFTDisabled (default false), false = in RSIF, true = non RSIF"},"laftDisabledConfirmation":{"type":"boolean","description":"Confirmation Disabled Antifraud, when IsLAFTDisabled is true should by true"}}},"QueryStockCommand":{"type":"object","properties":{"stockFilter":{"type":"integer","description":"All =0,\r\nDistinct = 1,\r\nEqual = 2,\r\nGreaterOrEqual = 3,\r\nLessOrEqual = 4","format":"int32"},"stockUnits":{"type":"number","description":"Stock units","format":"double"},"warehouseCorrelationId":{"type":"string","description":"Warehouse correlationId","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"dateTo":{"type":"string","description":"DateTo to filter","format":"date-time"}}},"StockMovementCommand":{"required":["productId","startDate","endDate"],"type":"object","properties":{"productId":{"type":"string","description":"Product identifier"},"startDate":{"type":"string","description":"Start date","format":"date-time"},"endDate":{"type":"string","description":"End date","format":"date-time"},"warehouseCorrelationId":{"type":"string","description":"Warehouse correlationId","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}},"SubscriptionDTO":{"type":"object","properties":{"applicationName":{"type":"string","description":"Application Name"},"state":{"type":"integer","description":"States:\r\nCreated = 0\r\nSent = 1 \r\nSentFailure = 2\r\nConfiguring = 3\r\nActive = 4\r\nRejected = 5\r\nRejectedInProgress = 6","format":"int32"},"reason":{"type":"string","description":"Reason"},"backOfficeURL":{"type":"string","description":"BackOfficeURL"},"frontOfficeURL":{"type":"string","description":"FrontOfficeURL"},"secret":{"type":"string","description":"Secret"}}},"SubscriptionCommand":{"type":"object","properties":{"state":{"type":"integer","description":"States:     \r\nConfiguring = 3\r\nActive = 4\r\nRejected = 5\r\nRejectedInProgress = 6","format":"int32"},"reason":{"type":"string","description":"Reason"},"backOfficeURL":{"type":"string","description":"BackOfficeURL"},"frontOfficeURL":{"type":"string","description":"FrontOfficeURL"},"secret":{"type":"string","description":"Secret"}}},"SupplierDTO":{"required":["name","businessName"],"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"creationDate":{"type":"string","description":"Creation date. Read only.","format":"date-time"},"vatNumber":{"type":"string","description":"VAT number"},"vatNumberType":{"type":"integer","description":"Vat number type\r\nNone = 0,\r\nCif = 1,\r\nNif = 2,\r\nNie = 3,\r\nNifIntracom = 4,\r\nOther = 5,\r\nPassport = 6,\r\nResidenceCountryOfficialDocument = 7,\r\nTaxResidenceCertificate = 8","format":"int32"},"supplierType":{"type":"string","description":"Supplier type\r\nSupplier = \"P\"\r\nCreditor = \"A\""},"code":{"type":"string","description":"Code"},"name":{"type":"string","description":"Name"},"businessName":{"type":"string","description":"Business Name"},"web":{"type":"string","description":"Web"},"address":{"$ref":"#/components/schemas/AddressDTO"},"phone":{"type":"string","description":"Phone"},"mail":{"type":"string","description":"e-Mail"},"isSameAddress":{"type":"boolean","description":"Is same address"},"businessAddress":{"$ref":"#/components/schemas/AddressDTO"},"businessPhone":{"type":"string","description":"Business phone"},"businessMail":{"type":"string","description":"Business e-Mail"},"annotations":{"type":"string","description":"The annotations attribute."},"discountPercentage":{"maximum":100,"minimum":0,"type":"number","description":"Discount percentage attribute.","format":"double"},"purchaseType":{"type":"string","description":"Default purchase type\r\nCommon services = \"S\"\r\nCommon goods = \"C\"\r\nInvestments = \"I\""},"bankId":{"type":"string","description":"Bank identifier"},"paymentMethodId":{"type":"string","description":"Payment method id"},"paymentTypeId":{"type":"string","description":"Payment document id"},"paymentDay1":{"type":"integer","description":"Payment day 1 attribute.","format":"int32"},"paymentDay2":{"type":"integer","description":"Payment day 2 attribute.","format":"int32"},"paymentDay3":{"type":"integer","description":"Payment day 3 attribute.","format":"int32"},"operationType":{"type":"string","description":"Operation type attribute."},"taxType":{"type":"string","description":"Tax type attribute."},"taxIncluded":{"type":"boolean","description":"Tax included attribute."},"withholdingPercentage":{"maximum":100,"minimum":0,"type":"number","description":"Withholding percentage","format":"double"},"withholdingModel":{"type":"string","description":"Withholding model\r\nModel 111 = \"110\"\r\nModel 115/180 = \"115\"\r\nModel 123 = \"123\"\r\nOther models = \"OTR\""},"withholdingKeyId":{"type":"integer","description":"Withholding key id","format":"int32"},"withholdingSubKeyId":{"type":"integer","description":"Withholding subkey id","format":"int32"},"expenseTypeId":{"type":"string","description":"Expense type id"},"contact":{"$ref":"#/components/schemas/ContactDTO"},"source":{"type":"string","description":"Entity source"},"sourceId":{"type":"string","description":"Source entity identifier"},"customProperties":{"type":"array","items":{"$ref":"#/components/schemas/CustomPropertyDTO"},"description":"Custom properties"},"accountCode":{"type":"string","description":"Account code"},"accountId":{"type":"string","description":"Account Id"},"rateId":{"type":"string","description":"Purchase rate id\r\nnullable: true\r\nNon-mandatory field (we assign the company's default value). Required when Purchase Rates functionality is enabled in the company."},"discountId":{"type":"string","description":"Discount identifier\r\nnullable: true","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}},"description":"Supplier"},"FlatSupplierDTO":{"type":"object","properties":{"id":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"vatNumber":{"type":"string"},"vatNumberType":{"type":"integer","format":"int32"},"code":{"type":"string"},"name":{"type":"string"},"businessName":{"type":"string"},"web":{"type":"string"},"street":{"type":"string"},"zipCode":{"type":"string"},"town":{"type":"string"},"province":{"type":"string"},"phone":{"type":"string"},"mail":{"type":"string"},"businessStreet":{"type":"string"},"businessZipCode":{"type":"string"},"businessTown":{"type":"string"},"businessProvince":{"type":"string"},"businessPhone":{"type":"string"},"businessMail":{"type":"string"},"accountCode":{"type":"string"},"accountId":{"type":"string"},"source":{"type":"string","description":"Source"},"sourceId":{"type":"string","description":"Source identifier"},"enabled":{"type":"boolean","description":"Enabled attribute."},"legacyId":{"type":"integer","format":"int32"}}},"SupplyInvoiceDTO":{"required":["lines"],"type":"object","properties":{"id":{"type":"string","description":"Identifier."},"date":{"type":"string","description":"Date. If null, system date is used.","format":"date-time"},"accountingDate":{"type":"string","description":"Date. If null, system date is used.","format":"date-time"},"supplierId":{"type":"string","description":"Supplier identifier."},"activityId":{"type":"string","description":"Activity identifier. Null = Default activity selected in options. Other values = An existing activity of the company."},"serieId":{"type":"string","description":"Serie identifier. Null = Default serie selected in options. Other values = An existing serie of the company."},"number":{"type":"integer","description":"Number","format":"int64"},"documentNumber":{"type":"string","description":"DocumentNumber"},"reference":{"type":"string","description":"Reference."},"bankId":{"type":"string","description":"Bank identifier. Null = Default bank selected in supplier.  Other values = An existing bank of the company."},"paymentMethodId":{"type":"string","description":"Payment Method identifier. Null = Default payment method selected in supplier. Other values = An existing payment method of the company."},"paymentTypeId":{"type":"string","description":"Payment Type identifier. Null= Default payment type selected in supplier. Other values = An existing payment type of the company."},"vatNumber":{"type":"string","description":"Vat number"},"vatNumberType":{"type":"integer","description":"Vat number type\r\nNone = 0,\r\nCif = 1,\r\nNif = 2,\r\nNie = 3,\r\nNifIntracom = 4,\r\nOther = 5,\r\nPassport = 6,\r\nResidenceCountryOfficialDocument = 7,\r\nTaxResidenceCertificate = 8","format":"int32"},"name":{"type":"string","description":"Name"},"email":{"type":"string","description":"Email"},"emailCC":{"type":"string","description":"Email"},"address":{"type":"string","description":"Tax address"},"zipCode":{"type":"string","description":"Tax zip code"},"town":{"type":"string","description":"Tax town"},"provinceCode":{"type":"string","description":"Tax province code"},"provinceName":{"type":"string","description":"Tax province name"},"countryCode":{"type":"string","description":"Tax country code"},"addressDetails":{"type":"string","description":"Tax address details"},"directDebitId":{"type":"string","description":"Direct debit identifier."},"operationTypeCode":{"type":"string","description":"Purchase operation type code"},"invoiceType":{"type":"string","description":"Supply invoice type\r\nCommon services = \"S\"\r\nCommon goods = \"C\"\r\nInvestments = \"I\""},"isRent":{"type":"boolean","description":"Is rent supply invice"},"isTaxIncluded":{"type":"boolean","description":"Is tax included in the supply invoice"},"isTaxBaseAffected":{"type":"boolean","description":"Is tax base affected in the supply invoice"},"totalPromptPayment":{"type":"number","description":"Total prompt payment","format":"double"},"promptPaymentPercentage":{"maximum":100,"minimum":0,"type":"number","description":"Prompt payment percentage","format":"double"},"totalFinancialSurcharge":{"type":"number","description":"Total financial surcharge","format":"double"},"financialSurchargePercentage":{"maximum":100,"minimum":0,"type":"number","description":"Financial surcharge percentage","format":"double"},"taxRetentionBase":{"type":"number","description":"Tax retention base","format":"double"},"withholdingPercentage":{"maximum":100,"minimum":0,"type":"number","description":"Withholding percentage","format":"double"},"withholdingModel":{"type":"string","description":"Withholding model\r\nModel 111 = \"110\"\r\nModel 115/180 = \"115\"\r\nModel 123 = \"123\"\r\nOther models = \"OTR\""},"withholdingKeyId":{"type":"integer","description":"Withholding key id","format":"int32"},"withholdingSubKeyId":{"type":"integer","description":"Withholding subkey id","format":"int32"},"annotations":{"type":"string","description":"Annotations"},"taxBase":{"type":"number","description":"Supply invoice tax base. Read only.","format":"double"},"totalTax":{"type":"number","description":"Supply invoice total tax. Read only.","format":"double"},"totalRetention":{"type":"number","description":"Supply invoice total retention.","format":"double"},"total":{"type":"number","description":"Supply invoice total. Read only.","format":"double"},"purchaseCurrency":{"type":"string","description":"Purchase currency. Read only."},"situation":{"type":"integer","description":"Situation","format":"int32"},"isInmediatePayment":{"type":"boolean","description":"Is inmediate payment"},"source":{"type":"string","description":"Entity source."},"sourceId":{"type":"string","description":"Source entity identifier."},"version":{"type":"string","description":"Document version. Read only."},"isRectificative":{"type":"boolean","description":"Is rectificative. Read only."},"rectifiedId":{"type":"string","description":"rectified id"},"rectifiedDate":{"type":"string","description":"rectified date. Read only.","format":"date-time"},"rectifiedNumber":{"type":"string","description":"rectified number. Read only."},"isRectified":{"type":"boolean","description":"Is rectified. Read only."},"rectificativeId":{"type":"string","description":"rectificative id. Read only."},"rectificativeDate":{"type":"string","description":"rectificative date. Read only.","format":"date-time"},"rectificativeNumber":{"type":"string","description":"rectificative number. Read only."},"lines":{"type":"array","items":{"$ref":"#/components/schemas/SupplyInvoiceLineDTO"}},"siiData":{"$ref":"#/components/schemas/PurchaseInvoiceSiiDataDto"},"isMigrated":{"type":"boolean","description":"IsMigrated. Read only."},"warehouseCorrelationId":{"type":"string","description":"Warehouse CorrelationId","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}},"SupplyInvoiceLineDTO":{"type":"object","properties":{"id":{"type":"string","description":"Id"},"description":{"type":"string","description":"Description"},"price":{"type":"number","description":"Price. Default value is 0.","format":"double"},"expenseTypeId":{"type":"string","description":"Id Expense type. Default value is null"},"taxDeductionType":{"type":"string","description":"Tax deductionType\r\nNon deductible = \"N\"\r\nDeductible = \"D\""},"taxTypeCode":{"type":"string","description":"Tax type code"},"taxRate":{"type":"number","description":"Tax rate. Read only.","format":"double"},"taxSurchargeRate":{"type":"number","description":"Tax surcharge","format":"double"},"isExpense":{"type":"boolean","description":"Expenses paid on behalf of the supplier?"},"taxBase":{"type":"number","description":"Tax base. Read only.","format":"double"},"annotations":{"type":"string","description":"Annotations"},"warehouseCorrelationId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"priceOrigin":{"type":"string","description":"Price origin: None, Rate, Product, Manual"}}},"FlatSupplyInvoiceDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"number":{"type":"string","description":"Number"},"date":{"type":"string","description":"Date","format":"date-time"},"accountingDate":{"type":"string","description":"Date","format":"date-time"},"reference":{"type":"string","description":"Reference"},"supplierId":{"type":"string","description":"Supplier SupplierId."},"supplierVATNumber":{"type":"string","description":"VATNumber."},"supplierName":{"type":"string","description":"Name"},"email":{"type":"string","description":"Document email"},"taxBase":{"type":"number","description":"Tax base","format":"double"},"taxTotal":{"type":"number","description":"Tax total","format":"double"},"total":{"type":"number","description":"Total","format":"double"},"purchaseCurrency":{"type":"string","description":"Purchase currency"},"purchaseOperationTypeCode":{"type":"string","description":"Purchase operation type code"},"purchaseOperationTypeDescription":{"type":"string","description":"Purchase operation type description"},"invoiceType":{"type":"string","description":"Invoice type"},"situation":{"type":"integer","description":"Situation","format":"int32"},"isRectificative":{"type":"boolean","description":"Is rectificative"},"rectifiedId":{"type":"string","description":"rectified id"},"rectifiedDate":{"type":"string","description":"rectified date","format":"date-time"},"rectifiedNumber":{"type":"string","description":"rectified number"},"isRectified":{"type":"boolean","description":"Is rectified"},"rectificativeId":{"type":"string","description":"rectificative id"},"rectificativeDate":{"type":"string","description":"rectificative date","format":"date-time"},"rectificativeNumber":{"type":"string","description":"rectificative number"},"source":{"type":"string","description":"Source"},"sourceId":{"type":"string","description":"Source identifier"},"isMigrated":{"type":"boolean","description":"IsMigrated. Read only."}}},"TagDTO":{"required":["description"],"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"description":{"type":"string","description":"Description"},"type":{"type":"integer","description":"Type\r\nNone = 0 \r\nFee = 1","format":"int32"}}},"TaxRateDTO":{"type":"object","properties":{"code":{"type":"string","description":"Tax type code"},"description":{"type":"string","description":"Tax type description"},"type":{"type":"string","description":"Tax Type"},"date":{"type":"string","description":"Tax Rate applicable from","format":"date-time"},"since":{"type":"string","description":"Tax Rate applicable from","format":"date-time"},"until":{"type":"string","description":"Tax Rate applicable from","format":"date-time"},"rate":{"type":"number","description":"Rate","format":"double"},"surcharge":{"type":"number","description":"Surcharge","format":"double"}}},"TicketBAIDTO":{"type":"object","properties":{"id":{"type":"string","description":"Id"},"invoiceType":{"type":"integer","description":"Invoice type","format":"int32"},"invoiceTypeDescription":{"type":"string","description":"Invoice type description"},"documentNumber":{"type":"string","description":"DocumentNumber"},"invoiceDate":{"type":"string","description":"Invoice date","format":"date-time"},"rectifiedInvoiceId":{"type":"string","description":"Rectified invoiceId"},"customerName":{"type":"string","description":"Customer name"},"invoiceAmount":{"type":"number","description":"Invoice smount","format":"double"},"logStatus":{"type":"integer","description":"Log status","format":"int32"},"logStatusDescription":{"type":"string","description":"Log status description"},"sentDate":{"type":"string","description":"Sent","format":"date-time"},"invoiceId":{"type":"string","description":"Invoice Id"},"relatedDocNumber":{"type":"string","description":"Related Document Number"},"identifierTBAI":{"type":"string","description":"Identifier TBAI"},"relatedInvoices":{"type":"array","items":{"$ref":"#/components/schemas/RelatedInvoiceDTO"}},"relatedInvoiceDescription":{"type":"string"},"relatedDescriptionToPrint":{"type":"string"},"logDate":{"type":"string","format":"date-time"},"eInvoiceOrigin":{"type":"integer","description":"Who created the record","format":"int32"}},"description":"TicketBAIDTO"},"RelatedInvoiceDTO":{"type":"object","properties":{"id":{"type":"string","description":"Id"},"invoiceType":{"type":"integer","description":"Invoice type","format":"int32"},"invoiceDate":{"type":"string","description":"Invoice date","format":"date-time"},"documentNumber":{"type":"string","description":"DocumentNumber"},"relatedInvoiceDescription":{"type":"string","description":"Related invoice description"},"logDate":{"type":"string","description":"Movement Date","format":"date-time"}}},"FilterRequest":{"type":"object","properties":{"searchBy":{"type":"string","description":"Generic search"},"filter":{"type":"string","description":"Filter"}},"description":"Filter definition"},"TicketDTO":{"required":["expenseTypeId"],"type":"object","properties":{"id":{"type":"string","description":"Identifier."},"activityId":{"type":"string","description":"Activity identifier. Null = Default activity selected in options. Other values = An existing activity of the company."},"date":{"type":"string","description":"Date. If null, system date is used.","format":"date-time"},"number":{"type":"string","description":"Ticket number."},"annotations":{"type":"string","description":"Annotations."},"amount":{"minimum":0,"type":"number","description":"Ticket total amount","format":"double"},"bankId":{"type":"string","description":"Bank identifier. Null = Default bank selected in supplier.  Other values = An existing bank of the company."},"expenseTypeId":{"type":"string","description":"Expense type id"},"source":{"type":"string","description":"Entity source."},"sourceId":{"type":"string","description":"Source entity identifier."},"isMigrated":{"type":"boolean","description":"IsMigrated. Read only."}}},"FlatTicketDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"number":{"type":"string","description":"Number"},"date":{"type":"string","description":"Date","format":"date-time"},"amount":{"type":"number","description":"Ticket total","format":"double"},"annotations":{"type":"string","description":"Annotations"},"bankId":{"type":"string","description":"Bank identifier"},"currencyCode":{"type":"string","description":"Cuurrency"},"expenseTypeDescription":{"type":"string","description":"Expense type description"},"bankName":{"type":"string","description":"Bank name"},"documentNumber":{"type":"string","description":"Document number."},"expenseTypeId":{"type":"string"},"source":{"type":"string","description":"Source"},"sourceId":{"type":"string","description":"Source identifier"},"activityId":{"type":"string","description":"Activity identifier"},"activityDescription":{"type":"string","description":"Activity description"},"isMigrated":{"type":"boolean","description":"IsMigrated. Read only."}}},"CompanyLicensingDTO":{"type":"object","properties":{"licensingStatus":{"type":"integer","description":"Licensing status\r\nNone = 0,\r\nActivo = 1,\r\nBaja = 2,\r\nTry=3,\r\nFueraDeMantenimiento = 5,\r\nBajaEnTramite = 6","format":"int32"},"productType":{"type":"integer","description":"None = 0,\r\nGoFromAdvisor = 1,\r\nGoDirectSale = 2, \r\nProFromAdvisor = 3, \r\nProDirectSale = 4, \r\nA3InnuvaAsesor = 5,\r\nA3InnuvaPyme = 6","format":"int32"},"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Company name"},"idCDA":{"type":"string","description":"CDA"},"default":{"type":"boolean","description":"Default company"},"companyStatus":{"enum":["Updating","Active","Blocked","Error","MustBeUpdated","Creating","ProcessInProgress","PendingToDelete","None"],"type":"string","description":"Company status"}}},"LoginRequest":{"type":"object","properties":{"mail":{"type":"string","description":"User mail"},"password":{"type":"string","description":"Password"}},"description":"Login request"},"LoginResponse":{"type":"object","properties":{"token":{"type":"string","description":"Token"},"refreshToken":{"type":"string","description":"Refresh token"},"mail":{"type":"string","description":"User's e-mail"},"locale":{"type":"string","description":"User's language"},"name":{"type":"string","description":"User's name"},"id":{"type":"integer","description":"Identifier","format":"int32"},"version":{"type":"string","description":"Application version"},"isAdvisor":{"type":"boolean","description":"Is advisor"},"companies":{"type":"array","items":{"$ref":"#/components/schemas/CompanyDTO"}}}},"ApplicationTokenCommand":{"type":"object","properties":{"applicationName":{"type":"string","description":"Application Name"},"credentials":{"type":"string","description":"Credentials"}},"description":"Application Token Command"},"SetCookiesFromTokenRequest":{"type":"object","properties":{"access_token":{"type":"string","description":"Access token"},"refresh_token":{"type":"string","description":"Refresh token"},"session":{"type":"string","description":"Session identifier"}},"description":"Request to set cookies from token"},"ReloadTokenFromCookiesRequest":{"type":"object","properties":{"session":{"type":"string","description":"Session identifier"}},"description":"Request to reload token from cookies"},"ResetPasswordRequest":{"type":"object","properties":{"token":{"type":"string","description":"Token"},"password":{"type":"string","description":"Password"}}},"WebHookDto":{"type":"object","properties":{"Uri":{"type":"string"},"Entity":{"type":"string"},"Action":{"enum":["None","Created","Updated","Deleted"],"type":"string"},"Secret":{"type":"string"},"IsPaused":{"type":"boolean"},"ApplicationName":{"type":"string"},"Description":{"type":"string"}}},"WithHoldingKeyDTO":{"required":["description"],"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"code":{"type":"string","description":"Code"},"description":{"type":"string","description":"Name"}}},"WithHoldingSubKeyDTO":{"required":["description"],"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"code":{"type":"string","description":"Code"},"description":{"type":"string","description":"Name"},"withHoldingKeyId":{"type":"integer","description":"With holding key Identifier","format":"int32"},"percentage":{"type":"number","description":"Percentage","format":"double"},"dateFrom":{"type":"string","description":"DateFrom","format":"date-time"},"dateTo":{"type":"string","description":"DateTo","format":"date-time"}}},"ZipCodeDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"code":{"type":"string","description":"Code"},"provinceCode":{"type":"string","description":"Province Code"},"town":{"type":"string","description":"Towns"}}},"AccountDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/AccountDTO"}},"PatchOperationArray":{"type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}},"FlatActivityDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/FlatActivityDTO"}},"AdditionalModuleDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/AdditionalModuleDTO"}},"ApiAntifraudLawRe-sendIdPost202ApplicationJsonResponse":{"type":"object"},"ApiAntifraudLawRe-sendIdPost202TextJsonResponse":{"type":"object"},"ApiAntifraudLawRe-sendIdPost202TextHtmlResponse":{"type":"object"},"ApiAntifraudLawRe-sendIdPost202ApplicationVnd-wkes-jsonResponse":{"type":"object"},"ApiAntifraudLawRe-sendIdPost202ApplicationXmlResponse":{"type":"object"},"ApiAntifraudLawRe-sendIdPost202TextXmlResponse":{"type":"object"},"ApiBackofficeShowNPSGet200ApplicationJsonResponse":{"type":"boolean"},"ApiBackofficeShowNPSGet200TextJsonResponse":{"type":"boolean"},"ApiBackofficeShowNPSGet200TextHtmlResponse":{"type":"boolean"},"ApiBackofficeShowNPSGet200ApplicationVnd-wkes-jsonResponse":{"type":"boolean"},"ApiBackofficeShowNPSGet200ApplicationXmlResponse":{"type":"boolean"},"ApiBackofficeShowNPSGet200TextXmlResponse":{"type":"boolean"},"ApiBackofficeSkipvideoGet200ApplicationJsonResponse":{"type":"boolean"},"ApiBackofficeSkipvideoGet200TextJsonResponse":{"type":"boolean"},"ApiBackofficeSkipvideoGet200TextHtmlResponse":{"type":"boolean"},"ApiBackofficeSkipvideoGet200ApplicationVnd-wkes-jsonResponse":{"type":"boolean"},"ApiBackofficeSkipvideoGet200ApplicationXmlResponse":{"type":"boolean"},"ApiBackofficeSkipvideoGet200TextXmlResponse":{"type":"boolean"},"ApiBackofficeShowFirstUseGet200ApplicationJsonResponse":{"type":"boolean"},"ApiBackofficeShowFirstUseGet200TextJsonResponse":{"type":"boolean"},"ApiBackofficeShowFirstUseGet200TextHtmlResponse":{"type":"boolean"},"ApiBackofficeShowFirstUseGet200ApplicationVnd-wkes-jsonResponse":{"type":"boolean"},"ApiBackofficeShowFirstUseGet200ApplicationXmlResponse":{"type":"boolean"},"ApiBackofficeShowFirstUseGet200TextXmlResponse":{"type":"boolean"},"Email":{"type":"string"},"BankDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/BankDTO"}},"CompanyDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/CompanyDTO"}},"ApiCompaniesIdImageGet200ImageJpegResponse":{"type":"array"},"RefreshToken":{"type":"string"},"ApiCompanyImageGet200ImageJpegResponse":{"type":"array"},"ApiCompanyFeaturesGet200ApplicationJsonResponse":{"type":"array","items":{"type":"string"}},"ApiCompanyFeaturesGet200TextJsonResponse":{"type":"array","items":{"type":"string"}},"ApiCompanyFeaturesGet200TextHtmlResponse":{"type":"array","items":{"type":"string"}},"ApiCompanyFeaturesGet200ApplicationVnd-wkes-jsonResponse":{"type":"array","items":{"type":"string"}},"ApiCompanyFeaturesGet200ApplicationXmlResponse":{"type":"array","items":{"type":"string"}},"ApiCompanyFeaturesGet200TextXmlResponse":{"type":"array","items":{"type":"string"}},"ApiCompanyFakeRealTypeGet200ApplicationJsonResponse":{"enum":["Unknown","Real","Fake"],"type":"string"},"ApiCompanyFakeRealTypeGet200TextJsonResponse":{"enum":["Unknown","Real","Fake"],"type":"string"},"ApiCompanyFakeRealTypeGet200TextHtmlResponse":{"enum":["Unknown","Real","Fake"],"type":"string"},"ApiCompanyFakeRealTypeGet200ApplicationVnd-wkes-jsonResponse":{"enum":["Unknown","Real","Fake"],"type":"string"},"ApiCompanyFakeRealTypeGet200ApplicationXmlResponse":{"enum":["Unknown","Real","Fake"],"type":"string"},"ApiCompanyFakeRealTypeGet200TextXmlResponse":{"enum":["Unknown","Real","Fake"],"type":"string"},"ConfigurationValueDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/ConfigurationValueDTO"}},"ReportTemplateDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/ReportTemplateDTO"}},"AccountsGroupDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/AccountsGroupDTO"}},"CountryDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/CountryDTO"}},"CurrencyDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/CurrencyDTO"}},"ApiCustomersIdImageGet200ImageJpegResponse":{"type":"array"},"ApiCustomersIdImageGet204ImageJpegResponse":{"type":"array"},"CustomerAddressDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/CustomerAddressDTO"}},"DirectDebitDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/DirectDebitDTO"}},"FeeDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/FeeDTO"}},"CustomerContactDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/CustomerContactDTO"}},"FlatCustomerDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/FlatCustomerDTO"}},"ApiCustomersExportPost200ApplicationOctet-streamResponse":{"type":"array"},"ApiCustomersExportPost204ApplicationOctet-streamResponse":{"type":"array"},"CustomSchemaDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/CustomSchemaDTO"}},"EntityDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/EntityDTO"}},"PropertyDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/PropertyDTO"}},"ApiDownloadFilesGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiDownloadFilesGet200ApplicationPdfResponse":{"type":"array"},"ApiDownloadFilesGet200ApplicationVnd-ms-excelResponse":{"type":"array"},"ApiDownloadFilesGet204ApplicationOctet-streamResponse":{"type":"array"},"ApiDownloadFilesGet204ApplicationPdfResponse":{"type":"array"},"ApiDownloadFilesGet204ApplicationVnd-ms-excelResponse":{"type":"array"},"DownloadinvoiceSaleIdCDAIdGet200ApplicationOctet-streamResponse":{"type":"object"},"DownloadinvoicePurchaseIdCDAIdGet200ApplicationOctet-streamResponse":{"type":"object"},"ReportsGet200ApplicationJsonResponse":{"type":"object"},"ReportsGet200TextJsonResponse":{"type":"object"},"ReportsGet200TextHtmlResponse":{"type":"object"},"ReportsGet200ApplicationVnd-wkes-jsonResponse":{"type":"object"},"ReportsGet200ApplicationXmlResponse":{"type":"object"},"ReportsGet200TextXmlResponse":{"type":"object"},"DraftDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/DraftDTO"}},"DueDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/DueDTO"}},"ChargeDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/ChargeDTO"}},"PaymentDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/PaymentDTO"}},"BankPaymentDtoArray":{"type":"array","items":{"$ref":"#/components/schemas/BankPaymentDto"}},"BankChargeDtoArray":{"type":"array","items":{"$ref":"#/components/schemas/BankChargeDto"}},"ApiDuesChargesExportGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiDuesChargesExportGet204ApplicationOctet-streamResponse":{"type":"array"},"ApiDuesPaymentsExportGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiDuesPaymentsExportGet204ApplicationOctet-streamResponse":{"type":"array"},"EpigraphDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/EpigraphDTO"}},"ExpenseTypeDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/ExpenseTypeDTO"}},"InvoiceCorrelationId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"PeriodFeeDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/PeriodFeeDTO"}},"ApiIbanSwiftGet200ApplicationJsonResponse":{"type":"string"},"ApiIbanSwiftGet200TextJsonResponse":{"type":"string"},"ApiIbanSwiftGet200TextHtmlResponse":{"type":"string"},"ApiIbanSwiftGet200ApplicationVnd-wkes-jsonResponse":{"type":"string"},"ApiIbanSwiftGet200ApplicationXmlResponse":{"type":"string"},"ApiIbanSwiftGet200TextXmlResponse":{"type":"string"},"ApiImportDownloadTemplateEntityGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiImportDownloadTemplateEntityGet204ApplicationOctet-streamResponse":{"type":"array"},"IncomeTypeDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/IncomeTypeDTO"}},"InventoryDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/InventoryDTO"}},"InventoryLineDtoArray":{"type":"array","items":{"$ref":"#/components/schemas/InventoryLineDto"}},"KpiDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/KpiDTO"}},"ApiKpiPost200ApplicationJsonResponse":{"type":"object"},"ApiKpiPost200TextJsonResponse":{"type":"object"},"ApiKpiPost200TextHtmlResponse":{"type":"object"},"ApiKpiPost200ApplicationVnd-wkes-jsonResponse":{"type":"object"},"ApiKpiPost200ApplicationXmlResponse":{"type":"object"},"ApiKpiPost200TextXmlResponse":{"type":"object"},"ApiLegalRepresentativeGet200ApplicationJsonResponse":{"type":"object"},"ApiLegalRepresentativeGet200TextJsonResponse":{"type":"object"},"ApiLegalRepresentativeGet200TextHtmlResponse":{"type":"object"},"ApiLegalRepresentativeGet200ApplicationVnd-wkes-jsonResponse":{"type":"object"},"ApiLegalRepresentativeGet200ApplicationXmlResponse":{"type":"object"},"ApiLegalRepresentativeGet200TextXmlResponse":{"type":"object"},"ApiLegalRepresentativePost204ApplicationJsonResponse":{"type":"object"},"ApiLegalRepresentativePost204TextJsonResponse":{"type":"object"},"ApiLegalRepresentativePost204TextHtmlResponse":{"type":"object"},"ApiLegalRepresentativePost204ApplicationVnd-wkes-jsonResponse":{"type":"object"},"ApiLegalRepresentativePost204ApplicationXmlResponse":{"type":"object"},"ApiLegalRepresentativePost204TextXmlResponse":{"type":"object"},"ApiLegalRepresentativeLegalRepresentativeIdPut204ApplicationJsonResponse":{"type":"object"},"ApiLegalRepresentativeLegalRepresentativeIdPut204TextJsonResponse":{"type":"object"},"ApiLegalRepresentativeLegalRepresentativeIdPut204TextHtmlResponse":{"type":"object"},"ApiLegalRepresentativeLegalRepresentativeIdPut204ApplicationVnd-wkes-jsonRes":{"type":"object"},"ApiLegalRepresentativeLegalRepresentativeIdPut204ApplicationXmlResponse":{"type":"object"},"ApiLegalRepresentativeLegalRepresentativeIdPut204TextXmlResponse":{"type":"object"},"Price":{"type":"number","format":"double"},"ApiModulesRegisterTokenApplicationNameGet200ApplicationJsonResponse":{"type":"string"},"ApiModulesRegisterTokenApplicationNameGet200TextJsonResponse":{"type":"string"},"ApiModulesRegisterTokenApplicationNameGet200TextHtmlResponse":{"type":"string"},"ApiModulesRegisterTokenApplicationNameGet200ApplicationVnd-wkes-jsonResponse":{"type":"string"},"ApiModulesRegisterTokenApplicationNameGet200ApplicationXmlResponse":{"type":"string"},"ApiModulesRegisterTokenApplicationNameGet200TextXmlResponse":{"type":"string"},"ApiModulesUnregisterTokenApplicationNameGet200ApplicationJsonResponse":{"type":"string"},"ApiModulesUnregisterTokenApplicationNameGet200TextJsonResponse":{"type":"string"},"ApiModulesUnregisterTokenApplicationNameGet200TextHtmlResponse":{"type":"string"},"ApiModulesUnregisterTokenApplicationNameGet200ApplicationVnd-wkes-jsonRespon":{"type":"string"},"ApiModulesUnregisterTokenApplicationNameGet200ApplicationXmlResponse":{"type":"string"},"ApiModulesUnregisterTokenApplicationNameGet200TextXmlResponse":{"type":"string"},"ApplicationDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationDTO"}},"ApiOrganizationsVatTypeNumberGet200ApplicationJsonResponse":{"type":"integer","format":"int32"},"ApiOrganizationsVatTypeNumberGet200TextJsonResponse":{"type":"integer","format":"int32"},"ApiOrganizationsVatTypeNumberGet200TextHtmlResponse":{"type":"integer","format":"int32"},"ApiOrganizationsVatTypeNumberGet200ApplicationVnd-wkes-jsonResponse":{"type":"integer","format":"int32"},"ApiOrganizationsVatTypeNumberGet200ApplicationXmlResponse":{"type":"integer","format":"int32"},"ApiOrganizationsVatTypeNumberGet200TextXmlResponse":{"type":"integer","format":"int32"},"OrganizationDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationDTO"}},"PaymentMethodDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethodDTO"}},"PaymentTypeDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/PaymentTypeDTO"}},"ApiProcessLogsIdDelete204ApplicationJsonResponse":{"type":"object"},"ApiProcessLogsIdDelete204TextJsonResponse":{"type":"object"},"ApiProcessLogsIdDelete204TextHtmlResponse":{"type":"object"},"ApiProcessLogsIdDelete204ApplicationVnd-wkes-jsonResponse":{"type":"object"},"ApiProcessLogsIdDelete204ApplicationXmlResponse":{"type":"object"},"ApiProcessLogsIdDelete204TextXmlResponse":{"type":"object"},"ProcessResultDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/ProcessResultDTO"}},"ProcessLogFlatDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/ProcessLogFlatDTO"}},"ApiProcessLogsExportGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiProcessLogsExportGet204ApplicationOctet-streamResponse":{"type":"array"},"ApiProductsProductIdImageGet200ImageJpegResponse":{"type":"array"},"SaleRateDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/SaleRateDTO"}},"FlatProductDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/FlatProductDTO"}},"ApiProductsExportGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiProductsExportGet204ApplicationOctet-streamResponse":{"type":"array"},"ProductVariantsDtoArray":{"type":"array","items":{"$ref":"#/components/schemas/ProductVariantsDto"}},"ProvinceDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/ProvinceDTO"}},"CircuitInfoDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/CircuitInfoDTO"}},"DocumentLineInfoDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/DocumentLineInfoDTO"}},"ApiPurchaseDeliveryNotesIdLineLineIdDestinationdocumentscountGet200Applicati":{"type":"integer","format":"int32"},"ApiPurchaseDeliveryNotesIdLineLineIdDestinationdocumentscountGet200TextJsonR":{"type":"integer","format":"int32"},"ApiPurchaseDeliveryNotesIdLineLineIdDestinationdocumentscountGet200TextHtmlR":{"type":"integer","format":"int32"},"ApiPurchaseDeliveryNotesIdLineLineIdDestinationdocumentscountGet200Applicati-1":{"type":"integer","format":"int32"},"ApiPurchaseDeliveryNotesIdLineLineIdDestinationdocumentscountGet200Applicati-2":{"type":"integer","format":"int32"},"ApiPurchaseDeliveryNotesIdLineLineIdDestinationdocumentscountGet200TextXmlRe":{"type":"integer","format":"int32"},"FlatPurchaseDeliveryNoteDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/FlatPurchaseDeliveryNoteDTO"}},"ApiPurchaseDeliveryNotesExportGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiPurchaseDeliveryNotesExportGet204ApplicationOctet-streamResponse":{"type":"array"},"ApiPurchaseDocumentsIdAttachmentGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiPurchaseDocumentsIdAttachmentGet204ApplicationOctet-streamResponse":{"type":"array"},"FlatPurchaseDocumentDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/FlatPurchaseDocumentDTO"}},"ApiPurchaseDocumentsExportGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiPurchaseDocumentsExportGet204ApplicationOctet-streamResponse":{"type":"array"},"ApiPurchaseDocumentsExtendedExportGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiPurchaseDocumentsExtendedExportGet204ApplicationOctet-streamResponse":{"type":"array"},"ApiPurchaseInvoicesIdAttachmentGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiPurchaseInvoicesIdAttachmentGet204ApplicationOctet-streamResponse":{"type":"array"},"SiiRegimeTypeDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/SiiRegimeTypeDTO"}},"SiiInvoiceTypeDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/SiiInvoiceTypeDTO"}},"FlatPurchaseInvoiceDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/FlatPurchaseInvoiceDTO"}},"PurchaseOperationTypeDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/PurchaseOperationTypeDTO"}},"ApiPurchaseOrdersIdLineLineIdDestinationdocumentscountGet200ApplicationJsonR":{"type":"integer","format":"int32"},"ApiPurchaseOrdersIdLineLineIdDestinationdocumentscountGet200TextJsonResponse":{"type":"integer","format":"int32"},"ApiPurchaseOrdersIdLineLineIdDestinationdocumentscountGet200TextHtmlResponse":{"type":"integer","format":"int32"},"ApiPurchaseOrdersIdLineLineIdDestinationdocumentscountGet200ApplicationVnd-w":{"type":"integer","format":"int32"},"ApiPurchaseOrdersIdLineLineIdDestinationdocumentscountGet200ApplicationXmlRe":{"type":"integer","format":"int32"},"ApiPurchaseOrdersIdLineLineIdDestinationdocumentscountGet200TextXmlResponse":{"type":"integer","format":"int32"},"FlatPurchaseOrderDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/FlatPurchaseOrderDTO"}},"ApiPurchaseOrdersExportGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiPurchaseOrdersExportGet204ApplicationOctet-streamResponse":{"type":"array"},"MigrationMonitoringDtoArray":{"type":"array","items":{"$ref":"#/components/schemas/MigrationMonitoringDto"}},"RateDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/RateDTO"}},"ApiRegisteredInvoicesIdSendResponseGet200ApplicationJsonResponse":{"type":"string"},"ApiRegisteredInvoicesIdSendResponseGet200TextJsonResponse":{"type":"string"},"ApiRegisteredInvoicesIdSendResponseGet200TextHtmlResponse":{"type":"string"},"ApiRegisteredInvoicesIdSendResponseGet200ApplicationVnd-wkes-jsonResponse":{"type":"string"},"ApiRegisteredInvoicesIdSendResponseGet200ApplicationXmlResponse":{"type":"string"},"ApiRegisteredInvoicesIdSendResponseGet200TextXmlResponse":{"type":"string"},"ApiRegisteredInvoicesIdSendResponseGet204ApplicationJsonResponse":{"type":"string"},"ApiRegisteredInvoicesIdSendResponseGet204TextJsonResponse":{"type":"string"},"ApiRegisteredInvoicesIdSendResponseGet204TextHtmlResponse":{"type":"string"},"ApiRegisteredInvoicesIdSendResponseGet204ApplicationVnd-wkes-jsonResponse":{"type":"string"},"ApiRegisteredInvoicesIdSendResponseGet204ApplicationXmlResponse":{"type":"string"},"ApiRegisteredInvoicesIdSendResponseGet204TextXmlResponse":{"type":"string"},"AntifraudLawInvoiceLogDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/AntifraudLawInvoiceLogDTO"}},"ApiRegisteredInvoicesExportGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiRegisteredInvoicesExportGet204ApplicationOctet-streamResponse":{"type":"array"},"RegularizationDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/RegularizationDTO"}},"ApiRemittancesIdDuesCollectionCountGet200ApplicationJsonResponse":{"type":"integer","format":"int32"},"ApiRemittancesIdDuesCollectionCountGet200TextJsonResponse":{"type":"integer","format":"int32"},"ApiRemittancesIdDuesCollectionCountGet200TextHtmlResponse":{"type":"integer","format":"int32"},"ApiRemittancesIdDuesCollectionCountGet200ApplicationVnd-wkes-jsonResponse":{"type":"integer","format":"int32"},"ApiRemittancesIdDuesCollectionCountGet200ApplicationXmlResponse":{"type":"integer","format":"int32"},"ApiRemittancesIdDuesCollectionCountGet200TextXmlResponse":{"type":"integer","format":"int32"},"ApiRemittancesIdDuesCollectionGetFirstGet200ApplicationJsonResponse":{"type":"string","format":"date-time"},"ApiRemittancesIdDuesCollectionGetFirstGet200TextJsonResponse":{"type":"string","format":"date-time"},"ApiRemittancesIdDuesCollectionGetFirstGet200TextHtmlResponse":{"type":"string","format":"date-time"},"ApiRemittancesIdDuesCollectionGetFirstGet200ApplicationVnd-wkes-jsonResponse":{"type":"string","format":"date-time"},"ApiRemittancesIdDuesCollectionGetFirstGet200ApplicationXmlResponse":{"type":"string","format":"date-time"},"ApiRemittancesIdDuesCollectionGetFirstGet200TextXmlResponse":{"type":"string","format":"date-time"},"FlatRemittanceDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/FlatRemittanceDTO"}},"ApiRemittancesExtendedExportGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiRemittancesExtendedExportGet204ApplicationOctet-streamResponse":{"type":"array"},"RepresentativeDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/RepresentativeDTO"}},"ApiRepresentativesExportGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiRepresentativesExportGet204ApplicationOctet-streamResponse":{"type":"array"},"MessageArray":{"type":"array","items":{"$ref":"#/components/schemas/Message"}},"ApiSaleDeliveryNotesIdLineLineIdDestinationdocumentscountGet200ApplicationJs":{"type":"integer","format":"int32"},"ApiSaleDeliveryNotesIdLineLineIdDestinationdocumentscountGet200TextJsonRespo":{"type":"integer","format":"int32"},"ApiSaleDeliveryNotesIdLineLineIdDestinationdocumentscountGet200TextHtmlRespo":{"type":"integer","format":"int32"},"ApiSaleDeliveryNotesIdLineLineIdDestinationdocumentscountGet200ApplicationVn":{"type":"integer","format":"int32"},"ApiSaleDeliveryNotesIdLineLineIdDestinationdocumentscountGet200ApplicationXm":{"type":"integer","format":"int32"},"ApiSaleDeliveryNotesIdLineLineIdDestinationdocumentscountGet200TextXmlRespon":{"type":"integer","format":"int32"},"FlatSaleDeliveryNoteDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/FlatSaleDeliveryNoteDTO"}},"ApiSaleDeliveryNotesExportGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiSaleDeliveryNotesExportGet204ApplicationOctet-streamResponse":{"type":"array"},"ApiSaleInvoicesAllowcustominvoicenumberGet200ApplicationJsonResponse":{"type":"boolean"},"ApiSaleInvoicesAllowcustominvoicenumberGet200TextJsonResponse":{"type":"boolean"},"ApiSaleInvoicesAllowcustominvoicenumberGet200TextHtmlResponse":{"type":"boolean"},"ApiSaleInvoicesAllowcustominvoicenumberGet200ApplicationVnd-wkes-jsonRespons":{"type":"boolean"},"ApiSaleInvoicesAllowcustominvoicenumberGet200ApplicationXmlResponse":{"type":"boolean"},"ApiSaleInvoicesAllowcustominvoicenumberGet200TextXmlResponse":{"type":"boolean"},"FlatSaleInvoiceDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/FlatSaleInvoiceDTO"}},"ApiSaleInvoicesExportGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiSaleInvoicesExportGet204ApplicationOctet-streamResponse":{"type":"array"},"ApiSaleInvoicesExtendedExportGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiSaleInvoicesExtendedExportGet204ApplicationOctet-streamResponse":{"type":"array"},"ApiSaleInvoicesIssuedInvoicesReportPost200ApplicationOctet-streamResponse":{"type":"array"},"ApiSaleOffersIdLineLineIdDestinationdocumentscountGet200ApplicationJsonRespo":{"type":"integer","format":"int32"},"ApiSaleOffersIdLineLineIdDestinationdocumentscountGet200TextJsonResponse":{"type":"integer","format":"int32"},"ApiSaleOffersIdLineLineIdDestinationdocumentscountGet200TextHtmlResponse":{"type":"integer","format":"int32"},"ApiSaleOffersIdLineLineIdDestinationdocumentscountGet200ApplicationVnd-wkes":{"type":"integer","format":"int32"},"ApiSaleOffersIdLineLineIdDestinationdocumentscountGet200ApplicationXmlRespon":{"type":"integer","format":"int32"},"ApiSaleOffersIdLineLineIdDestinationdocumentscountGet200TextXmlResponse":{"type":"integer","format":"int32"},"FlatSaleOfferDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/FlatSaleOfferDTO"}},"ApiSaleOffersExportGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiSaleOffersExportGet204ApplicationOctet-streamResponse":{"type":"array"},"ApiSaleOffersExtendedExportGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiSaleOffersExtendedExportGet204ApplicationOctet-streamResponse":{"type":"array"},"ApiSaleOperationTypesTaxTypeIsCompatibleGet200ApplicationJsonResponse":{"type":"boolean"},"ApiSaleOperationTypesTaxTypeIsCompatibleGet200TextJsonResponse":{"type":"boolean"},"ApiSaleOperationTypesTaxTypeIsCompatibleGet200TextHtmlResponse":{"type":"boolean"},"ApiSaleOperationTypesTaxTypeIsCompatibleGet200ApplicationVnd-wkes-jsonRespon":{"type":"boolean"},"ApiSaleOperationTypesTaxTypeIsCompatibleGet200ApplicationXmlResponse":{"type":"boolean"},"ApiSaleOperationTypesTaxTypeIsCompatibleGet200TextXmlResponse":{"type":"boolean"},"SaleOperationTypeDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/SaleOperationTypeDTO"}},"ApiSaleOrdersIdLineLineIdDestinationdocumentscountGet200ApplicationJsonRespo":{"type":"integer","format":"int32"},"ApiSaleOrdersIdLineLineIdDestinationdocumentscountGet200TextJsonResponse":{"type":"integer","format":"int32"},"ApiSaleOrdersIdLineLineIdDestinationdocumentscountGet200TextHtmlResponse":{"type":"integer","format":"int32"},"ApiSaleOrdersIdLineLineIdDestinationdocumentscountGet200ApplicationVnd-wkes":{"type":"integer","format":"int32"},"ApiSaleOrdersIdLineLineIdDestinationdocumentscountGet200ApplicationXmlRespon":{"type":"integer","format":"int32"},"ApiSaleOrdersIdLineLineIdDestinationdocumentscountGet200TextXmlResponse":{"type":"integer","format":"int32"},"FlatSaleOrderDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/FlatSaleOrderDTO"}},"ApiSaleOrdersExportGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiSaleOrdersExportGet204ApplicationOctet-streamResponse":{"type":"array"},"FlatSerieDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/FlatSerieDTO"}},"ApiSuppliersIdImageGet200ImageJpegResponse":{"type":"array"},"ApiSuppliersIdImageGet204ImageJpegResponse":{"type":"array"},"FlatSupplierDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/FlatSupplierDTO"}},"ApiSuppliersExportGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiSuppliersExportGet204ApplicationOctet-streamResponse":{"type":"array"},"ApiSupplyInvoicesIdAttachmentGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiSupplyInvoicesIdAttachmentGet204ApplicationOctet-streamResponse":{"type":"array"},"FlatSupplyInvoiceDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/FlatSupplyInvoiceDTO"}},"TagDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/TagDTO"}},"TaxRateDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/TaxRateDTO"}},"ApiTicketBaiIdSendResponseGet200ApplicationJsonResponse":{"type":"string"},"ApiTicketBaiIdSendResponseGet200TextJsonResponse":{"type":"string"},"ApiTicketBaiIdSendResponseGet200TextHtmlResponse":{"type":"string"},"ApiTicketBaiIdSendResponseGet200ApplicationVnd-wkes-jsonResponse":{"type":"string"},"ApiTicketBaiIdSendResponseGet200ApplicationXmlResponse":{"type":"string"},"ApiTicketBaiIdSendResponseGet200TextXmlResponse":{"type":"string"},"ApiTicketBaiIdSendResponseGet204ApplicationJsonResponse":{"type":"string"},"ApiTicketBaiIdSendResponseGet204TextJsonResponse":{"type":"string"},"ApiTicketBaiIdSendResponseGet204TextHtmlResponse":{"type":"string"},"ApiTicketBaiIdSendResponseGet204ApplicationVnd-wkes-jsonResponse":{"type":"string"},"ApiTicketBaiIdSendResponseGet204ApplicationXmlResponse":{"type":"string"},"ApiTicketBaiIdSendResponseGet204TextXmlResponse":{"type":"string"},"TicketBAIDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/TicketBAIDTO"}},"ApiTicketBaiExportGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiTicketBaiExportGet204ApplicationOctet-streamResponse":{"type":"array"},"ApiTicketsIdAttachmentGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiTicketsIdAttachmentGet204ApplicationOctet-streamResponse":{"type":"array"},"FlatTicketDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/FlatTicketDTO"}},"ApiTicketsExportGet200ApplicationOctet-streamResponse":{"type":"array"},"ApiTicketsExportGet204ApplicationOctet-streamResponse":{"type":"array"},"CompanyLicensingDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/CompanyLicensingDTO"}},"ApiTokenCheckTokenGet200ApplicationJsonResponse":{"type":"object"},"ApiTokenCheckTokenGet200TextJsonResponse":{"type":"object"},"ApiTokenCheckTokenGet200TextHtmlResponse":{"type":"object"},"ApiTokenCheckTokenGet200ApplicationVnd-wkes-jsonResponse":{"type":"object"},"ApiTokenCheckTokenGet200ApplicationXmlResponse":{"type":"object"},"ApiTokenCheckTokenGet200TextXmlResponse":{"type":"object"},"ApiTokenTenantsIdImageGet200ImageJpegResponse":{"type":"array"},"ApiTokenApplicationTokenPost200ApplicationJsonResponse":{"type":"string"},"ApiTokenApplicationTokenPost200TextJsonResponse":{"type":"string"},"ApiTokenApplicationTokenPost200TextHtmlResponse":{"type":"string"},"ApiTokenApplicationTokenPost200ApplicationVnd-wkes-jsonResponse":{"type":"string"},"ApiTokenApplicationTokenPost200ApplicationXmlResponse":{"type":"string"},"ApiTokenApplicationTokenPost200TextXmlResponse":{"type":"string"},"ApiUsersLogoutGet200ApplicationJsonResponse":{"type":"boolean"},"ApiUsersLogoutGet200TextJsonResponse":{"type":"boolean"},"ApiUsersLogoutGet200TextHtmlResponse":{"type":"boolean"},"ApiUsersLogoutGet200ApplicationVnd-wkes-jsonResponse":{"type":"boolean"},"ApiUsersLogoutGet200ApplicationXmlResponse":{"type":"boolean"},"ApiUsersLogoutGet200TextXmlResponse":{"type":"boolean"},"ApiWebhooksGet200ApplicationJsonResponse":{"type":"object"},"ApiWebhooksGet200TextJsonResponse":{"type":"object"},"ApiWebhooksGet200TextHtmlResponse":{"type":"object"},"ApiWebhooksGet200ApplicationVnd-wkes-jsonResponse":{"type":"object"},"ApiWebhooksGet200ApplicationXmlResponse":{"type":"object"},"ApiWebhooksGet200TextXmlResponse":{"type":"object"},"ApiWebhooksPost200ApplicationJsonResponse":{"type":"object"},"ApiWebhooksPost200TextJsonResponse":{"type":"object"},"ApiWebhooksPost200TextHtmlResponse":{"type":"object"},"ApiWebhooksPost200ApplicationVnd-wkes-jsonResponse":{"type":"object"},"ApiWebhooksPost200ApplicationXmlResponse":{"type":"object"},"ApiWebhooksPost200TextXmlResponse":{"type":"object"},"ApiWebhooksIdGet200ApplicationJsonResponse":{"type":"object"},"ApiWebhooksIdGet200TextJsonResponse":{"type":"object"},"ApiWebhooksIdGet200TextHtmlResponse":{"type":"object"},"ApiWebhooksIdGet200ApplicationVnd-wkes-jsonResponse":{"type":"object"},"ApiWebhooksIdGet200ApplicationXmlResponse":{"type":"object"},"ApiWebhooksIdGet200TextXmlResponse":{"type":"object"},"ApiWebhooksIdDelete200ApplicationJsonResponse":{"type":"object"},"ApiWebhooksIdDelete200TextJsonResponse":{"type":"object"},"ApiWebhooksIdDelete200TextHtmlResponse":{"type":"object"},"ApiWebhooksIdDelete200ApplicationVnd-wkes-jsonResponse":{"type":"object"},"ApiWebhooksIdDelete200ApplicationXmlResponse":{"type":"object"},"ApiWebhooksIdDelete200TextXmlResponse":{"type":"object"},"WithHoldingKeyDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/WithHoldingKeyDTO"}},"WithHoldingSubKeyDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/WithHoldingSubKeyDTO"}},"ZipCodeDTOArray":{"type":"array","items":{"$ref":"#/components/schemas/ZipCodeDTO"}}},"securitySchemes":{"apiKeyHeader":{"type":"apiKey","name":"Ocp-Apim-Subscription-Key","in":"header"}}},"security":[{"apiKeyHeader":[]}]},"markdown":null,"status":"publicado","published_at":"2023-06-22T23:42:54.000Z","created_at":"2023-06-22T23:38:29.000Z","updated_at":"2026-06-29T08:59:12.000Z","buttons":[{"id":9,"name":"Consulta la definición de la API","type":"secondary","order":0,"link":"https://wke-portal-pre.apimarket.io/apis/a3factura-services-api-2-0/swagger-ui","class":"secondary"}],"benefits":[],"tags":[],"image":[{"id":1,"name":"wk-api-a3factura.png","alternativeText":"","caption":"","width":593,"height":432,"formats":{"thumbnail":{"name":"thumbnail_wk-api-a3factura.png","hash":"thumbnail_wk_api_a3factura_7b8dad77be","ext":".png","mime":"image/png","width":214,"height":156,"size":15.53,"path":null,"url":"https://wke-portal.apimarket.io/assets/thumbnail_wk_api_a3factura_7b8dad77be.png"},"small":{"name":"small_wk-api-a3factura.png","hash":"small_wk_api_a3factura_7b8dad77be","ext":".png","mime":"image/png","width":500,"height":364,"size":65.43,"path":null,"url":"https://wke-portal.apimarket.io/assets/small_wk_api_a3factura_7b8dad77be.png"}},"hash":"wk_api_a3factura_7b8dad77be","ext":".png","mime":"image/png","size":71.75,"url":"https://wke-portal.apimarket.io/assets/wk_api_a3factura_7b8dad77be.png","previewUrl":null,"provider":"aws-s3-use-cdn","provider_metadata":null,"created_at":"2023-06-23T03:28:33.000Z","updated_at":"2023-06-23T03:28:36.000Z"}],"products":[]},{"id":5,"title":"API a3innuva Nómina","slug":"a3laboral-services-api","description":null,"color_status":null,"footerText":null,"version":null,"openDoc":{"openapi":"3.0.4","info":{"title":"API a3innuva Nómina","description":"API a3innuva Nómina","termsOfService":"https://a3developers.wolterskluwer.es/user/terms","contact":{"name":"Wolters Kluwer TAA a3developers","url":"https://a3developers.wolterskluwer.es","email":"a3developers@wolterskluwer.com"},"license":{"name":"Terms of Use","url":"https://a3developers.wolterskluwer.es/user/terms"},"version":"v2"},"servers":[{"url":"https://a3api.wolterskluwer.es/Laboral","description":"PRO"}],"paths":{"/api/companies/{companyCode}/employees/{employeeCode}/absenteeisms/{year}":{"get":{"tags":["Absenteeisms"],"summary":"List absenteeims by employee and year","description":"GET /api/companies/258/employees/000049/absenteeisms/2019<br />\nRequired User Permissions: IT y Absentismos","operationId":"EmployeeAbsenteeims_GetEmployeeAbsenteeismsForYear","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"year","in":"path","description":"Year","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee medical checkup information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Absenteeism"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Absenteeism"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/absenteeisms/detail/{absenteeismID}":{"get":{"tags":["Absenteeisms"],"summary":"Get absenteeim","description":"GET /api/companies/258/employees/000049/absenteeisms/detail/29FCD855-90FB-4511-89B2-18CA008C3CCA<br />\nRequired User Permissions: IT y Absentismos","operationId":"EmployeeAbsenteeims_GetEmployeeAbsenteeism","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"absenteeismID","in":"path","description":"absenteeism ID","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee absenteeism information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AbsenteeismDetail"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AbsenteeismDetail"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/absenteeisms/{year}/{month}":{"get":{"tags":["Absenteeisms"],"summary":"List absenteeisms by company, year and month","description":"\nRequired User Permissions: IT y Absentismos","operationId":"CompanyAbsenteeism_GetAbsenteeismsForMonthCompany","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"year","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"month","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/pageNumber"},{"name":"lastUpdate","in":"query","schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns a list of absenteeisms","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Absenteeism"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Absenteeism"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/workplaces/{workplacecode}/absenteeisms/{year}/{month}":{"get":{"tags":["Absenteeisms"],"summary":"List absenteeisms by workplace, year and month","description":"\nRequired User Permissions: IT y Absentismos","operationId":"CompanyAbsenteeism_GetAbsenteeismsForMonthWorkpalce","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"workplacecode","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"year","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"month","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/pageNumber"},{"name":"lastUpdate","in":"query","schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns a list of absenteeisms","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Absenteeism"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Absenteeism"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/absenteeisms/holidays/{absenteeismID}":{"get":{"tags":["Absenteeisms - Holidays"],"summary":"Get employee holidays absenteeism","description":"GET /api/companies/36511/employees/000002/absenteeisms/holidays/15CE7026-D602-474E-862D-895FD5463AAD<br />\nRequired User Permissions: IT y Absentismos","operationId":"HolidaysEntity_GetEmployeeHolidayInformation","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"absenteeismID","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee holidays absenteeisms","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolidaysEntityResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/HolidaysEntityResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["Absenteeisms - Holidays"],"summary":"Delete employee holiday absenteeism","description":"DELETE /api/companies/36511/employees/000002/absenteeisms/holidays/15CE7026-D602-474E-862D-895FD5463AAD<br />\nRequired User Permissions: IT y Absentismos","operationId":"HolidaysEntity_DeleteMethodDetail","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"absenteeismID","in":"path","description":"holidays absenteeismID","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"204":{"description":"Delete employee holidays absenteeism successfully","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/absenteeisms/holidays":{"get":{"tags":["Absenteeisms - Holidays"],"summary":"List employee holidays absenteeisms","description":"GET /api/companies/258/employees/000029/absenteeisms/holidays<br />\nRequired User Permissions: IT y Absentismos","operationId":"HolidaysEntity_GetEmployeeHolidays","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/orderBy"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee holidays","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolidaysCollectionItemResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/HolidaysCollectionItemResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["Absenteeisms - Holidays"],"summary":"Update employee holiday absenteeism","description":"PUT /api/companies/36511/employees/000002/absenteeisms/holidays/15CE7026-D602-474E-862D-895FD5463AAD<br />\nRequired User Permissions: IT y Absentismos","operationId":"HolidaysEntity_PutUnjustifiedAbsenteeism","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"Holidays absenteeismID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolidaysEntityResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/HolidaysEntityResource"}}},"required":true,"x-bodyName":"holidayResource"},"responses":{"200":{"description":"Update employee unjustified absenteeism","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolidaysEntityResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/HolidaysEntityResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["Absenteeisms - Holidays"],"summary":"Create employee holiday absenteeism","description":"\nRequired User Permissions: IT y Absentismos","operationId":"HolidaysEntity_PostMethodDetail","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolidaysEntityResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/HolidaysEntityResource"}}},"required":true,"x-bodyName":"holidaysResource"},"responses":{"200":{"description":"Insert employee holidays absenteeisms","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolidaysEntityResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/HolidaysEntityResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/absenteeisms/retributedpermissions/{year}/{month}":{"get":{"tags":["Absenteeisms - Retributed permissions"],"summary":"List retributed permissions by year and month","description":"GET /api/companies/36511/employees/000002/absenteeisms/retributedpermissions/2019/3<br />\nRequired User Permissions: IT y Absentismos","operationId":"EmployeeAbsenteeims_GetPaidLeaveIncidentsForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"year","in":"path","description":"year","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"month","in":"path","description":"numerical month","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee paid leave incidents for period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaidLeave"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PaidLeave"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/absenteeisms/retributedpermissions":{"post":{"tags":["Absenteeisms - Retributed permissions"],"summary":"Create retributed permission","description":"POST /api/companies/36511/employees/000002/absenteeisms/retributedpermissions<br />\nRequired User Permissions: IT y Absentismos","operationId":"EmployeeAbsenteeims_AddPaidLeaveForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"teh paid leave information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaidLeave"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PaidLeave"}}},"required":true,"x-bodyName":"paidLeave"},"responses":{"200":{"description":"Adds a paid leave incident for an employee","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaidLeave"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PaidLeave"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/absenteeisms/retributedpermissions/{absenteeismID}":{"put":{"tags":["Absenteeisms - Retributed permissions"],"summary":"Update retributed permission","description":"POST /api/companies/36511/employees/000002/absenteeisms/retributedpermissions/FA05E4E2-7E26-4339-9FD3-00CFAACEC7BE<br />","operationId":"EmployeeAbsenteeims_UpdatePaidLeaveForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"absenteeismID","in":"path","description":"the paid leave information to update","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"the paid leave information to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaidLeaveUpdate"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PaidLeaveUpdate"}}},"required":true,"x-bodyName":"paidLeave"},"responses":{"200":{"description":"Updates a paid leave incident for an employee","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaidLeaveUpdate"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PaidLeaveUpdate"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["Absenteeisms - Retributed permissions"],"summary":"Delete retributed permission","description":"DELETE /api/companies/36511/employees/000002/absenteeisms/retributedpermissions/29FCD855-90FB-4511-89B2-18CA008C3CCA<br />\nRequired User Permissions: IT y Absentismos","operationId":"EmployeeAbsenteeims_DeletePaidLeaveIncidentForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"absenteeismID","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns operation status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaidLeave"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PaidLeave"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/absenteeisms/retributed-permission-types":{"get":{"tags":["Absenteeisms - Retributed permissions"],"summary":"List retributed permision types","description":"GET /api/companies/36511/employees/000003/absenteeisms/retributed-permission-types<br />\nRequired User Permissions: IT y Absentismos","operationId":"EmployeeAbsenteeims_GetRetributedPermisionTypesForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee paid leave incidents for period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaidLeaveType"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PaidLeaveType"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/absenteeisms/strikes":{"get":{"tags":["Absenteeisms - Strikes"],"summary":"List strike absenteeisms","description":"Get a list of strike absenteeisms for a company and employee\r\nGet /api/companies/36511/employees/000002/absenteeisms/strikes<br />\nRequired User Permissions: IT y Absentismos","operationId":"EmployeeAbsenteeims_AbsenteeismsStrikeGetAll","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns operation status","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AbsenteeismStrikeGetModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AbsenteeismStrikeGetModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"The specified resource was not found. Probably missing some parameter in the url.","content":{"application/json":{},"application/xml":{}}},"429":{"description":"The server rejected the request because too many requests have been received for this subscription.","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["Absenteeisms - Strikes"],"summary":"Create strike absenteeism","description":"Create a new strike absenteeism for an employee\nRequired User Permissions: IT y Absentismos","operationId":"EmployeeAbsenteeims_AbsenteeismsStrikePost","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AbsenteeismStrikeCreateModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AbsenteeismStrikeCreateModel"}}},"required":true,"x-bodyName":"absenteeismStrikeCreateModel"},"responses":{"200":{"description":"A successful operation","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}}}},"201":{"description":"Resource id created","content":{"application/json":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"The specified resource was not found. Probably missing some parameter in the url.","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable Entity: In case the server was able to understand the content type, and the structure but some semantics (business rules) are not valid, then return a 422 Unprocessable entity. Return as part of the response body the validation errors.","content":{"application/json":{},"application/xml":{}}},"429":{"description":"The server rejected the request because too many requests have been received for this subscription.","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/absenteeisms/strikes/{absenteeismID}":{"get":{"tags":["Absenteeisms - Strikes"],"summary":"Get strike absenteeism","description":"Get strike's absenteeism detail by AbsenteeismId\r\nGet /api/companies/36511/employees/000002/absenteeisms/strikes/29FCD855-90FB-4511-89B2-18CA008C3CCA<br />\nRequired User Permissions: IT y Absentismos","operationId":"EmployeeAbsenteeims_AbsenteeismsStrikeGetById","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"absenteeismID","in":"path","description":"The unique identifier of an Absenteeism (GUID/UUID)","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns operation status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AbsenteeismStrikeGetModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AbsenteeismStrikeGetModel"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"The specified resource was not found. Probably missing some parameter in the url.","content":{"application/json":{},"application/xml":{}}},"429":{"description":"The server rejected the request because too many requests have been received for this subscription.","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["Absenteeisms - Strikes"],"summary":"Update strike absenteeism","description":"Update an existing employee strike absenteeism\nRequired User Permissions: IT y Absentismos","operationId":"EmployeeAbsenteeims_AbsenteeismsStrikePut","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"absenteeismID","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AbsenteeismStrikeCreateModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AbsenteeismStrikeCreateModel"}}},"required":true,"x-bodyName":"absenteeismStrikeCreateModel"},"responses":{"200":{"description":"Returns operation status","content":{"application/json":{"schema":{"type":"boolean"}},"application/xml":{"schema":{"type":"boolean"}}}},"204":{"description":"Resource updated (PUT) successfully. No content will be returned.","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"The specified resource was not found. Probably missing some parameter in the url.","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable Entity: In case the server was able to understand the content type, and the structure but some semantics (business rules) are not valid, then return a 422 Unprocessable entity. Return as part of the response body the validation errors.","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"429":{"description":"The server rejected the request because too many requests have been received for this subscription.","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["Absenteeisms - Strikes"],"summary":"Delete strike absenteeism","description":"DELETE /api/companies/36511/employees/000002/absenteeisms/strike/29FCD855-90FB-4511-89B2-18CA008C3CCA<br />\nRequired User Permissions: IT y Absentismos","operationId":"EmployeeAbsenteeims_DeleteStrikeForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"absenteeismID","in":"path","description":"Absenteeism ID","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"204":{"description":"NoContent","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/absenteeisms/unjustifieds/{unjustifiedAbsenteeismID}":{"get":{"tags":["Absenteeisms - Unjustified absenteeisms"],"summary":"Get unjustified absenteeism","description":"GET /api/companies/258/employees/000029/absenteeisms/unjustifieds/1a6a8c9e-78bf-48cb-a526-2b10c81fa983<br />\nRequired User Permissions: IT y Absentismos","operationId":"UnjustifiedAbsenteeismEntity_GetEmployeeUnjustifiedAbsenseInformation","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"unjustifiedAbsenteeismID","in":"path","description":"Absenteeism Id","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee unjustified absenteeism","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnjustifiedAbsenteeismEntityResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UnjustifiedAbsenteeismEntityResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["Absenteeisms - Unjustified absenteeisms"],"summary":"Update unjustified absenteeism","description":"PUT /api/companies/36511/employees/000002/absenteeisms/unjustifieds/15CE7026-D602-474E-862D-895FD5463AAD<br />\r\n{<br />\r\n   \"inputData\": \"<br />\r\n     {<br />\r\n         \"startDate\" : \"2019-04-01T10:00:00.000Z\", <br />\r\n         \"endDate\" : \"2019-04-01T10:00:00.000Z\", <br />\r\n         \"indLessThanOneDay\" : \"true\", <br />\r\n         \"durationHours\" : 0, <br />\r\n         \"durationMinuts\" : 0, <br />\r\n         \"indDiscountNaturalDays\" : \"false\", <br />\r\n         \"indDiscountRestsWeekly\" : \"false\" <br />\r\n     }\"<br />\r\n}<br />\nRequired User Permissions: IT y Absentismos","operationId":"UnjustifiedAbsenteeismEntity_PutUnjustifiedAbsenteeism","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"unjustifiedAbsenteeismID","in":"path","description":"Holiday ID","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"absenteeism unjustified resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnjustifiedAbsenteeismEntityResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UnjustifiedAbsenteeismEntityResource"}}},"required":true,"x-bodyName":"unjustifiedAbsenteeismResource"},"responses":{"200":{"description":"Update employee unjustified absenteeism","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnjustifiedAbsenteeismEntityResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UnjustifiedAbsenteeismEntityResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["Absenteeisms - Unjustified absenteeisms"],"summary":"Delete unjustified absenteeism","description":"DELETE /api/companies/36511/employees/000002/absenteeisms/unjustifieds/15CE7026-D602-474E-862D-895FD5463AAD<br />\nRequired User Permissions: IT y Absentismos","operationId":"UnjustifiedAbsenteeismEntity_DeleteMethodDetail","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"unjustifiedAbsenteeismID","in":"path","description":"unjustified absenteeismID","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"204":{"description":"Delete employee unjustified absenteeism successfully","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/absenteeisms/unjustifieds":{"get":{"tags":["Absenteeisms - Unjustified absenteeisms"],"summary":"List unjustified absenteeisms","description":"GET /api/companies/258/employees/000029/absenteeisms/unjustifieds<br />\nRequired User Permissions: IT y Absentismos","operationId":"UnjustifiedAbsenteeismCollection_GetEmployeeUnjustifiedAbsenses","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/orderBy"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee unjustified absenteeism","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnjustifiedAbsenteeismCollectionItemResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UnjustifiedAbsenteeismCollectionItemResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["Absenteeisms - Unjustified absenteeisms"],"summary":"Create unjustified absenteeism","description":"POST /api/companies/258/employees/000029/absenteeisms/unjustifieds<br />\r\n{<br />\r\n   \"inputData\": \"<br />\r\n     {<br />\r\n         \"startDate\" : \"2019-04-01T10:00:00.000Z\", <br />\r\n         \"endDate\" : \"2019-04-01T10:00:00.000Z\", <br />\r\n         \"indLessThanOneDay\" : \"true\", <br />\r\n         \"durationHours\" : 0, <br />\r\n         \"durationMinuts\" : 0, <br />\r\n         \"indDiscountNaturalDays\" : \"false\", <br />\r\n         \"indDiscountRestsWeekly\" : \"false\" <br />\r\n     }\"<br />\r\n}<br />\nRequired User Permissions: IT y Absentismos","operationId":"UnjustifiedAbsenteeismEntity_PostUnjustifiedAbsenteeism","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"absenteeism unjustified resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnjustifiedAbsenteeismEntityResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UnjustifiedAbsenteeismEntityResource"}}},"required":true,"x-bodyName":"unjustifiedAbsenteeismResource"},"responses":{"200":{"description":"Creates employee unjustified absenteeism","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnjustifiedAbsenteeismEntityResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UnjustifiedAbsenteeismEntityResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/absenteeisms/unpaidemploymentsuspensions":{"get":{"tags":["Absenteeisms - Unpaid employment suspensions"],"summary":"List unpaid employment suspensions","description":"Get a list of absenteeisms of the type unpaid employment suspensions for a company and employee\r\nGet /api/companies/36511/employees/000002/absenteeisms/unpaidemploymentsuspensions<br />\nRequired User Permissions: IT y Absentismos","operationId":"EmployeeAbsenteeims_AbsenteeismsUnpaidEmploymentSuspensionGetAll","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns operation status","content":{"application/json":{"schema":{"type":"boolean"}},"application/xml":{"schema":{"type":"boolean"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"The specified resource was not found. Probably missing some parameter in the url.","content":{"application/json":{},"application/xml":{}}},"429":{"description":"The server rejected the request because too many requests have been received for this subscription.","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["Absenteeisms - Unpaid employment suspensions"],"summary":"Create unpaid employment suspensions","description":"Create a new unpaid employment suspensions absenteeism for an employee\nRequired User Permissions: IT y Absentismos","operationId":"EmployeeAbsenteeims_AbsenteeismsUnpaidEmploymentSuspensionPost","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpaidEmploymentSuspensionAbsenteeismCreateModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UnpaidEmploymentSuspensionAbsenteeismCreateModel"}}},"required":true,"x-bodyName":"absenteeismCreateModel"},"responses":{"200":{"description":"Returns operation status","content":{"application/json":{"schema":{"type":"boolean"}},"application/xml":{"schema":{"type":"boolean"}}}},"201":{"description":"Returns object created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpaidEmploymentSuspensionAbsenteeismCreateModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UnpaidEmploymentSuspensionAbsenteeismCreateModel"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"The specified resource was not found. Probably missing some parameter in the url.","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable Entity: In case the server was able to understand the content type, and the structure but some semantics (business rules) are not valid, then return a 422 Unprocessable entity. Return as part of the response body the validation errors.","content":{"application/json":{},"application/xml":{}}},"429":{"description":"The server rejected the request because too many requests have been received for this subscription.","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/absenteeisms/unpaidemploymentsuspensions/{absenteeismID}":{"get":{"tags":["Absenteeisms - Unpaid employment suspensions"],"summary":"Get unpaid employment suspension","description":"Get unpaid employment suspensions's absenteeism detail by AbsenteeismId\r\nGet /api/companies/36511/employees/000002/absenteeisms/unpaidemploymentsuspensions/29FCD855-90FB-4511-89B2-18CA008C3CCA<br />\nRequired User Permissions: IT y Absentismos","operationId":"EmployeeAbsenteeims_AbsenteeismsUnpaidEmploymentSuspensionGetById","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"absenteeismID","in":"path","description":"The unique identifier of an Absenteeism (GUID/UUID)","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns operation status","content":{"application/json":{"schema":{"type":"boolean"}},"application/xml":{"schema":{"type":"boolean"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"The specified resource was not found. Probably missing some parameter in the url.","content":{"application/json":{},"application/xml":{}}},"429":{"description":"The server rejected the request because too many requests have been received for this subscription.","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["Absenteeisms - Unpaid employment suspensions"],"summary":"Update unpaid employment suspension","description":"Update an existing employee unpaid employment suspensions absenteeism\nRequired User Permissions: IT y Absentismos","operationId":"EmployeeAbsenteeims_AbsenteeismsUnpaidEmploymentSuspensionPut","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"absenteeismID","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpaidEmploymentSuspensionAbsenteeismCreateModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UnpaidEmploymentSuspensionAbsenteeismCreateModel"}}},"required":true,"x-bodyName":"absenteeismUnpaidEmploymentSuspensionCreateModel"},"responses":{"200":{"description":"Returns operation status","content":{"application/json":{"schema":{"type":"boolean"}},"application/xml":{"schema":{"type":"boolean"}}}},"204":{"description":"Resource updated (PUT) successfully. No content will be returned.","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"The specified resource was not found. Probably missing some parameter in the url.","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable Entity: In case the server was able to understand the content type, and the structure but some semantics (business rules) are not valid, then return a 422 Unprocessable entity. Return as part of the response body the validation errors.","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"429":{"description":"The server rejected the request because too many requests have been received for this subscription.","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["Absenteeisms - Unpaid employment suspensions"],"summary":"Delete unpaid employment suspension","description":"DELETE /api/companies/36511/employees/000002/absenteeisms/unpaidemploymentsusupensions/29FCD855-90FB-4511-89B2-18CA008C3CCA<br />\nRequired User Permissions: IT y Absentismos","operationId":"EmployeeAbsenteeims_DeleteUnpaidEmploymentSuspensionForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"absenteeismID","in":"path","description":"Absenteeism ID","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns operation status","content":{"application/json":{"schema":{"type":"boolean"}},"application/xml":{"schema":{"type":"boolean"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/accountinglinks/withoutbreakdowns/{processID}":{"get":{"tags":["Acccounting link"],"summary":"Get accounting link document","description":"GET /api/companies/11902/accountinglinks/withoutbreakdowns/7DAF3115-6721-45E0-B3F9-C555C09469A5<br />\nRequired User Permissions: Enlace Contable","operationId":"WithoutBreakdowns_GetAccountingLink","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"processID","in":"path","description":"Process id","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns accounting link without breakdowns document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithoutBreakdownsGetOutputEntityResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/WithoutBreakdownsGetOutputEntityResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/accountinglinks/withoutbreakdowns":{"post":{"tags":["Acccounting link"],"summary":"Create accounting link document","description":"POST /api/companies/11902/accountinglinks/withoutbreakdowns<br />\r\n{<br />\r\n   \"inputData\": \"<br />\r\n     {<br />    \r\n        \"accountingCompanyCode\":\"1234\"<br />\r\n        \"payTypeID\":\"Extra\"<br />\r\n        \"payDate\":\"2019-04-01T10:00:00.000Z\"<br />\r\n         \"includeExtraPay\": \"true\",<br />\r\n         \"includeArrearOrDifferences\": \"false\"<br />        \r\n     }\"<br />\r\n}<br />\nRequired User Permissions: Enlace Contable","operationId":"WithoutBreakdowns_PostAccountingLink","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithoutBreakdownsPostInputEntityResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/WithoutBreakdownsPostInputEntityResource"}}},"required":true,"x-bodyName":"withoutBreakdownsPostInputEntityResource"},"responses":{"200":{"description":"Generate AccountingLink","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithoutBreakdownsPostOutputEntityResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/WithoutBreakdownsPostOutputEntityResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/accountinglinks/withoutbreakdowns/mon/{monitorID}":{"get":{"tags":["Acccounting link"],"summary":"Get status monitor","description":"GET /api/companies/72/accountinglinks/withoutbreakdowns/mon/0E438270-A125-42F6-B594-C561616E3497<br />\nRequired User Permissions: Enlace Contable","operationId":"WithoutBreakdowns_Check_Monitor","parameters":[{"name":"monitorID","in":"path","description":"Monitor identificer","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}}}},"201":{"description":"The specified monitorID provided has finished","content":{"application/json":{},"application/xml":{}}},"202":{"description":"The specified monitorID provided is in process","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"404":{"description":"The specified monitorID provided doesn't exists","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["Acccounting link"],"summary":"Cancel status monitor","description":"DELETE /api/companies/72/accountinglinks/withoutbreakdowns/mon/0E438270-A125-42F6-B594-C561616E3497<br />\nRequired User Permissions: Enlace Contable","operationId":"WithoutBreakdowns_Cancel_Monitor","parameters":[{"name":"monitorID","in":"path","description":"Monitor identificer","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}}}},"204":{"description":"The specified monitorID was canceled successfully","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/accounting-link-groups":{"get":{"tags":["Acccounting link"],"summary":"List accounting link groups","description":"\nRequired User Permissions: Ficha de Empresa / Contabilización","operationId":"CompanyAccounting_GetAccountingLinkGroupsForCompany","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns accounting link groups for company","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccountingLinkGroupResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccountingLinkGroupResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/accounting-link-group":{"put":{"tags":["Acccounting link"],"summary":"Update accounting link group","description":"\nRequired User Permissions: Ficha de Empresa / Contabilización","operationId":"CompanyAccounting_PutAccountingLinkGroupForCompany","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"accounting link group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleBodyFieldIdGuid"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SingleBodyFieldIdGuid"}}},"required":true,"x-bodyName":"accountingLinkGroup"},"responses":{"200":{"description":"set accounting link for company","content":{"application/json":{"schema":{"type":"boolean"}},"application/xml":{"schema":{"type":"boolean"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/agreements/{agreementcode}":{"get":{"tags":["Agreements"],"summary":"Get agreement","description":"\nRequired User Permissions: Ficha de Convenio","operationId":"Agreements_GetAgreement","parameters":[{"name":"agreementcode","in":"path","description":"agreement code","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns list of Holiday Dates","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgreementModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AgreementModel"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/agreements/{agreementcode}/extrapaygroups":{"get":{"tags":["Agreements"],"summary":"List extra payments for agreement","description":"\nRequired User Permissions: Ficha de Convenio","operationId":"Agreements_GetAgreementsExtraPays","parameters":[{"name":"agreementcode","in":"path","description":"agreement code","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns list of extra pay groups","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PayGroupModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PayGroupModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/agreements/{agreementcode}/classifications":{"get":{"tags":["Agreements"],"summary":"List agreement classifications","description":"\nRequired User Permissions: Ficha de Empresa / Convenios y Pactos","operationId":"Organisation_GetAgreementClassificationsForCompanyAgreement","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"agreementcode","in":"path","description":"agreement code","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns classification for company and agreement specified","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AgreementClassificationModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AgreementClassificationModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/agreements/{agreementcode}/retributed-permission-types":{"get":{"tags":["Agreements"],"summary":"List retributed permision types by Company and agreement","operationId":"Organisation_GetRetributedPermissionTypesForCompanyAgreement","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"agreementcode","in":"path","description":"agreement code","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns Retributed Permission Types for company and agreement specified","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AgreementRetributedPermissionTypeModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AgreementRetributedPermissionTypeModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/agreements/{agreementCode}/holidays":{"get":{"tags":["Agreements"],"summary":"List agreement holidays","description":"GET /api/countries<br />\nRequired User Permissions: Ficha de Empresa / Convenios y Pactos","operationId":"Agreements_GetAgreementsHolyDates","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/companyCode"},{"name":"agreementCode","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns list of Holiday Dates","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HolyDatesModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HolyDatesModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/agreements":{"get":{"tags":["Agreements"],"summary":"List of agreements for a company","description":"\nRequired User Permissions: Ficha de Empresa / Convenios y Pactos","operationId":"CompanyAgreements_GetAgreementsForCompany","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns list of agreements","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AgreementLookupResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AgreementLookupResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/agreements/{agreementCode}/{revision}/senioritygroups":{"get":{"tags":["Agreements"],"summary":"List seniority groups for agreement","description":"\nRequired User Permissions: Ficha de Empresa / Convenios y Pactos","operationId":"CompanyAgreements_GetAgreementSeniorityGroupsForCompany","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"agreementCode","in":"path","description":"agreement code","required":true,"schema":{"type":"string"}},{"name":"revision","in":"path","description":"agreement revision","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns list of agreements","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AgreementSeniorityGroupLookupResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AgreementSeniorityGroupLookupResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/agreements/{agreementCode}/{revision}/senioritygroups/{groupId}":{"get":{"tags":["Agreements"],"summary":"Get seniority group","description":"\nRequired User Permissions: Ficha de Empresa / Convenios y Pactos","operationId":"CompanyAgreements_GetAgreementSeniorityGroupForCompany","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"agreementCode","in":"path","description":"agreement code","required":true,"schema":{"type":"string"}},{"name":"revision","in":"path","description":"agreement revision","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"groupId","in":"path","description":"seniority group id","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns list of agreements","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AgreementSeniorityGroupResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AgreementSeniorityGroupResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/agreements/{agreementCode}/{revision}/itcomplements":{"get":{"tags":["Agreements"],"summary":"List IT complements for agreement","description":"\nRequired User Permissions: Ficha de Empresa / Convenios y Pactos","operationId":"CompanyAgreements_GetITComplementsForCompany","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"agreementCode","in":"path","description":"agreement code","required":true,"schema":{"type":"string"}},{"name":"revision","in":"path","description":"agreement revision","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns list of agreements","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AgreementITComplementResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AgreementITComplementResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/agreement/{agreementid}/classification/{classificationID}":{"get":{"tags":["Agreements"],"summary":"Get agreement classification","description":"GET /api/companies/1361/agreement/29FCD855-90FB-4511-89B2-18CA008C3CCA/classification/7DAF3115-6721-45E0-B3F9-C555C09469A5<br />\nRequired User Permissions: Ficha de Empresa / Convenios y Pactos","operationId":"ClassificationEntity_GetCompanyAgreementClassificationInformation","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"agreementid","in":"path","description":"agreement id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"classificationID","in":"path","description":"Classification ID","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee agreement","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassificationEntityResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ClassificationEntityResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/calendars/day-types":{"get":{"tags":["Calendars"],"summary":"List calendar day types","operationId":"Calendar_GetCalendarDayTypes","parameters":[{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns Calendar Day types","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CalendarDayTypeModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CalendarDayTypeModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/calendars/work-day-types":{"get":{"tags":["Calendars"],"summary":"List calendar workday types","operationId":"Calendar_GetCalendarWorkDayTypes","parameters":[{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns Calendar Work Day types","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CalendarWorkDayTypeModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CalendarWorkDayTypeModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/workplaces/{companyworkplacecode}/calendars/{year}":{"get":{"tags":["Calendars"],"summary":"Get company workplace calendar","description":"\nRequired User Permissions: Ficha de Empresa / Centros de Trabajo","operationId":"Calendar_GetCompanyWorkplaceCalendar","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/companyCode"},{"name":"companyworkplacecode","in":"path","description":"optional workplace Id filter","required":true,"schema":{"type":"string"}},{"name":"year","in":"path","description":"Year","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns company calendar for specified worklace code (Mandatory)","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CompanyWorkplaceCalendarModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CompanyWorkplaceCalendarModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/calendar/{year}/{month}":{"get":{"tags":["Calendars"],"summary":"Get employee calendar","description":"GET /api/companies/258/employees/000049/calendar/2021/4<br />\nRequired User Permissions: Ficha de Persona / Jornada laboral","operationId":"EmployeesLaboral_GetEmployeeCalendar","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"year","in":"path","description":"Year to return","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"month","in":"path","description":"Month to return","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee calendar","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarDay"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CalendarDay"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["Calendars"],"summary":"Update employee calendar","description":"Put /api/companies/258/employees/000049/calendar/2021/4<br />\nRequired User Permissions: Ficha de Persona / Jornada laboral","operationId":"EmployeesLaboral_PutEmployeeCalendar","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"year","in":"path","description":"Year to return","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"month","in":"path","description":"Month to return","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"Calendar days to be set for the month specified","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CalendarDay"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CalendarDay"}}}},"required":true,"x-bodyName":"calendarDays"},"responses":{"200":{"description":"OK","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/calendar":{"get":{"tags":["Calendars"],"summary":"Get employee calendar workday percentage","description":"GET /api/companies/258/employees/000049/calendar<br />\nRequired User Permissions: Ficha de Persona / Jornada laboral","operationId":"EmployeesLaboral_GetEmployeeCalendarWorkdayPercentage","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee calendar workday percentage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarWorkDayPercentage"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CalendarWorkDayPercentage"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/calendar/{year}/{month}/inactivity-days":{"post":{"tags":["Calendars"],"summary":"Update employee inactivity days","description":"Put /api/companies/258/employees/000049/calendar/2021/4/inactivity-days<br />\nRequired User Permissions: Ficha de Persona / Jornada laboral","operationId":"EmployeesLaboral_PutEmployeeInactivityDays","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"year","in":"path","description":"Year to return","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"month","in":"path","description":"Month to return","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"Calendar days to be set for the month specified","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InactivityDay"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InactivityDay"}}}},"required":true,"x-bodyName":"inactivityDays"},"responses":{"200":{"description":"OK","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/calendar/Format304":{"post":{"tags":["Calendars"],"summary":"Put format 304 calendar config for employee","description":"Put /api/companies/258/employees/000049/calendar/Format304<br />\nRequired User Permissions: Ficha de Persona / Jornada laboral","operationId":"EmployeesLaboral_PutFormat304","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Format304CalendarModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Format304CalendarModel"}}},"required":true,"x-bodyName":"calendarFormat"},"responses":{"200":{"description":"OK","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/occupation-codes":{"get":{"tags":["Common data"],"summary":"List occupation codes","description":"\nRequired User Permissions: Ficha de Empresa / Cotización","operationId":"Organisation_GetOcupationPercetntages","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns job positions available in company specified","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OccupationPercentageModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OccupationPercentageModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/payment-frequencies":{"get":{"tags":["Common data"],"summary":"List payment frequencies","description":"\nRequired User Permissions: Ficha de Empresa / Características","operationId":"Organisation_GetPaymentFrequencies","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns classification for company and agreement specified","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PaymentFrequenciesModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PaymentFrequenciesModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/addresstypeids":{"get":{"tags":["Common data"],"summary":"List address types","operationId":"DataLists_GetAddressTypeIDs","parameters":[{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns list of address types","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AddressTypeResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AddressTypeResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/sextypes":{"get":{"tags":["Common data"],"summary":"List gender types","operationId":"DataLists_GetSexTypes","parameters":[{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns list of Gender types","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SexTypeResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SexTypeResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/persontypes":{"get":{"tags":["Common data"],"summary":"List person types","operationId":"DataLists_GetPersonTypes","parameters":[{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns list of person types","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PersonTypeResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PersonTypeResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/municipalities":{"get":{"tags":["Common data - Countries"],"summary":"List municipalities","operationId":"DataLists_GetMunicipalitites","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns list of municipalities","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Municipality"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Municipality"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/countries/{isocountryid}/Regions":{"get":{"tags":["Common data - Countries"],"summary":"List regions","description":"GET /api/countries/{isocountryid}/Regions<br />","operationId":"RegionsCollection_GetRegions","parameters":[{"name":"isocountryid","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/orderBy"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns list of Regions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegionCollectionResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RegionCollectionResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/countries/{isocountryid}/postalcodes":{"get":{"tags":["Common data - Countries"],"summary":"List postalcodes","description":"GET /api/countries/{isocountryid}/postalcodes<br />","operationId":"PostalCodesCollection_GetPostalCodes","parameters":[{"name":"isocountryid","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/orderBy"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns list of postalcodes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostalCodeCollectionResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PostalCodeCollectionResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/countries":{"get":{"tags":["Common data - Countries"],"summary":"List countries","description":"GET /api/countries<br />","operationId":"CountriesCollection_GetCountries","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/orderBy"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns list of countries","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountriesCollectionResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CountriesCollectionResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/perceptiontypecodes":{"get":{"tags":["Common data - Laboral"],"summary":"List perception type codes","operationId":"DataLists_GetPerceptionTypeCodes","parameters":[{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returnsperception type codes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyValuePairStringString"}},"application/xml":{"schema":{"$ref":"#/components/schemas/KeyValuePairStringString"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/jobTitlesDescription":{"get":{"tags":["Common data - Laboral"],"summary":"Get job title","operationId":"DataLists_GetJobTitlesDescriptions","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns job positions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JobTitleDescriptionItem"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JobTitleDescriptionItem"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/jobTitles":{"get":{"tags":["Common data - Laboral"],"summary":"List of Job Titles","operationId":"DataLists_GetJobTitles","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns job positions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JobTitle"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JobTitle"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/jobPositions":{"get":{"tags":["Common data - Laboral"],"summary":"List job positions","operationId":"DataLists_GetJobPositions","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns job positions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JobPosition"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JobPosition"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/paytypes":{"get":{"tags":["Common data - Laboral"],"summary":"List pay types","operationId":"DataLists_GetPayTypes","parameters":[{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Paytype id's","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyValuePairInt32String"}},"application/xml":{"schema":{"$ref":"#/components/schemas/KeyValuePairInt32String"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/educationlevels":{"get":{"tags":["Common data - Laboral"],"summary":"List education levels","operationId":"DataLists_GetEducationLevels","parameters":[{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returnsperception type codes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyValuePairInt32String"}},"application/xml":{"schema":{"$ref":"#/components/schemas/KeyValuePairInt32String"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/cnooccupations":{"get":{"tags":["Common data - Laboral"],"summary":"List of CNO Occupation codes","operationId":"DataLists_GetCnoOccupations","parameters":[{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns cno occupations","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Occupation"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Occupation"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/specialcontracts":{"get":{"tags":["Common data - Laboral"],"summary":"List Special contracts affiliation data","operationId":"DataLists_GetSpecialContracts","parameters":[{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns special contracts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SpecialContract"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SpecialContract"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/collectivetypes":{"get":{"tags":["Common data - Laboral"],"summary":"List Collective types affiliation data","operationId":"DataLists_GetCollectiveTypes","parameters":[{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns collective types","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CollectiveType"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CollectiveType"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/contracttypes":{"get":{"tags":["Common data - Laboral"],"summary":"List contract types","operationId":"DataLists_GetContractTypes","parameters":[{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns perception type codes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContractType"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContractType"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/jobpositiondropcauses":{"get":{"tags":["Common data - Laboral"],"summary":"List job position drop causes","operationId":"DataLists_GetJobEndCuases","parameters":[{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Return job position drop causes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobPositionDropCause"}},"application/xml":{"schema":{"$ref":"#/components/schemas/JobPositionDropCause"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/hiringdatesdropcauses":{"get":{"tags":["Common data - Laboral"],"summary":"List drop causes","operationId":"DataLists_GetDropCuases","parameters":[{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Return drop causes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/KeyValuePairInt32String"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/KeyValuePairInt32String"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/testdaytypes":{"get":{"tags":["Common data - Laboral"],"summary":"List test days types","operationId":"DataLists_GetTestDayTypesCodes","parameters":[{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns perception type codes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyValuePairInt32String"}},"application/xml":{"schema":{"$ref":"#/components/schemas/KeyValuePairInt32String"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/dismissaltypes":{"get":{"tags":["Common data - Laboral"],"summary":"List laboral dismissal types","operationId":"DataLists_GetLaboralDismissalTypes","parameters":[{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns list of dismissal types","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DismissalTypeResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DismissalTypeResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/perceptionSubTypes":{"get":{"tags":["Common data - Laboral"],"summary":"List perception subtype codes","operationId":"DataLists_GetPerceptionTypesTypes","parameters":[{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns list of dismissal types","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PerceptionSubkeyResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PerceptionSubkeyResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/contribution-types":{"get":{"tags":["Common data - Laboral"],"summary":"List contribution types","operationId":"DataLists_GetContributionTypes","parameters":[{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns list of contribution types","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContributionTypeResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContributionTypeResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/identificationtypes":{"get":{"tags":["Common data - Laboral"],"summary":"List identification types","operationId":"DataLists_GetIdentificationTypes","parameters":[{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns list of identification types","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdentificationTypeResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdentificationTypeResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/conceptcollectiontypes":{"get":{"tags":["Common data - Laboral"],"summary":"List concept collection types","operationId":"PayInfo_GetConceptCollectionTypes","parameters":[{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns concept collection types","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConceptCollectionType"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConceptCollectionType"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/paytypegroups":{"get":{"tags":["Common data - Laboral"],"summary":"List pay type groups","operationId":"PayInfo_GetPayTypeGroups","parameters":[{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns Pay Type Grouping Names","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}},"application/xml":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/paytypegroups/{paygroupid}":{"get":{"tags":["Common data - Laboral"],"summary":"Get pay type group","operationId":"PayInfo_GetPayTypeGroup","parameters":[{"name":"paygroupid","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns Pay Type Groups","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PayTypeGroup"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PayTypeGroup"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/medicalcheckupstates":{"get":{"tags":["Common data - Medical"],"summary":"List of medical checkup states","operationId":"DataLists_GetMedicalCheckupStates","parameters":[{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns list of medical checkup states","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MedicalCheckupStateResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MedicalCheckupStateResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/medicalcheckuptypes":{"get":{"tags":["Common data - Medical"],"summary":"List of medical checkup types","operationId":"DataLists_GetMedicalCheckupTypes","parameters":[{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns list of medical checkup types","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MedicalCheckupTypeResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MedicalCheckupTypeResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/regimes":{"get":{"tags":["Companies"],"summary":"List regimes for company","description":"\nRequired User Permissions: Ficha de Empresa / Cotización","operationId":"Organisation_GetAvailableRegimesForCompany","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns job positions available in company specified","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RegimeModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RegimeModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/regimes/{regimeid}/tariff-groups":{"get":{"tags":["Companies"],"summary":"List tariff groups for regime","description":"\nRequired User Permissions: Ficha de Empresa / Cotización","operationId":"Organisation_GetAvailableTariffGroupsForRegime","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"regimeid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns job positions available in company specified","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TariffGroupModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TariffGroupModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/organigram":{"get":{"tags":["Companies"],"summary":"Get organigram for company","description":"\nRequired User Permissions: Organigramas","operationId":"Organisation_GetCompanyOrganigramByCompanyCode","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns organigram for company","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganigramNodeResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OrganigramNodeResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies":{"get":{"tags":["Companies"],"summary":"List companies","description":"GET /api/companies<br />\r\n{<br />\r\n   \"filter\": \"companyCode eq 1 and (dropDate eq null or dropDate ge 2001-02-28)\",<br />\r\n   \"orderBy\": \"companyCode asc\"<br />\r\n   \"pageNumber\": 1,<br />\r\n   \"pageSize\": 25,<br />\r\n}<br />\nRequired User Permissions: Relación de Empresas","operationId":"CompaniesCollection_GetCollectionCompanies","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/orderBy"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns companies data","headers":{"x-pagination":{"description":"Collection pagination","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CompaniesCollectionResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CompaniesCollectionResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/concepts":{"get":{"tags":["Companies"],"summary":"List company concepts","description":"\nRequired User Permissions: Ficha de Empresa / Conceptos","operationId":"PayInfo_GetCompanyConcepts","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns Pay Concepts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CompanyConcept"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CompanyConcept"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/concepts/excludedconceptgroups/{groupId}":{"get":{"tags":["Companies"],"summary":"Get company excluded concept group","description":"\nRequired User Permissions: Ficha de Empresa / Conceptos","operationId":"PayInfo_GetCompanyExcluedConcepts","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/companyCode"},{"name":"groupId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns Pay Concepts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CompanyConcept"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CompanyConcept"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/concepts/excludedconceptgroups":{"get":{"tags":["Companies"],"summary":"List company excluded concept groups","description":"\nRequired User Permissions: Ficha de Empresa / Conceptos","operationId":"PayInfo_GetCompanyExcludedConceptGroups","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns Excluded Pay Concept Groups","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExcludedConceptGroup"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExcludedConceptGroup"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/clauses":{"get":{"tags":["Companies"],"summary":"Get a list of clauses for a company","description":"\nRequired User Permissions: Ficha de Empresa / Características","operationId":"CompanyAgreements_GetClausesForCompany","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns list of clauses","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ClauseResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ClauseResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/costcenters":{"get":{"tags":["Cost centers"],"summary":"Get costcenter tree for company","description":"GET /api/companies/1361/costcenters<br />\nRequired User Permissions: Ficha de Empresa / Imputación","operationId":"CostCenter_GetCostCenterTree","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns costcenters for company","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostCenterTreeResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CostCenterTreeResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/costcentersraw":{"get":{"tags":["Cost centers"],"summary":"Get raw costcenter tree for company","description":"GET /api/companies/1361/costcentersRaw?pageSize=50&amp;pageNumber=1&amp;level=1<br />\nRequired User Permissions: Ficha de Empresa / Imputación","operationId":"CostCenter_GetCostCenterTreeRaw","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"level","in":"query","description":"(optional) Level of the costcenters to filter","schema":{"type":"integer","format":"int32"}},{"name":"parentId","in":"query","description":"(optional) Parent id of the costcenters to filter","schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns costcenters for company","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CostCenterNode"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CostCenterNode"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/attribution":{"get":{"tags":["Cost centers"],"summary":"Get employee cost attribution data","description":"GET /api/companies/258/employees/000049/attribution<br />\nRequired User Permissions: Ficha de Persona / Imputación","operationId":"EmployeesAttribution_GetEmployeeAttribution","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee attribution","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AttrResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AttrResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["Cost centers"],"summary":"Put employees attribution data","description":"PUT /api/companies/258/employees/000049/attribution<br />\nRequired User Permissions: Ficha de Persona / Imputación","operationId":"EmployeesAttribution_PutEmployeeAttribution","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"Array of cost attribution percentages","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AttrResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AttrResource"}}}},"required":true,"x-bodyName":"costAttributions"},"responses":{"200":{"description":"Operation success","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/pays/{payid}/costattribution":{"get":{"tags":["Cost centers"],"summary":"Get pay cost attribution data","description":"\nRequired User Permissions: Histórico de Cobro / Imputación","operationId":"PayInfo_GetEmployeePayCostAttribution","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"payid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employe pay cost attribution","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeePayCostAttribution"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeePayCostAttribution"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/variablecostattributions":{"post":{"tags":["Cost centers"],"summary":"Create variable cost attribution","description":"Create variable cost attribution for employee\nRequired User Permissions: Conceptos Variables","operationId":"EmployeesVariableCostAttributions_PostVariableCostAttributionsForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"cost attribution model","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostAttributionModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CostAttributionModel"}}},"required":true,"x-bodyName":"costAttributionModel"},"responses":{"201":{"description":"Returns operation status","content":{"application/json":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Item not found","content":{"application/json":{},"application/xml":{}}},"422":{"description":"Unprocessable Entity: In case the server was able to understand the content type, and the structure but some semantics (business rules) are not valid, then return a 422 Unprocessable entity. Return as part of the response body the validation errors.","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"429":{"description":"The server rejected the request because too many requests have been received for this subscription.","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/customdata":{"get":{"tags":["Custom data"],"summary":"List employee custom data templates","description":"GET /api/companies/258/employees/000049/customdata<br />\r\n{<br />\r\n   \"pageNumber\": 1,<br />\r\n   \"pageSize\": 25,<br />\r\n   \"orderBy\": \"templateCode desc\"<br />\r\n}<br />\nRequired User Permissions: Ficha de Persona / Datos Ampliación","operationId":"EmployeesCustomDataTemplatesCollection_GetEmployeeCustomDataTemplates","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/orderBy"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee custom data templates","headers":{"x-pagination":{"description":"Collection pagination","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomDataTemplateDTO"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CustomDataTemplateDTO"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/customdata/{templatecode}":{"get":{"tags":["Custom data"],"summary":"Get employee custom data by templatecode","description":"GET /api/companies/258/employees/000049/customdata/1<br />\nRequired User Permissions: Ficha de Persona / Datos Ampliación","operationId":"EmployeesCustomData_GetCustomData","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"templatecode","in":"path","description":"Template code","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee custom data template values","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}},"application/xml":{"schema":{"type":"array","items":{"type":"object"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"No information found for given paramerers","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/customdata/{templatecode}/historical/{date}":{"get":{"tags":["Custom data"],"summary":"Get employee historical custom data template values","description":"GET /api/companies/258/employees/000049/customdata/1/historical/2023-01-01<br />\nRequired User Permissions: Ficha de Persona / Datos Ampliación","operationId":"EmployeesCustomData_GetCustomHistoricalData","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"templatecode","in":"path","description":"Template code","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"date","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee custom data template values","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}},"application/xml":{"schema":{"type":"array","items":{"type":"object"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"No information found for given paramerers","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/personalisation/maintenence-groups":{"get":{"tags":["Custom data"],"summary":"List maintenence groups","description":"\nRequired User Permissions: Ampliación","operationId":"Template_GetMaintenenceGroups","parameters":[{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns groups","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MaintenanceGroupModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MaintenanceGroupModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/personalisation/maintenance-groups/{groupId}/templates":{"get":{"tags":["Custom data"],"summary":"List templates for maintenance group","description":"\nRequired User Permissions: Ampliación","operationId":"Template_GetTemplates","parameters":[{"name":"groupId","in":"path","description":"Maintenance group id","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns templates for group","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/personalisation/maintenance-groups/{groupId}/templates/{template}/fields":{"get":{"tags":["Custom data"],"summary":"List template fields definitions","description":"\nRequired User Permissions: Ampliación","operationId":"Template_GetTemplateFieldDefinitionsName","parameters":[{"name":"groupId","in":"path","description":"Maintenance group id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"template","in":"path","description":"Tempalte id or name to view","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns field definitions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateFieldDefinitionModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateFieldDefinitionModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/personalisation/maintenance-groups/{groupid}/templates/{template}/fields/{element}/values":{"get":{"tags":["Custom data"],"summary":"List available values for template element","description":"\nRequired User Permissions: Ampliación","operationId":"Template_GetTemplatePossibleValues","parameters":[{"name":"template","in":"path","description":"template code","required":true,"schema":{"type":"string"}},{"name":"element","in":"path","description":"element code","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"name":"groupid","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns Possible values for element","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateListValues"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateListValues"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/customdata/{template}/{element}":{"get":{"tags":["Custom data"],"summary":"Get value stored in an element for an employee","description":"\nRequired User Permissions: Ficha de Persona / Datos Ampliación","operationId":"Template_GetTemplateElementValueEmp","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"template","in":"path","description":"The template name","required":true,"schema":{"type":"string"}},{"name":"element","in":"path","description":"The element name","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns values","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateFieldDefinitionModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateFieldDefinitionModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["Custom data"],"summary":"Update a value of an element for an employee","description":"\nRequired User Permissions: Ficha de Persona / Datos Ampliación","operationId":"Template_AddOrUpdateTemplateElementValueEmp","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"template","in":"path","description":"The template name","required":true,"schema":{"type":"string"}},{"name":"element","in":"path","description":"The element name","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"The value to store","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElementValue"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ElementValue"}}},"required":true,"x-bodyName":"value"},"responses":{"200":{"description":"adds or updates value","content":{"application/json":{"schema":{"type":"boolean"}},"application/xml":{"schema":{"type":"boolean"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/customdata/{template}/{element}":{"get":{"tags":["Custom data"],"summary":"Get value stored in an element for a company","description":"\nRequired User Permissions: Ficha de Empresa / Datos Ampliación","operationId":"Template_GetTemplateElementValueComp","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"template","in":"path","description":"The template name","required":true,"schema":{"type":"string"}},{"name":"element","in":"path","description":"The element name","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns values","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateFieldDefinitionModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateFieldDefinitionModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["Custom data"],"summary":"Update a value of an element for a company","description":"\nRequired User Permissions: Ficha de Empresa / Datos Ampliación","operationId":"Template_AddOrUpdateTemplateElementValueComp","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"template","in":"path","description":"The template name","required":true,"schema":{"type":"string"}},{"name":"element","in":"path","description":"The element name","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"The value to store","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElementValue"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ElementValue"}}},"required":true,"x-bodyName":"value"},"responses":{"200":{"description":"adds or updates value","content":{"application/json":{"schema":{"type":"boolean"}},"application/xml":{"schema":{"type":"boolean"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/absenteeisms/holidays/{year}/summary":{"get":{"tags":["Employee portal"],"summary":"Get employee holiday summary","description":"GET /api/companies/258/employees/000029/absenteeisms/holidays/2021/summary<br />\nRequired User Permissions: IT y Absentismos","operationId":"HolidaysEntity_GetHolidaysSummary","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"year","in":"path","description":"year","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee holidays","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VacationDaysSumary"}},"application/xml":{"schema":{"$ref":"#/components/schemas/VacationDaysSumary"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/absenteeisms/holidays/{year}/other-days":{"put":{"tags":["Employee portal"],"summary":"Update employee holiday other days","description":"GET /api/companies/258/employees/000029/absenteeisms/holidays/2021/other-days<br />\nRequired User Permissions: IT y Absentismos","operationId":"HolidaysEntity_SetOtherDaysValueForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"year","in":"path","description":"year","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"other days to set and observations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OtherDays"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OtherDays"}}},"required":true,"x-bodyName":"otherDays"},"responses":{"200":{"description":"Returns operation status","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/holidays/{date}":{"get":{"tags":["Employee portal"],"summary":"List holidays percentages by date","description":"\nRequired User Permissions: Ficha de Empresa","operationId":"HolidaysPercentagesCollection_GetCollectionPercentages","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"date","in":"path","description":"","required":true,"schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/orderBy"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns holidays percentages data","headers":{"x-pagination":{"description":"Collection pagination","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HolidaysPercentagesCollectionResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HolidaysPercentagesCollectionResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/portal/companies/{companyCode}/requests/vacations/{startDate}/{endDate}":{"get":{"tags":["Employee portal"],"summary":"List holiday requests from employee portal by company","description":"\nRequired User Permissions: Solicitudes (Nivel 2)","operationId":"PortalRequests_GetVacationRequestsForCompany","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"startDate","in":"path","description":"Start date range","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"endDate","in":"path","description":"End date range","required":true,"schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/pageNumber"},{"name":"employeeCode","in":"query","description":"optional employee code filter","schema":{"type":"string"}},{"name":"campaignYear","in":"query","description":"optional campaign year filter","schema":{"type":"integer","format":"int32"}},{"name":"state","in":"query","description":"optional state filter (Approved/Pending/Cancelled/Denied)","schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns vacation requests","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VacationRequestModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VacationRequestModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/portal/companies/{companyCode}/workplaces/{workplaceCode}/requests/vacations/{startDate}/{endDate}":{"get":{"tags":["Employee portal"],"summary":"List holiday requests from employee portal by workplace","description":"\nRequired User Permissions: Solicitudes (Nivel 2)","operationId":"PortalRequests_GetVacationRequestsForWorkplace","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"workplaceCode","in":"path","description":"The workplace code","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"startDate","in":"path","description":"Start date range","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"endDate","in":"path","description":"End date range","required":true,"schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/pageNumber"},{"name":"employeeCode","in":"query","description":"optional employee code filter","schema":{"type":"string"}},{"name":"campaignYear","in":"query","description":"optional campaign year filter","schema":{"type":"integer","format":"int32"}},{"name":"state","in":"query","description":"optional state filter (Approved/Pending/Cancelled/Denied)","schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns vacation requests","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VacationRequestModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VacationRequestModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/portals/users":{"get":{"tags":["Employee portal"],"summary":"List users of an employee portal","description":"\nRequired User Permissions: Gestión de Portales","operationId":"PortalUserManagement_GetPortalUsers","parameters":[{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/pageNumber"},{"name":"companyCode","in":"query","description":"Company code","schema":{"type":"integer","format":"int32"}},{"name":"portalCode","in":"query","description":"Portal code","schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns portal users","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalUser"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PortalUser"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/portals":{"get":{"tags":["Employee portal"],"summary":"List employee portals","description":"\nRequired User Permissions: Gestión de Portales","operationId":"PortalUserManagement_GetPortals","parameters":[{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/pageNumber"},{"name":"companyCode","in":"query","description":"Company code","schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns portals","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Portal"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Portal"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/pactedsalary":{"get":{"tags":["Employees"],"summary":"Get employee pacted salary","description":"\nRequired User Permissions: Ficha de Persona / Retribuciones","operationId":"EmployeeAgreedSalary_GetEmployeePactedSalary","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee pacted salary","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PactedSalary"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PactedSalary"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["Employees"],"summary":"Update employee pacted salary","description":"\nRequired User Permissions: Ficha de Persona / Retribuciones","operationId":"EmployeeAgreedSalary_PutEmployeePactedSalary","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PactedSalary"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PactedSalary"}}},"required":true,"x-bodyName":"agreedSalary"},"responses":{"200":{"description":"Returns operation status","content":{"application/json":{"schema":{"type":"boolean"}},"application/xml":{"schema":{"type":"boolean"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/contactdata/professional":{"get":{"tags":["Employees"],"summary":"Get employee professional contact data","description":"GET /api/companies/258/employees/000029/contactdata/professional\nRequired User Permissions: Ficha de Persona / Datos personales","operationId":"ProfessionalContactDataEntity_GetEmployeeProfessionalContactInforation","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee personal contact data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfessionalContactDataEntityResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ProfessionalContactDataEntityResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["Employees"],"summary":"Update employee professional contact data","description":"PUT /api/companies/258/employees/000029/contactdata/professional<br />\nRequired User Permissions: Ficha de Persona / Datos personales","operationId":"ProfessionalContactDataEntity_PutEmployeeProfessionalContactInformation","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfessionalContactDataEntityResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ProfessionalContactDataEntityResource"}}},"required":true,"x-bodyName":"contactDetails"},"responses":{"200":{"description":"Returns operation status","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/educationlevel":{"get":{"tags":["Employees"],"summary":"Get employee education level","description":"\nRequired User Permissions: Ficha de Persona / Perfil","operationId":"EducationLevel_GetEmployeeEducationLevelByEmplyeeCodeAndCompanyId","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns education level of employee","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeEducationLevel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EmployeeEducationLevel"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["Employees"],"summary":"Update employee education level","description":"\nRequired User Permissions: Ficha de Persona / Perfil","operationId":"EducationLevel_PutEmployeeEducationLevel","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeEducationLevel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EmployeeEducationLevel"}}},"required":true,"x-bodyName":"educationLevel"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/contactdata/address":{"get":{"tags":["Employees"],"summary":"Get employee address","description":"GET /api/companies/258/employees/000029/address/<br />\nRequired User Permissions: Ficha de Persona / Datos personales","operationId":"AddressEntity_GetEmployeeAddressInformation","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee unjustified absenteeism","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressEntityResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AddressEntityResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["Employees"],"summary":"Update employee address","description":"\nRequired User Permissions: Ficha de Persona / Datos personales","operationId":"AddOrUpdateEmployeeAddress","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"address info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AddressModel"}}},"required":true,"x-bodyName":"address"},"responses":{"200":{"description":"Operation status","content":{"application/json":{"schema":{"type":"boolean"}},"application/xml":{"schema":{"type":"boolean"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees":{"get":{"tags":["Employees"],"summary":"List employees","description":"GET /api/companies/258/employees<br />\r\n{<br />\r\n   \"filter\": \"workplaceCode eq 1 and (dropDate eq null or dropDate ge 2001-02-28)\",<br />\r\n   \"orderBy\": \"employeeCode asc\"<br />\r\n   \"pageNumber\": 1,<br />\r\n   \"pageSize\": 25,<br />\r\n}<br />\nRequired User Permissions: Relación de Trabajadores","operationId":"GetEmployees","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/orderBy"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employees data","headers":{"x-pagination":{"description":"Collection pagination","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeesCollectionResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeesCollectionResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/create-employee":{"post":{"tags":["Employees"],"summary":"Create employee","description":"POST /api/companies/182/employees/create-employee<br />\r\n{<br />\r\n\"workplaceCode\": 1,<br />\r\n  \"identification\" : {<br />\r\n    \"identificationType\": 1, (id from /api/identificationtypes)<br />\r\n    \"identifierNumber\": \"Z7357618S\",<br />\r\n    \"employeeCode\": \"8882\",<br />\r\n    \"legalName\": \"name\",<br />\r\n    \"secondName1\": \"surname\",<br />\r\n    \"secondName2\": \"surname2\",<br />\r\n    \"sex\": \"H\", (from /api/sextypes)<br />\r\n    \"ssAffiliationNumberPrefix\": \"02\",<br />\r\n    \"ssAffiliationNumber\": \"00323232\",<br />\r\n    \"ssAffiliationNumberSuffix\": \"11\",<br />\r\n    \"enrollmentDate\": \"2021-01-01\",<br />\r\n    \"personType\": \"2\", (id from /api/persontypes)<br />\r\n    \"birthRegion\": \"HUELVA\", (regionCode from /api/countries/{isocountryid}/Regions)<br />\r\n    \"birthCountry\": \"ESPAÑA\" (isoCountryID from /api/countries)<br />\r\n }<br />\r\n \"agreement\": {<br />\r\n    \"jobPositionCode\": \"00000077\", (jobCode from /api/companies/{companycode}/available-jobpositions)<br />\r\n    \"companyAgreementCode\": \"00000000000001\", (agreement Code from /api/companies/{companycode}/agreements)<br />\r\n    \"classificationCode\": 2, (classificationCode from /api/companies/{companycode}/agreements/{agreementcode}/classifications)<br />\r\n    \"subClassificationCode\": 2, (subClassificationCode from /api/companies/{companycode}/agreements/{agreementcode}/classifications)<br />\r\n    \"cnoOccupationID\": \"0001\", (id from /api/cnooccupations)<br />\r\n }<br />\r\n \"contribution\": {<br />\r\n    \"contributionTypeID\":2,\r\n    \"regime\": \"5bbc8d2b-2d03-4b9f-a017-64c6f02a9870\", (regimeID from /api/companies/{companycode}/regimes)<br />\r\n    \"tariffGroupID\": 2, (contributionGroupID from /api/companies/{companycode}/regimes/{regimeid}/tariff-groups)<br />\r\n    \"occupationCodeTGSS\": \"x\", (occupationCode from /api/companies/{companycode}/occupation-codes)<br />\r\n    \"ims\": 3.35, (suggested percentageIT from /api/companies/{companycode}/occupation-codes)<br />\r\n    \"it\": 3.35, (suggested percentageIMS from /api/companies/{companycode}/occupation-codes)<br />\r\n    \"paymentFrequency\": 2, (collectionTypeID from /api/companies/{companycode}/payment-frequencies)<br />\r\n }\r\n \"address\": {\r\n    \"acronymID\": \"string\",<br />\r\n    \"streetName\": \"string\",<br />\r\n    \"buildingNumber\": \"string\",<br />\r\n    \"stairwell\": \"string\",<br />\r\n    \"floor\": \"string\",<br />\r\n    \"gate\": \"string\",<br />\r\n    \"town\": \"string\",<br />\r\n    \"postalCode\": \"string\",<br />\r\n    \"countryID\": 724,(ISOCountryID from  /api/countries)<br />\r\n    \"poBox\": \"string\"<br /><br />\r\n}<br />\nRequired User Permissions: Personas","operationId":"CreateEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"entityMode","in":"query","description":"Entity mode to use, Single = separate record for each employee, Shared = details shared between employees, Default = duplicate records not permitted","schema":{"enum":["Default","Shared","Single"],"type":"string","default":"Default"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewEmployee"}},"application/xml":{"schema":{"$ref":"#/components/schemas/NewEmployee"}}},"required":true,"x-bodyName":"newEmployee"},"responses":{"200":{"description":"Created new employee","content":{"application/json":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/addresses/{addresstypeid}":{"put":{"tags":["Employees"],"summary":"Update employee address by AddressType (Deprecated)","description":"\nRequired User Permissions: Ficha de Persona / Datos personales","operationId":"AddOrUpdateEmployeeAddressOfType","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"addresstypeid","in":"path","description":"address type","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"address info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AddressModel"}}},"required":true,"x-bodyName":"address"},"responses":{"200":{"description":"Operation status","content":{"application/json":{"schema":{"type":"boolean"}},"application/xml":{"schema":{"type":"boolean"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/workplaces/{workplacecode}/employees/create-employee-request":{"post":{"tags":["Employees"],"summary":"Create a new employee request","description":"POST /api/companies/182/workplaces/1/employees/create-employee-request<br />\nRequired User Permissions: Personas","operationId":"CreateEmployeeRequest","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"workplacecode","in":"path","description":"Compnay workplace ocde where to create employee","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"new employee data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HRRequestRequestNewEmployee"}},"application/xml":{"schema":{"$ref":"#/components/schemas/HRRequestRequestNewEmployee"}}},"required":true,"x-bodyName":"newEmployee"},"responses":{"200":{"description":"Created new employee","content":{"application/json":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/medicalCheckups":{"get":{"tags":["Employees"],"summary":"Get employee medical checkup history","description":"GET /api/companies/258/employees/000049/medicalCheckups<br />\nRequired User Permissions: Ficha de Persona / Gestión","operationId":"EmployeesMedical_GetEmployeeMedicalCheckups","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee medical checkup information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeMedicalResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeMedicalResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/contactdata/personal":{"get":{"tags":["Employees"],"summary":"Get employee personal contact data","description":"GET /api/companies/258/employees/000029/contactdata/personal<br />\nRequired User Permissions: Ficha de Persona / Datos personales","operationId":"PersonalContactDataEntity_GetEmployeePersonalContactInformation","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee personal contact data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalContactDataEntityResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PersonalContactDataEntityResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["Employees"],"summary":"Update employee personal contact data","description":"PUT /api/companies/258/employees/000029/contactdata/personal<br />\nRequired User Permissions: Ficha de Persona / Datos personales","operationId":"PersonalContactDataEntity_PutEmployeePersonalContactInformation","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"The details to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalContactDataEntityResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PersonalContactDataEntityResource"}}},"required":true,"x-bodyName":"contactDetails"},"responses":{"200":{"description":"Returns operation status","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/identification":{"get":{"tags":["Employees"],"summary":"Get employee identification","description":"GET /api/companies/258/employees/000049/identification<br />\nRequired User Permissions: Ficha de Persona / Datos personales","operationId":"EmployeesIdentification_GetEmployeeIdentification","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee identification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentificationResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/IdentificationResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["Employees"],"summary":"Update employee identification","description":"\nRequired User Permissions: Ficha de Persona / Datos personales","operationId":"EmployeesIdentification_PutEmployeeDetails","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EmployeeDetails"}}},"required":true,"x-bodyName":"employeeDetails"},"responses":{"200":{"description":"Operation status","content":{"application/json":{"schema":{"type":"boolean"}},"application/xml":{"schema":{"type":"boolean"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/workplaces/{workplacecode}/employees/{employeeCode}/sspaymentnumber":{"get":{"tags":["Employees"],"summary":"Get workplace social security number for employee","description":"\nRequired User Permissions: Ficha de Persona / Datos personales","operationId":"PayInfo_GetSSPayemntNumberIDForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"workplacecode","in":"path","description":"Workplace code","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns SSPayment number id","content":{"application/json":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/location":{"get":{"tags":["Employees"],"summary":"Get employee location","description":"GET /api/companies/258/employees/000049/location<br />\nRequired User Permissions: Ficha de Persona / Datos personales","operationId":"EmployeesLocation_GetLocation","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee location data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/LocationResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/formation":{"get":{"tags":["Employees"],"summary":"Get employee formation history","description":"GET /api/companies/258/employees/000049/formation<br />\nRequired User Permissions: Ficha de Persona / Perfil","operationId":"EmployeesFormation_GetEmployeeFormation","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee medical checkup information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeFormationResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeFormationResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/hiringdates":{"get":{"tags":["Employees"],"summary":"Get employee hiring dates","description":"GET /api/companies/36511/employees/000002/hiringdates<br />\nRequired User Permissions: Ficha de Persona / Contratación","operationId":"HiringDatesEntity_GetEmployeeHiringDatesInformation","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee hiring dates","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HiringDatesEntityResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/HiringDatesEntityResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["Employees"],"summary":"Update employee hiring dates","description":"PUT /api/companies/36511/employees/000002/hiringdates<br />\nRequired User Permissions: Ficha de Persona / Contratación","operationId":"HiringDatesEntity_PutEmployeeHiringDatesInformation","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"hiring dates resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HiringDatesEntityPutResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/HiringDatesEntityPutResource"}}},"required":true,"x-bodyName":"hiringDates"},"responses":{"200":{"description":"Returns operation status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HiringDatesEntityResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/HiringDatesEntityResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/advances":{"get":{"tags":["Employees - Advances"],"summary":"List employee advances","description":"\nRequired User Permissions: Anticipo Préstamo Embargo","operationId":"PayInfo_GetAdvancesForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns Pays Advances","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PayAdvance"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PayAdvance"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["Employees - Advances"],"summary":"Create employee advance","description":"An advance can be funded from either the next salary payment or a forthcoming extra payment, like the summer or christmas extra payments. <br />\r\nthe funding source is specified in the property \"FundingSource\" of the advance object.<br /><br />\r\n* NextExtraPayment = Fund against the nexst extra payment, this requires specifying the specific extra payment to target in the collection ExtraPaymentSources of the advance object.<br /><br />\r\n* NextMonthlyPayment = Fund against the next monthly salary payment<br />\nRequired User Permissions: Anticipo Préstamo Embargo","operationId":"PayInfo_AddAdvanceForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"Information to create the advance","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeAdvance"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EmployeeAdvance"}}},"required":true,"x-bodyName":"advance"},"responses":{"200":{"description":"Returns operation status success","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/seizures":{"get":{"tags":["Employees - Advances"],"summary":"List employee seizures","description":"\nRequired User Permissions: Anticipo Préstamo Embargo","operationId":"PayInfo_GetseizuresForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns Pays Embargos","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PayEmbargo"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PayEmbargo"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/advances/{advanceId}":{"delete":{"tags":["Employees - Advances"],"summary":"Delete employee advance","description":"\nRequired User Permissions: Anticipo Préstamo Embargo","operationId":"PayInfo_DeleteAdvanceForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"advanceId","in":"path","description":"The advance to delete","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns operation status success","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/agreement":{"get":{"tags":["Employees - Agreements"],"summary":"Get employee agreement","description":"GET /api/companies/1361/employees/000002/agreement<br />\nRequired User Permissions: Ficha de Persona / Convenio","operationId":"AgreementEntity_GetEmployeeAgreementInformation","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee agreement","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeAgreement"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EmployeeAgreement"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["Employees - Agreements"],"summary":"Update employee agreement","description":"GET /api/companies/1361/employees/000002/agreement<br />\nRequired User Permissions: Ficha de Persona / Convenio","operationId":"AgreementEntity_PutEmployeeAgreement","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"Agreement and category info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeAgreementInfo"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EmployeeAgreementInfo"}}},"required":true,"x-bodyName":"agreementInfo"},"responses":{"200":{"description":"Returns employee address data","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/subClassifications":{"get":{"tags":["Employees - Agreements"],"summary":"Get employee subclassifications","description":"\nRequired User Permissions: Ficha de Persona / Convenio","operationId":"CompaniesEmployees_GetEmployeeSubClassifications","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"EmployeeSubClassification","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeSubClassification"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeSubClassification"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/bankaccount/{bankaccountcode}":{"get":{"tags":["Employees - Bank accounts"],"summary":"Get employee main bank account","description":"GET /api/companies/258/employees/000049/bankaccount/{bankaccountcode}<br />\nRequired User Permissions: Ficha de Persona / Formas de Cobro","operationId":"EmployeesBankAccount_GetBankAccount","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"bankaccountcode","in":"path","description":"Bank account code","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee bank account data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountsResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BankAccountsResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["Employees - Bank accounts"],"summary":"Update employee bank account","description":"PUT /api/companies/258/employees/000049/bankaccounts/<br />\nRequired User Permissions: Ficha de Persona / Formas de Cobro","operationId":"EmployeesBankAccount_PutBankAccounts","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"bankaccountcode","in":"path","description":"Bank account code","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"Main bank account data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountsResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BankAccountsResource"}}},"required":true,"x-bodyName":"bankaccountdata"},"responses":{"200":{"description":"Updates bank account data","content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["Employees - Bank accounts"],"summary":"Delete employee bank account","description":"Delete /api/companies/258/employees/000049/bankaccounts/fc7b5e9e-2472-47a3-b9a4-7765761bc5b4<br />\nRequired User Permissions: Ficha de Persona / Formas de Cobro","operationId":"EmployeesBankAccount_DeleteBankAccount","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"bankaccountcode","in":"path","description":"Bank account code","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Delete bank account data","content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/company-bankaccount":{"get":{"tags":["Employees - Bank accounts"],"summary":"Get company bank account for employee","description":"\nRequired User Permissions: Ficha de Persona / Formas de Cobro","operationId":"EmployeesBankAccount_GetCompanyBankAccountForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee bank account data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeCompanyBankAccountResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EmployeeCompanyBankAccountResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/bankaccounts":{"get":{"tags":["Employees - Bank accounts"],"summary":"List employee bank accounts","description":"\nRequired User Permissions: Ficha de Persona / Formas de Cobro","operationId":"EmployeesBankAccount_GetBankAccounts","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee bank account data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeBankAccountCodeModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EmployeeBankAccountCodeModel"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["Employees - Bank accounts"],"summary":"Create employee bank account","description":"POST /api/companies/258/employees/000049/bankaccounts<br />\nRequired User Permissions: Ficha de Persona / Formas de Cobro","operationId":"EmployeesBankAccount_PostBankAccounts","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"Main bank account data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountsResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BankAccountsResource"}}},"required":true,"x-bodyName":"bankaccountdata"},"responses":{"200":{"description":"Creates bank account data","content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}}}},"201":{"description":"Creates bank account data","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/pay-bank-account":{"get":{"tags":["Employees - Bank accounts"],"summary":"Get employeer pay bank account","description":"GET /api/companies/258/employees/000049<br />\nRequired User Permissions: Ficha de Persona / Formas de Cobro","operationId":"EmployeesBankAccount_GetEmployeeBankAccount","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee bank account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayBankAccountResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PayBankAccountResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["Employees - Bank accounts"],"summary":"Update employeer pay bank account","description":"\nRequired User Permissions: Ficha de Persona / Formas de Cobro","operationId":"EmployeesBankAccount_PostPayBankAccounts","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayBankAccountResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PayBankAccountResource"}}},"required":true,"x-bodyName":"bankaccountdata"},"responses":{"200":{"description":"Creates bank account data","content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/remoteworkagreement":{"get":{"tags":["Employees - Contracts"],"summary":"Get employee remote work agreement","description":"\nRequired User Permissions: Ficha de Persona / Contratación","operationId":"EmployeeAgreedSalary_GetEmployeeRemoteWorkAgreement","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee remote work agreement","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteWorkAgreement"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RemoteWorkAgreement"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/contract-agreement":{"get":{"tags":["Employees - Contracts"],"summary":"Get employee contract agreement","description":"\nRequired User Permissions: Ficha de Persona / Contratación","operationId":"EmployeeContracts_GetEmployeeContractAgreement","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee contract agreement","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeContractAgreement"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EmployeeContractAgreement"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/contract":{"post":{"tags":["Employees - Contracts"],"summary":"Update employee contract","description":"\nRequired User Permissions: Ficha de Persona / Contratación","operationId":"EmployeeContracts_PostEmployeeContract","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"contract information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeContractInfoResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EmployeeContractInfoResource"}}},"required":true,"x-bodyName":"contract"},"responses":{"200":{"description":"Returns employee new contract id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenValidationHandler"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TokenValidationHandler"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/contract-history":{"get":{"tags":["Employees - Contracts"],"summary":"List employee contracts history","description":"\nRequired User Permissions: Ficha de Persona / Contratación","operationId":"EmployeeContracts_GetEmployeeEmployeeContractHistory","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee contract history","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeContractHistoryResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EmployeeContractHistoryResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/affiliationdata":{"get":{"tags":["Employees - Contracts"],"summary":"Get employee affiliation data","description":"\nRequired User Permissions: Ficha de Persona / Contratación","operationId":"EmployeesAffiliations_GetEmployeeAffiliationData","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee Affiliation Data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeAffiliationDataGet"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EmployeeAffiliationDataGet"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["Employees - Contracts"],"summary":"Update employee affiliation data","description":"\nRequired User Permissions: Ficha de Persona / Contratación","operationId":"EmployeesAffiliations_PutEmployeeAffiliationData","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeAffiliationDataPut"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EmployeeAffiliationDataPut"}}},"required":true,"x-bodyName":"employeeAffiliationData"},"responses":{"200":{"description":"Returns operation status","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/contrata/basiccopy":{"put":{"tags":["Employees - Contracts"],"summary":"Update employee contrat@ basic copy information","description":"\nRequired User Permissions: Ficha de Persona / Contratación","operationId":"EmployeesContract_PutContractCommsBasicCopy","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicCopyData"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BasicCopyData"}}},"required":true,"x-bodyName":"basicCopyData"},"responses":{"200":{"description":"Returns status","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/contrata/parttime":{"put":{"tags":["Employees - Contracts"],"summary":"Update employee contrat@ part time information","description":"\nRequired User Permissions: Ficha de Persona / Contratación","operationId":"EmployeesContract_PutContractPartTimeData","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartTimeData"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PartTimeData"}}},"required":true,"x-bodyName":"partTimeData"},"responses":{"200":{"description":"Returns status","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/contract/timetable":{"get":{"tags":["Employees - Contracts"],"summary":"Get employee contract timetable","description":"\nRequired User Permissions: Ficha de Persona / Contratación","operationId":"EmployeesContract_GetTimeTable","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns time table ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeTable"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TimeTable"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["Employees - Contracts"],"summary":"Update employee contract timetable","description":"\nRequired User Permissions: Ficha de Persona / Contratación","operationId":"EmployeesContract_SetTimeTable","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeTable"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TimeTable"}}},"required":true,"x-bodyName":"data"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/contrata/clauses":{"get":{"tags":["Employees - Contracts"],"summary":"List employee contrat@ contract clauses for basic copy","description":"\nRequired User Permissions: Ficha de Persona / Contratación","operationId":"EmployeesContract_GetEmployeeClauses","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee clauses ","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeClauseResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeClauseResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/irpfdata":{"get":{"tags":["Employees - IRPF"],"summary":"Get employee IRPF data","description":"GET /api/companies/258/employees/000049/jobPositionHistory<br />\nRequired User Permissions: Ficha de Persona / Tributación","operationId":"IRPFData_GetEmployeeIRPFData","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee IRPF Data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeIRPFDataModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EmployeeIRPFDataModel"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["Employees - IRPF"],"summary":"Update employee IRPF Data","description":"PUT /api/companies/258/employees/000049/irpfdata<br />\nRequired User Permissions: Ficha de Persona / Tributación","operationId":"IRPFData_PutEmployeeIRPFData","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"EmployeeIrpf Data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeIRPFDataModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EmployeeIRPFDataModel"}}},"required":true,"x-bodyName":"employeeIRPFData"},"responses":{"200":{"description":"Returns operation status","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/irpfdata/calculated":{"get":{"tags":["Employees - IRPF"],"summary":"Get employee calculated actual IRPF Data","description":"\nRequired User Permissions: Ficha de Persona / Tributación","operationId":"IRPFData_GetEmployeeIRPFDataCalculated","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee IRPF Data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IRPFCalcuation"}},"application/xml":{"schema":{"$ref":"#/components/schemas/IRPFCalcuation"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["Employees - IRPF"],"summary":"Update employee calculated actual IRPF Data","description":"\nRequired User Permissions: Ficha de Persona / Tributación","operationId":"IRPFData_PutEmployeeIRPFDataCalculated","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IRPFCalcuationPut"}},"application/xml":{"schema":{"$ref":"#/components/schemas/IRPFCalcuationPut"}}},"required":true,"x-bodyName":"irpfCalcuation"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/irpfdata/descendants":{"get":{"tags":["Employees - IRPF"],"summary":"List employee IRPF descendants","description":"\nRequired User Permissions: Ficha de Persona / Tributación","operationId":"IRPFData_GetEmployeeIRPFDataDescendants","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee IRPF Data descendants","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeIRPFDataDescendantModelWithId"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeIRPFDataDescendantModelWithId"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["Employees - IRPF"],"summary":"Create employee IRPF descendant","description":"\nRequired User Permissions: Ficha de Persona / Tributación","operationId":"IRPFData_NewEmployeeIRPFDataDescendant","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"descendant information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeIRPFDataDescendantModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EmployeeIRPFDataDescendantModel"}}},"required":true,"x-bodyName":"employeeIRPFDataDescendantModel"},"responses":{"200":{"description":"Returns new descendant id","content":{"application/json":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/irpfdata/ascendants":{"get":{"tags":["Employees - IRPF"],"summary":"List employee IRPF ascendants","description":"\nRequired User Permissions: Ficha de Persona / Tributación","operationId":"IRPFData_GetEmployeeIRPFDataAscendants","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee IRPF Data ascendants","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeIRPFDataAscendantModelWithId"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeIRPFDataAscendantModelWithId"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["Employees - IRPF"],"summary":"Create employee IRPF ascendant","description":"\nRequired User Permissions: Ficha de Persona / Tributación","operationId":"IRPFData_NewEmployeeIRPFDataAscendant","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"ascendant information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeIRPFDataAscendantModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EmployeeIRPFDataAscendantModel"}}},"required":true,"x-bodyName":"employeeIRPFDataAscendantModel"},"responses":{"200":{"description":"Returns new ascendant id","content":{"application/json":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/irpfdata/ascendants/{ascendantId}":{"post":{"tags":["Employees - IRPF"],"summary":"Update employee IRPF ascendant","description":"\nRequired User Permissions: Ficha de Persona / Tributación","operationId":"IRPFData_UpdateEmployeeIRPFDataAscendant","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"ascendantId","in":"path","description":"ascendantid","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"ascendant information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeIRPFDataAscendantModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EmployeeIRPFDataAscendantModel"}}},"required":true,"x-bodyName":"employeeIRPFDataAscendantModel"},"responses":{"200":{"description":"Returns operation status","content":{"application/json":{"schema":{"type":"boolean"}},"application/xml":{"schema":{"type":"boolean"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/irpfdata/descendants/{descendantId}":{"put":{"tags":["Employees - IRPF"],"summary":"Update employee IRPF descendant","description":"\nRequired User Permissions: Ficha de Persona / Tributación","operationId":"IRPFData_UpdateEmployeeIRPFDataDescendant","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"descendantId","in":"path","description":"ascendantid","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"descendant information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeIRPFDataDescendantModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EmployeeIRPFDataDescendantModel"}}},"required":true,"x-bodyName":"employeeIRPFDataDescendantModel"},"responses":{"200":{"description":"Returns operation status","content":{"application/json":{"schema":{"type":"boolean"}},"application/xml":{"schema":{"type":"boolean"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/available-jobpositions":{"get":{"tags":["Employees - Job position"],"summary":"List available positions in company","description":"\nRequired User Permissions: Ficha de Empresa / Convenios y Pactos","operationId":"Organisation_GetAvailableJobPositionsForCompany","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns job positions available in company specified","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AvailableJobPositionModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AvailableJobPositionModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/jobPositionInformation":{"get":{"tags":["Employees - Job position"],"summary":"Get employee job position","description":"\nRequired User Permissions: Ficha de Persona / Convenio","operationId":"Organisation_GetEmployeePositionDetailsByEmployeeCodeAndCompanyId","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"index","in":"query","description":"index of job position","schema":{"type":"integer","format":"int32","default":1}},{"name":"includeEnded","in":"query","description":"include ended job positions","schema":{"type":"boolean","default":false}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns job position details of employee","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeePositionDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EmployeePositionDetails"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/jobPositionHistory":{"get":{"tags":["Employees - Job position"],"summary":"List employee job position history","description":"GET /api/companies/258/employees/000049/jobPositionHistory<br />\nRequired User Permissions: Ficha de Persona / Convenio","operationId":"EmployeesLaboral_GetEmployeeJobHistory","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee identification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeJobHistory"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EmployeeJobHistory"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/jobtitle":{"get":{"tags":["Employees - Job position"],"summary":"Get employee jobtitle","description":"GET /api/companies/1361/employees/000002/jobtitle<br />\nRequired User Permissions: Ficha de Persona / Convenio","operationId":"JobTitleEntity_GetEmployeeJobTitleInforation","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee jobtitle","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobTitleEntityResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/JobTitleEntityResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["Employees - Job position"],"summary":"Update employee jobposition","description":"PUT /api/companies/1361/employees/000002/jobtitle<br />\nRequired User Permissions: Ficha de Persona / Convenio","operationId":"JobTitleEntity_PutEmployeeJobPosition","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JobTitleInformation"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JobTitleInformation"}}}},"required":true,"x-bodyName":"jobPositions"},"responses":{"200":{"description":"Returns operation status","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/jobTitles":{"get":{"tags":["Employees - Job position"],"summary":"List job titles in company","operationId":"DataLists_GetCompanyJobTitles","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns job positions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JobTitle"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JobTitle"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/create-laborlife":{"post":{"tags":["Employees - Labor life"],"summary":"Create employee labour life","description":"\nRequired User Permissions: Ficha de Persona / Vida laboral","operationId":"CreateLaborLife","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LaborLifeDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/LaborLifeDetails"}}},"required":true,"x-bodyName":"laborLifeDetails"},"responses":{"200":{"description":"Created new laborlife","content":{"application/json":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/labourLife":{"get":{"tags":["Employees - Labor life"],"summary":"List employee laborlife","description":"GET /api/companies/258/employees/000049/labourLife<br />\nRequired User Permissions: Ficha de Persona / Vida laboral","operationId":"EmployeesLaboral_GetEmployeeLaborLife","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee labour life","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeLaborLife"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EmployeeLaborLife"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/labourLife/{laborlifeid}":{"get":{"tags":["Employees - Labor life"],"summary":"Get employee laborlife","description":"GET /api/companies/258/employees/000049/labourLife/3E439063-D142-459F-B78F-6A9EA8F98EAA]<br />\nRequired User Permissions: Ficha de Persona / Vida laboral","operationId":"EmployeesLaboral_GetEmployeeLaborLifeDetail","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"laborlifeid","in":"path","description":"labour life entry id","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee labour life","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeLaborLifeDetail"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EmployeeLaborLifeDetail"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/concepts":{"get":{"tags":["Employees - Remuneration"],"summary":"List employee pay concepts","description":"\nRequired User Permissions: Ficha de Persona / Retribuciones","operationId":"PayInfo_GetPaysConcepts","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns Calculated Internal Concepts Employee Concepts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeConceptInfoListModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeConceptInfoListModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["Employees - Remuneration"],"summary":"Create employee pay concept","description":"\nRequired User Permissions: Ficha de Persona / Retribuciones","operationId":"PayInfo_AddPaysConcept","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"employee concept","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddEmployeeConcept"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AddEmployeeConcept"}}},"required":true,"x-bodyName":"employeeConcept"},"responses":{"200":{"description":"Returns new employee concept id","content":{"application/json":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["Employees - Remuneration"],"summary":"Delete employee pay concept","description":"\nRequired User Permissions: Ficha de Persona / Retribuciones","operationId":"PayInfo_RemovePaysConcept","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"conceptCode","in":"query","description":"concept code","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Boolean state of operation","content":{"application/json":{"schema":{"type":"boolean"}},"application/xml":{"schema":{"type":"boolean"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/concepts/{conceptcode}":{"get":{"tags":["Employees - Remuneration"],"summary":"Get employee pay concept","description":"\nRequired User Permissions: Ficha de Persona / Retribuciones","operationId":"PayInfo_GetPaysConceptSByConceptId","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"conceptcode","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns Pay Concepts ","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeConceptInfoModelL1"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeConceptInfoModelL1"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/concepts/{conceptCode}/amount":{"put":{"tags":["Employees - Remuneration"],"summary":"Update employee pay concept amount","description":"\nRequired User Permissions: Ficha de Persona / Retribuciones","operationId":"PayInfo_SetEmployeeConceptAmount","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"conceptCode","in":"path","description":"concept code","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"amount","in":"query","description":"amount","required":true,"schema":{"type":"number","format":"double"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Operation boolean status","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/incentives":{"get":{"tags":["Employees - Remuneration"],"summary":"List employee incentives","description":"\nRequired User Permissions: Ficha de Persona / Retribuciones","operationId":"EmployeesIncentives_GetEmployeeIncentives","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee incentives","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeIncentive"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeIncentive"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/sanctions":{"get":{"tags":["Employees - Remuneration"],"summary":"List employee sanctions","description":"\nRequired User Permissions: Ficha de Persona / Retribuciones","operationId":"EmployeesSanctions_GetEmployeeSanctions","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee sanctions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeSanction"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeSanction"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/salaryadjustments":{"get":{"tags":["Employees - Salary"],"summary":"Get employee agreed salary","description":"\nRequired User Permissions: Ficha de Persona / Retribuciones","operationId":"EmployeeAgreedSalary_GetEmployeeSalaryAdjustments","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee pacted salary","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgreedSalary"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AgreedSalary"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["Employees - Salary"],"summary":"Update employee agreed salary","description":"\nRequired User Permissions: Ficha de Persona / Retribuciones","operationId":"EmployeeAgreedSalary_SetEmployeeSalaryAdjustments","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgreedSalary"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AgreedSalary"}}},"required":true,"x-bodyName":"agreedSalary"},"responses":{"200":{"description":"operation status","content":{"application/json":{"schema":{"type":"boolean"}},"application/xml":{"schema":{"type":"boolean"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/pays/theoretical-gross":{"get":{"tags":["Employees - Salary"],"summary":"Get employee theoretical gross","description":"\nRequired User Permissions: Ficha de Persona / Retribuciones","operationId":"PayInfo_GetTheoreticalGrossForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns list of theoretical gross","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TheoreticalGross"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TheoreticalGross"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/pays/theoretical-gross/{year}":{"put":{"tags":["Employees - Salary"],"summary":"Update employee theoretical gross","description":"\nRequired User Permissions: Ficha de Persona / Retribuciones","operationId":"PayInfo_PutTheoreticalGrossForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"year","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"theoretical gross","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TheoreticalGrossPut"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TheoreticalGrossPut"}}},"required":true,"x-bodyName":"gross"},"responses":{"200":{"description":"Updated","content":{"application/json":{},"application/xml":{}}},"201":{"description":"Created","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/pays/extrapayments":{"get":{"tags":["Employees - Salary"],"summary":"Get employee extra payments","description":"\nRequired User Permissions: Ficha de Persona / Retribuciones","operationId":"PayInfo_GetExtraPaymentsForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns Pays Advances","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExtraPayment"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExtraPayment"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/unemployments":{"get":{"tags":["Employees - Unemployments"],"summary":"List employee unemployments","description":"\nRequired User Permissions: Regulación de Empleo","operationId":"EmployeesUnemployment_GetEmployeeUnemployments","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee unemployments information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UnemploymentDigestResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UnemploymentDigestResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/unemployments/{unemploymentId}":{"get":{"tags":["Employees - Unemployments"],"summary":"Get employee unemployment","description":"\nRequired User Permissions: Regulación de Empleo","operationId":"EmployeesUnemployment_GetEmployeeUnemployment","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"unemploymentId","in":"path","description":"unemployment id","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns unemployment information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnemploymentResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UnemploymentResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["Employees - Unemployments"],"summary":"Update employee unemployment","description":"\nRequired User Permissions: Regulación de Empleo","operationId":"EmployeesUnemployment_PutEmployeeUnemployment","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"unemploymentId","in":"path","description":"unemployment id","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"unemployment info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnemploymentResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UnemploymentResource"}}},"required":true,"x-bodyName":"unemployment"},"responses":{"200":{"description":"Returns operation status","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/unemployments/{startDate}/{endDate}":{"get":{"tags":["Employees - Unemployments"],"summary":"List unemployments by period","description":"\nRequired User Permissions: Regulación de Empleo","operationId":"EmployeesUnemployment_GetCompanyUnemployments","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"startDate","in":"path","description":"start date","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"endDate","in":"path","description":"end date","required":true,"schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns company unemployments information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UnemploymentDigestResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UnemploymentDigestResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/workplaces/{workplacecode}/unemployments/{startDate}/{endDate}":{"get":{"tags":["Employees - Unemployments"],"summary":"List unemployments by period for workplace","description":"\nRequired User Permissions: Regulación de Empleo","operationId":"EmployeesUnemployment_GetWorkplaceUnemployments","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"workplacecode","in":"path","description":"workplace code","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"startDate","in":"path","description":"start date","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"endDate","in":"path","description":"end date","required":true,"schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns workplace unemployments information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UnemploymentDigestResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UnemploymentDigestResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/pays":{"get":{"tags":["Pays"],"summary":"List employee pays","description":"\nRequired User Permissions: Histórico de Cobro","operationId":"PayInfo_GetPaysStartDateEndDateTypeids","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"startDate","in":"query","description":"(Optional) Start of date range to return","schema":{"type":"string","format":"date-time"}},{"name":"endDate","in":"query","description":"(Optional) End of date range to return","schema":{"type":"string","format":"date-time"}},{"name":"payTypeId","in":"query","style":"form","schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"name":"workplaceCode","in":"query","style":"form","schema":{"type":"array","items":{"type":"string"}}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns Pays","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PayModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PayModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/pays/{payid}/paySubclassifications":{"get":{"tags":["Pays"],"summary":"Get pay sub-classifications","description":"\nRequired User Permissions: Histórico de Cobro / Datos Trabajador","operationId":"PayInfo_GetPaysSubClassifications","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"payid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns PayConcepts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PaySubClassificationsModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PaySubClassificationsModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/pays/{payid}/bonifications":{"get":{"tags":["Pays"],"summary":"Get pay bonifications","description":"\nRequired User Permissions: Histórico de Cobro / Bases e Importes","operationId":"PayInfo_GetPaysBonifications","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"payid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns PayBonifications","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PayBonificationsModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PayBonificationsModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/pays/{payid}/arrestimports":{"get":{"tags":["Pays"],"summary":"Get pay arrest imports","description":"\nRequired User Permissions: Histórico de Cobro / Anticipos, Préstamos y Embargos","operationId":"PayInfo_GetArrestImports","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"payid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns Arrest Imports","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnArrestImports"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ReturnArrestImports"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/pays/{payid}/accrueds":{"get":{"tags":["Pays"],"summary":"Get pay accrueds","description":"\nRequired User Permissions: Histórico de Cobro / Período","operationId":"PayInfo_GetEmployeePayAccrueds","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"payid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns Pay Accrueds","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PayAccrueds"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PayAccrueds"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/pays/{payid}/accrueds-report":{"get":{"tags":["Pays"],"summary":"Get pay accrueds report","description":"\nRequired User Permissions: Histórico de Cobro / Período","operationId":"PayInfo_GetEmployeePayAccrualInfo","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"payid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns Pay Accrueds","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PayAccrualInfo"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PayAccrualInfo"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/pays/{payid}/paydata":{"get":{"tags":["Pays"],"summary":"Get pay data","description":"\nRequired User Permissions: Histórico de Cobro / Datos Trabajador","operationId":"PayInfo_GetEmployeePayData","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"payid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employe pay data","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeePayData"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeePayData"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/pays/{year}/{month}":{"get":{"tags":["Pays"],"summary":"List company pays by month","description":"\nRequired User Permissions: Histórico de Cobro","operationId":"PayInfo_GetCompanyPayData","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"year","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"month","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"name":"workplaceCode","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"payTypeId","in":"query","style":"form","schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employe pay data","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CompanyPayData"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CompanyPayData"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/pays/{payid}/daysinfo":{"get":{"tags":["Pays"],"summary":"Get pay days info","description":"\nRequired User Permissions: Histórico de Cobro / Período","operationId":"PayInfo_GetEmployeeHistoricPayDaysInfo","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"payid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee pay days info for pay id","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HistoricPayDaysInfoResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HistoricPayDaysInfoResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/pays/{payid}/concepts":{"get":{"tags":["Pays - Concepts"],"summary":"List pay concepts","description":"\nRequired User Permissions: Histórico de Cobro / Nómina","operationId":"PayInfo_GetPaysConcept","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"payid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns PayConcepts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PayConceptsModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PayConceptsModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/pays/{payid}/calculatedinternalconcepts":{"get":{"tags":["Pays - Concepts"],"summary":"List pay internal calculated concepts","description":"\nRequired User Permissions: Histórico de Cobro / Nómina","operationId":"PayInfo_GetCalculatedInternalConcepts","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"payid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns Calculated Internal Concepts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CalculatedInternalConceptsModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CalculatedInternalConceptsModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/pays/{payid}/calculatedinternalconcepts/{internalconceptcodes}":{"get":{"tags":["Pays - Concepts"],"summary":"List pay internal calculated concepts filtered","description":"\nRequired User Permissions: Histórico de Cobro / Nómina","operationId":"PayInfo_GetCalculatedInternalConceptsFitlered","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"payid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"internalconceptcodes","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns Calculated Internal Concepts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CalculatedInternalConceptsModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CalculatedInternalConceptsModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/create-professional":{"post":{"tags":["Professionals"],"summary":"Create or update a list of professionals","description":"\nRequired User Permissions: Personas","operationId":"CompaniesEmployees_ImportProfessional","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"Incoming list of professionals","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DtoProfessional"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DtoProfessional"}}}},"required":true,"x-bodyName":"newProfessionals"},"responses":{"200":{"description":"Professionals created","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CreatedProfessional"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CreatedProfessional"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/professionalIRPFData/{periodStart}/{periodEnd}":{"get":{"tags":["Professionals"],"summary":"Get professional IRPF data history","description":"\nRequired User Permissions: Ficha de Persona / Bases IRPF","operationId":"CompaniesEmployees_GetProfessionalIRPFPeriods","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"periodStart","in":"path","description":"Start period (format 01-2024)","required":true,"schema":{"type":"string"}},{"name":"periodEnd","in":"path","description":"End period (format 01-2024)","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Irpf Periods","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DtoIRPFPeriodReturn"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DtoIRPFPeriodReturn"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/professionalIRPFData":{"get":{"tags":["Professionals"],"summary":"Get professional IRPF data","description":"\nRequired User Permissions: Ficha de Persona / Tributación","operationId":"CompaniesEmployees_GetProfessionalIRPFData","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Irpf Data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DtoIRPFData"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DtoIRPFData"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/security/{userId}/allowed-companies":{"get":{"tags":["Security"],"summary":"List allowed companies for user","description":"\nRequired User Permissions: Mantenimiento de Usuarios","operationId":"Security_GetAllowedCompanies","parameters":[{"name":"userId","in":"path","description":"","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"list of allowed companies","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/KeyValuePairInt32String"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/KeyValuePairInt32String"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/security/{userId}/allowed-companies/{companyCode}/allowed-workplaces":{"get":{"tags":["Security"],"summary":"List allowed workplaces for user","description":"\nRequired User Permissions: Mantenimiento de Usuarios","operationId":"Security_GetAllowedWorkplaces","parameters":[{"name":"userId","in":"path","description":"user id","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"list of allowed workplaces","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/temporarydisabilities/{year}/{month}":{"get":{"tags":["Temporary Disabilities (IT)"],"summary":"List temporary disabilities by company","description":"\nRequired User Permissions: IT y Absentismos","operationId":"CompanyTemporaryDisabilities_GetTemporaryDisabilitiesForMonthCompany","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"year","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"month","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/pageNumber"},{"name":"lastUpdate","in":"query","schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns a list of incidents","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemporaryDisability"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemporaryDisability"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/workplaces/{workplacecode}/temporarydisabilities/{year}/{month}":{"get":{"tags":["Temporary Disabilities (IT)"],"summary":"List temporary disabilities by workplace","description":"\nRequired User Permissions: IT y Absentismos","operationId":"CompanyTemporaryDisabilities_GetTemporaryDisabilitiesForMonthWorkplace","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"workplacecode","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"year","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"month","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/pageNumber"},{"name":"lastUpdate","in":"query","schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns a list of temporary disabilities","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemporaryDisability"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemporaryDisability"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporaryDisabilities/{year}":{"get":{"tags":["Temporary Disabilities (IT)"],"summary":"List temporary disabilities by employee","description":"GET /api/companies/258/employees/000049/temporaryDisabilities/2019<br />\nRequired User Permissions: IT y Absentismos","operationId":"EmployeesTemporaryDiabilities_GetEmployeeTemporaryDisabilitiesForYear","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"year","in":"path","description":"Year","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee medical checkup information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemporaryDisability"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemporaryDisability"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporaryDisabilities/detail/{temporarydisabilityID}":{"get":{"tags":["Temporary Disabilities (IT)"],"summary":"Get temporary disability","description":"GET /api/companies/258/employees/000049/temporaryDisabilities/detail/90668c95-4dd8-45d4-956b-1c27604c8929<br />\nRequired User Permissions: IT y Absentismos","operationId":"EmployeesTemporaryDiabilities_GetEmployeeTempDisability","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"temporarydisabilityID","in":"path","description":"Temporary disability id","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns temporary disability for the id provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TDDetail"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TDDetail"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/accidents":{"get":{"tags":["Temporary Disabilities (IT) - Accidents"],"summary":"List IT accidents","description":"GET /api/companies/11902/employees/000005/temporarydisabilities/accidents<br />\nRequired User Permissions: IT y Absentismos","operationId":"AccidentsCollection_GetCollectionAccidents","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/orderBy"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employees temporary disabilities accidents collection","headers":{"x-pagination":{"description":"Collection pagination","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccidentsCollectionResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccidentsCollectionResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["Temporary Disabilities (IT) - Accidents"],"summary":"Create IT accident","description":"POST /api/companies/11902/employees/000005/temporarydisabilities/accidents<br />\r\n{<br />\r\n   \"inputData\": \"<br />\r\n     {<br />        \r\n         \"startDate\": \"2019-04-01T10:00:00.000Z\",<br />\r\n         \"endDate\": \"2019-04-01T10:00:00.000Z\",<br />\r\n         \"benefitType\": \"Direct payment\",<br />\r\n         \"indComplement\": \"true\",<br />        \r\n     }\"<br />\r\n}<br />\nRequired User Permissions: IT y Absentismos","operationId":"Accidents_PostAccident","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"Accident code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccidentsResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AccidentsResource"}}},"required":true,"x-bodyName":"Accident"},"responses":{"200":{"description":"Creates employee accident","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccidentsResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AccidentsResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/accidents/{accidentid}":{"get":{"tags":["Temporary Disabilities (IT) - Accidents"],"summary":"Get IT accident","description":"GET /api/companies/11902/employees/000005/temporarydisabilities/accidents/{accidentid}<br />\nRequired User Permissions: IT y Absentismos","operationId":"Accidents_GetAccident","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"accidentid","in":"path","description":"accidentid","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee temporary disability accident data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccidentsResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AccidentsResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["Temporary Disabilities (IT) - Accidents"],"summary":"Delete IT accident","description":"     DELETE /api/companies/11902/employees/000005/temporarydisabilities/accidents/77573DE9-84F5-49F8-AE17-86B96F807598<br />\r\n_RemovePaysConcept\nRequired User Permissions: IT y Absentismos / ITs y Absentismos","operationId":"Accidents_DeleteAccident","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"accidentid","in":"path","description":"Illness id","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Deletes an employee illness","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/accidents/{temporarydisabilityId}":{"put":{"tags":["Temporary Disabilities (IT) - Accidents"],"summary":"Update IT accident (end date)","description":"\nRequired User Permissions: IT y Absentismos","operationId":"Accidents_PutAccident","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"temporarydisabilityId","in":"path","description":"","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"Accident code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TDUpdate"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TDUpdate"}}},"required":true,"x-bodyName":"Accident"},"responses":{"200":{"description":"Updated employee accident","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/birthpermits":{"get":{"tags":["Temporary Disabilities (IT) - Birth permits"],"summary":"List IT birth permits","description":"GET /api/companies/11902/employees/000005/temporarydisabilities/birthpermits<br />\nRequired User Permissions: IT y Absentismos","operationId":"BirthPermitsCollection_GetCollectionBirthPermits","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/orderBy"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employees temporary disabilities birth permits collection","headers":{"x-pagination":{"description":"Collection pagination","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BirthPermitsCollectionResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BirthPermitsCollectionResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["Temporary Disabilities (IT) - Birth permits"],"summary":"Create IT birth permit","description":"POST /api/companies/11902/employees/000005/temporarydisabilities/birthpermits<br />\r\n{<br />\r\n   \"inputData\": \"<br />\r\n     {<br />        \r\n         \"startDate\": \"2019-04-01T10:00:00.000Z\",<br />\r\n         \"incidentTypeId\": \"Biological Mother\"<br />        \r\n     }\"<br />\r\n}<br />\nRequired User Permissions: IT y Absentismos","operationId":"BirthPermits_PostBirthPermit","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BirthPermitsResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BirthPermitsResource"}}},"required":true,"x-bodyName":"BirthPermit"},"responses":{"200":{"description":"Creates employee birth permit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BirthPermitsResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BirthPermitsResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/birthpermits/{temporarydissabilityID}":{"put":{"tags":["Temporary Disabilities (IT) - Birth permits"],"summary":"Update IT birth permit","description":"\nRequired User Permissions: IT y Absentismos","operationId":"BirthPermits_PutBirthPermit","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"temporarydissabilityID","in":"path","description":"Temporary Dissability Id","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BirthPermitModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BirthPermitModel"}}},"required":true,"x-bodyName":"birthPermit"},"responses":{"200":{"description":"Creates employee birth permit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BirthPermitModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BirthPermitModel"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["Temporary Disabilities (IT) - Birth permits"],"summary":"Delete IT birth permit","description":"DELETE /api/companies/36511/employees/000002//temporarydisabilities/birthpermits/{temporarydissabilityID}<br />\nRequired User Permissions: IT y Absentismos","operationId":"BirthPermits_DeleteMethodDetail","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"temporarydissabilityID","in":"path","description":"Birth permit id","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"204":{"description":"Delete employee birth permit successfully","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/illnesses/{illnessid}":{"get":{"tags":["Temporary Disabilities (IT) - Illnesses"],"summary":"Get IT Illness","description":"GET /api/companies/11902/employees/000005/temporarydisabilities/illnesses/{illnessid}<br />\nRequired User Permissions: IT y Absentismos","operationId":"Illnesses_GetIllness","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"illnessid","in":"path","description":"illnessid","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee temporary disability illness data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IllnessesResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/IllnessesResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["Temporary Disabilities (IT) - Illnesses"],"summary":"Delete IT Illness","description":"DELETE /api/companies/11902/employees/000005/temporarydisabilities/illnesses/77573DE9-84F5-49F8-AE17-86B96F807598<br />\nRequired User Permissions: IT y Absentismos","operationId":"Illnesses_DeleteIllness","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"illnessid","in":"path","description":"Illness id","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Deletes an employee illness","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/illnesses":{"get":{"tags":["Temporary Disabilities (IT) - Illnesses"],"summary":"List IT Illnesses","description":"GET /api/companies/11902/employees/000005/temporarydisabilities/illnesses<br />\nRequired User Permissions: IT y Absentismos","operationId":"IllnessesCollection_GetCollectionIllnesses","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/orderBy"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employees temporary disabilities illnesses collection","headers":{"x-pagination":{"description":"Collection pagination","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IllnessesCollectionResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IllnessesCollectionResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["Temporary Disabilities (IT) - Illnesses"],"summary":"Create IT Illness","description":"POST /api/companies/11902/employees/000005/temporarydisabilities/illnesses<br />\r\n{<br />\r\n   \"inputData\": \"<br />\r\n     {<br />        \r\n         \"startDate\": \"2019-04-01T10:00:00.000Z\",<br />\r\n         \"endDate\": \"2019-04-01T10:00:00.000Z\",<br />\r\n         \"benefitType\": \"Direct payment\",<br />\r\n         \"indComplement\": \"true\",<br />        \r\n     }\"<br />\r\n}<br />\nRequired User Permissions: IT y Absentismos","operationId":"Illnesses_PostIllness","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"Illness code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IllnessesResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/IllnessesResource"}}},"required":true,"x-bodyName":"Illness"},"responses":{"200":{"description":"Creates employee illness","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IllnessesResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/IllnessesResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/illnesses/{temporarydisabilityId}":{"put":{"tags":["Temporary Disabilities (IT) - Illnesses"],"summary":"Update IT Illness (end date)","description":"\nRequired User Permissions: IT y Absentismos","operationId":"Illnesses_PutIllness","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"temporarydisabilityId","in":"path","description":"","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"Accident code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TDUpdate"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TDUpdate"}}},"required":true,"x-bodyName":"Accident"},"responses":{"200":{"description":"Updated employee accident","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/lactancyRisk/{temporarydisabilityID}":{"put":{"tags":["Temporary Disabilities (IT) - Lactancy Risks"],"summary":"Update IT lactancy risk","description":"PUT /api/companies/36511/employees/000002/temporarydisabilities/lactancyRisk/29FCD855-90FB-4511-89B2-18CA008C3CCA<br />\nRequired User Permissions: IT y Absentismos","operationId":"LactancyRisk_PutLactancyRiskForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"temporarydisabilityID","in":"path","description":"LactancyRisk IT ID","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"LactancyRisk IT definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LactancyRiskPut"}},"application/xml":{"schema":{"$ref":"#/components/schemas/LactancyRiskPut"}}},"required":true,"x-bodyName":"lactancyRisk"},"responses":{"200":{"description":"Returns operation status","content":{"application/json":{"schema":{"type":"boolean"}},"application/xml":{"schema":{"type":"boolean"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["Temporary Disabilities (IT) - Lactancy Risks"],"summary":"Delete IT lactancy risk","description":"DELETE /api/companies/36511/employees/000002/temporarydisabilities/lactancyRisk/29FCD855-90FB-4511-89B2-18CA008C3CCA<br />\nRequired User Permissions: IT y Absentismos","operationId":"LactancyRisk_DeleteLactancyRiskForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"temporarydisabilityID","in":"path","description":"LactancyRisk IT ID","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Deleted successfully","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}}}},"204":{"description":"Deleted sucessfully","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/lactancyRisk":{"post":{"tags":["Temporary Disabilities (IT) - Lactancy Risks"],"summary":"Create IT lactancy risk","description":"POST /api/companies/36511/employees/000002/temporarydisabilities/lactancyRisk<br />\nRequired User Permissions: IT y Absentismos","operationId":"LactancyRisk_PostLactancyRiskForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"lactancyRisk IT definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LactancyRisk"}},"application/xml":{"schema":{"$ref":"#/components/schemas/LactancyRisk"}}},"required":true,"x-bodyName":"lactancyRisk"},"responses":{"200":{"description":"Created successfully","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}}}},"201":{"description":"Returns id","content":{"application/json":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/nonworkaccidents":{"get":{"tags":["Temporary Disabilities (IT) - Non work accidents"],"summary":"List IT non work accidents","description":"GET /api/companies/11902/employees/000005/temporarydisabilities/nonworkaccidents<br />\nRequired User Permissions: IT y Absentismos","operationId":"GetNonWorkAccidentsForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/orderBy"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employees temporary disabilities non work accidents collection","headers":{"x-pagination":{"description":"Collection pagination","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NonWorkAccidentsCollectionResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NonWorkAccidentsCollectionResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["Temporary Disabilities (IT) - Non work accidents"],"summary":"Create IT non work accident","description":"POST /api/companies/11902/employees/000005/temporarydisabilities/nonworkaccidents<br />\r\n{<br />\r\n   \"inputData\": \"<br />\r\n     {<br />        \r\n         \"startDate\": \"2019-04-01T10:00:00.000Z\",<br />\r\n         \"endDate\": \"2019-04-01T10:00:00.000Z\",<br />\r\n         \"benefitType\": \"Direct payment\",<br />\r\n         \"indComplement\": \"true\",<br />        \r\n     }\"<br />\r\n}<br />\nRequired User Permissions: IT y Absentismos","operationId":"NonWorkAccidents_PostIllness","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"Nonworkaccident code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NonWorkAccidentsResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/NonWorkAccidentsResource"}}},"required":true,"x-bodyName":"NonWorkAccidents"},"responses":{"200":{"description":"Creates employee illness","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NonWorkAccidentsResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/NonWorkAccidentsResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/nonworkaccidents/{nonworkaccidentID}":{"get":{"tags":["Temporary Disabilities (IT) - Non work accidents"],"summary":"Get IT non work accident","description":"GET /api/companies/11902/employees/000005/temporarydisabilities/nonworkaccidents/{nonworkaccidentID}<br />\nRequired User Permissions: IT y Absentismos","operationId":"NonWorkAccidents_GetNonWorkAccidents","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"nonworkaccidentID","in":"path","description":"nonworkaccidentID","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee temporary disability non work accident data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NonWorkAccidentsResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/NonWorkAccidentsResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["Temporary Disabilities (IT) - Non work accidents"],"summary":"Delete IT non work accident","description":"DELETE /api/companies/11902/employees/000005/temporarydisabilities/nonworkaccidents/77573DE9-84F5-49F8-AE17-86B96F807598<br />\nRequired User Permissions: IT y Absentismos","operationId":"NonWorkAccidents_DeleteIllness","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"nonworkaccidentID","in":"path","description":"Nonworkaccident id","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Deletes an employee illness","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/nonworkaccidents/{temporarydisabilityId}":{"put":{"tags":["Temporary Disabilities (IT) - Non work accidents"],"summary":"Update IT non work accident (end date)","description":"\nRequired User Permissions: IT y Absentismos","operationId":"NonWorkAccidents_PutNonWorkAccident","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"temporarydisabilityId","in":"path","description":"","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"Accident code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TDUpdate"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TDUpdate"}}},"required":true,"x-bodyName":"Accident"},"responses":{"200":{"description":"Updated employee accident","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/partialbirthpermits/{partialBirthPermitId}":{"get":{"tags":["Temporary Disabilities (IT) - Partial birth permits"],"summary":"Get IT partial birth permit","description":"\nRequired User Permissions: IT y Absentismos","operationId":"PartialBirthPermits_GetPartialBirthPermit","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"partialBirthPermitId","in":"path","description":"Birth permit id to retrieve","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns partial birth permit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartialBirthPermitGetEntity"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PartialBirthPermitGetEntity"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"404":{"description":"No partial birth permit found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["Temporary Disabilities (IT) - Partial birth permits"],"summary":"Update IT partial birth permit","description":"\nRequired User Permissions: IT y Absentismos","operationId":"PartialBirthPermits_PutPartialBirthPermit","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"partialBirthPermitId","in":"path","description":"Birth permit id to update","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"Partial birth permit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartialBirthPermitPutEntity"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PartialBirthPermitPutEntity"}}},"required":true,"x-bodyName":"partialBirthPermitEntity"},"responses":{"200":{"description":"Returns partial birth permit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartialBirthPermitGetEntity"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PartialBirthPermitGetEntity"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"404":{"description":"No partial birth permit found to update","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["Temporary Disabilities (IT) - Partial birth permits"],"summary":"Delete IT partial birth permit","description":"\nRequired User Permissions: IT y Absentismos","operationId":"PartialBirthPermits_DeletePartialBirthPermit","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"partialBirthPermitId","in":"path","description":"Birth permit id to remove","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns operation status","content":{"application/json":{"schema":{"type":"boolean"}},"application/xml":{"schema":{"type":"boolean"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"404":{"description":"No partial birth permit found to delete","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/partialbirthpermits":{"post":{"tags":["Temporary Disabilities (IT) - Partial birth permits"],"summary":"Create IT partial birth permit","description":"\nRequired User Permissions: IT y Absentismos","operationId":"PartialBirthPermits_PostPartialBirthPermit","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"Partial birth permit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartialBirthPermitPostEntity"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PartialBirthPermitPostEntity"}}},"required":true,"x-bodyName":"partialBirthPermitEntity"},"responses":{"200":{"description":"Returns partial birth permit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartialBirthPermitGetEntity"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PartialBirthPermitGetEntity"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/pregnancyrisk/{temporarydisabilityID}":{"put":{"tags":["Temporary Disabilities (IT) - Pregnancy Risks"],"summary":"Update IT pregnancy risk","description":"PUT /api/companies/36511/employees/000002/temporarydisabilities/pregnancyrisk/29FCD855-90FB-4511-89B2-18CA008C3CCA<br />\nRequired User Permissions: IT y Absentismos","operationId":"PregnancyRisk_PutPregnancyRiskForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"temporarydisabilityID","in":"path","description":"Pregnancy risk ID","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"Pregnancy risk definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PregnancyRiskPut"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PregnancyRiskPut"}}},"required":true,"x-bodyName":"pregnancyRisk"},"responses":{"200":{"description":"Returns operation status","content":{"application/json":{"schema":{"type":"boolean"}},"application/xml":{"schema":{"type":"boolean"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["Temporary Disabilities (IT) - Pregnancy Risks"],"summary":"Delete IT pregnancy risk","description":"DELETE /api/companies/36511/employees/000002/temporarydisabilities/pregnancyrisk/29FCD855-90FB-4511-89B2-18CA008C3CCA<br />\nRequired User Permissions: IT y Absentismos","operationId":"PregnancyRisk_DeletePregnancyRiskForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"temporarydisabilityID","in":"path","description":"Pregnancy risk ID","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Deleted successfully","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}}}},"204":{"description":"Deleted sucessfully","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/pregnancyrisk":{"post":{"tags":["Temporary Disabilities (IT) - Pregnancy Risks"],"summary":"Create IT pregnancy risk","description":"POST /api/companies/36511/employees/000002/temporarydisabilities/pregnancyrisk<br />\nRequired User Permissions: IT y Absentismos","operationId":"PregnancyRisk_PostPregnancyRiskForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"Pregnancy risk definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PregnancyRisk"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PregnancyRisk"}}},"required":true,"x-bodyName":"pregnancyRisk"},"responses":{"200":{"description":"Created successfully","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}}}},"201":{"description":"Returns id","content":{"application/json":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/pregnancyrisks":{"get":{"tags":["Temporary Disabilities (IT) - Pregnancy Risks"],"summary":"List IT pregnancy risk","description":"GET /api/companies/11902/employees/000005/temporarydisabilities/pregnancyrisks<br />","operationId":"PregnancyRisksCollection_GetCollectionPregnancyRisks","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/orderBy"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employees temporary disabilities accidents collection","headers":{"x-pagination":{"description":"Collection pagination","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PregnancyRisksCollectionResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PregnancyRisksCollectionResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized.","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/professionalillnesses":{"get":{"tags":["Temporary Disabilities (IT) - Professional Illnesses"],"summary":"List IT professional Illnesses","description":"GET /api/companies/11902/employees/000005/temporarydisabilities/professionalillnesses<br />\nRequired User Permissions: IT y Absentismos","operationId":"ProfessionalIllnessesCollection_GetCollectionProfessionalIllnesses","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/orderBy"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employees temporary disabilities professional illnesses collection","headers":{"x-pagination":{"description":"Collection pagination","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProfessionalIllnessesCollectionResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProfessionalIllnessesCollectionResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"post":{"tags":["Temporary Disabilities (IT) - Professional Illnesses"],"summary":"Create IT professional illness","description":"POST /api/companies/11902/employees/000005/temporarydisabilities/professionalillnesses<br />\r\n{<br />\r\n   \"inputData\": \"<br />\r\n     {<br />        \r\n         \"startDate\": \"2019-04-01T10:00:00.000Z\",<br />\r\n         \"endDate\": \"2019-04-01T10:00:00.000Z\",<br />\r\n         \"benefitType\": \"Direct payment\",<br />\r\n         \"indComplement\": \"true\",<br />        \r\n     }\"<br />\r\n}<br />\nRequired User Permissions: IT y Absentismos","operationId":"ProfessionalIllnesses_PostIllness","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"Professional Illness code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfessionalIllnessesResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ProfessionalIllnessesResource"}}},"required":true,"x-bodyName":"ProfessionalIllness"},"responses":{"200":{"description":"Creates employee illness","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfessionalIllnessesResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ProfessionalIllnessesResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/professionalillnesses/{professionalIllnessId}":{"get":{"tags":["Temporary Disabilities (IT) - Professional Illnesses"],"summary":"Get IT professional illness","description":"GET /api/companies/11902/employees/000005/temporarydisabilities/professionalillnesses/{professionalillnessid}<br />\nRequired User Permissions: IT y Absentismos","operationId":"ProfessionalIllnesses_GetProfessionalIllness","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"professionalIllnessId","in":"path","description":"professionalillnessid","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee temporary disability professional illness data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfessionalIllnessesResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ProfessionalIllnessesResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/professionalillnesses/{temporarydisabilityId}":{"put":{"tags":["Temporary Disabilities (IT) - Professional Illnesses"],"summary":"Update IT professional illness (end date)","description":"\nRequired User Permissions: IT y Absentismos","operationId":"ProfessionalIllnesses_PutProfIllness","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"temporarydisabilityId","in":"path","description":"","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"Accident code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TDUpdate"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TDUpdate"}}},"required":true,"x-bodyName":"Accident"},"responses":{"200":{"description":"Updated employee accident","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/{temporaryDisabilityID}/relapse":{"post":{"tags":["Temporary Disabilities (IT) - Relapses"],"summary":"Create Relapse IT","description":"\nRequired User Permissions: IT y Absentismos","operationId":"CompanyTemporaryDisabilities_PostRelapseForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"temporaryDisabilityID","in":"path","description":"parent temporaryDisabilityID","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"Relapse Data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Relapse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Relapse"}}},"required":true,"x-bodyName":"relapse"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}}}},"201":{"description":"Returns id","content":{"application/json":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/special/{temporarydisabilityID}":{"put":{"tags":["Temporary Disabilities (IT) - Special situation"],"summary":"Update IT Special situation","description":"PUT /api/companies/36511/employees/000002/temporarydisabilities/special/29FCD855-90FB-4511-89B2-18CA008C3CCA<br />\nRequired User Permissions: IT y Absentismos","operationId":"Special_PutSpecialForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"temporarydisabilityID","in":"path","description":"special IT ID","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"special IT definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpecialPut"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SpecialPut"}}},"required":true,"x-bodyName":"special"},"responses":{"200":{"description":"Returns operation status","content":{"application/json":{"schema":{"type":"boolean"}},"application/xml":{"schema":{"type":"boolean"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["Temporary Disabilities (IT) - Special situation"],"summary":"Delete IT Special situation","description":"DELETE /api/companies/36511/employees/000002/temporarydisabilities/special/29FCD855-90FB-4511-89B2-18CA008C3CCA<br />\nRequired User Permissions: IT y Absentismos","operationId":"Special_DeleteSpecialForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"temporarydisabilityID","in":"path","description":"special IT ID","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Deleted successfully","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}}}},"204":{"description":"Deleted sucessfully","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/temporarydisabilities/special":{"post":{"tags":["Temporary Disabilities (IT) - Special situation"],"summary":"Create IT Special situation","description":"POST /api/companies/36511/employees/000002/temporarydisabilities/special<br />\nRequired User Permissions: IT y Absentismos","operationId":"Special_PostSpecialForEmployee","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"special IT definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Special"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Special"}}},"required":true,"x-bodyName":"special"},"responses":{"200":{"description":"Created successfully","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}}}},"201":{"description":"Returns id","content":{"application/json":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/training/centers/{centerCode}/years/{year}/groups":{"get":{"tags":["Training"],"summary":"List training groups","description":"\nRequired User Permissions: Centros de Formación","operationId":"Training_GetTrainingGroups","parameters":[{"name":"centerCode","in":"path","description":"training center code","required":true,"schema":{"type":"string"}},{"name":"year","in":"path","description":"year","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns training center groups","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrainingGroupDigestResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TrainingGroupDigestResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/training/centers":{"get":{"tags":["Training"],"summary":"List training centers","description":"\nRequired User Permissions: Centros de Formación","operationId":"Training_GetTrainingCenters","parameters":[{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns training centers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrainingCenterDigestResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TrainingCenterDigestResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/training/centers/{centerCode}/years/{year}/groups/{groupCode}":{"get":{"tags":["Training"],"summary":"Get training group","description":"\nRequired User Permissions: Centros de Formación","operationId":"Training_GetTrainingGroup","parameters":[{"name":"centerCode","in":"path","description":"training center code","required":true,"schema":{"type":"string"}},{"name":"year","in":"path","description":"year","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"groupCode","in":"path","description":"traing group code","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns training group information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrainingGroupResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TrainingGroupResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/training/centers/{centerCode}/years/{year}/groups/{groupCode}/participants":{"get":{"tags":["Training"],"summary":"List participants for a training group","description":"\nRequired User Permissions: Centros de Formación","operationId":"Training_GetTrainingGroupParticipants","parameters":[{"name":"centerCode","in":"path","description":"training center code","required":true,"schema":{"type":"string"}},{"name":"year","in":"path","description":"year","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"groupCode","in":"path","description":"training group code","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns training group participants","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrainingGroupParticitpantDigestResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TrainingGroupParticitpantDigestResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/training/centers/{centerCode}/years/{year}/groups/{groupCode}/participants/{companyCode}/{workplaceCode}/{employeeCode}":{"get":{"tags":["Training"],"summary":"Get training group participant","description":"\nRequired User Permissions: Centros de Formación","operationId":"Training_GetTrainingGroupParticipant","parameters":[{"name":"centerCode","in":"path","description":"training center code","required":true,"schema":{"type":"string"}},{"name":"year","in":"path","description":"year","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"groupCode","in":"path","description":"training group code","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/companyCode"},{"name":"workplaceCode","in":"path","description":"workplace code","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns training group participant information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrainingGroupParticitpantResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TrainingGroupParticitpantResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"put":{"tags":["Training"],"summary":"Create participant training group","description":"\nRequired User Permissions: Centros de Formación","operationId":"Training_PutTrainingGroupParticipant","parameters":[{"name":"centerCode","in":"path","description":"training center code","required":true,"schema":{"type":"string"}},{"name":"year","in":"path","description":"year","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"groupCode","in":"path","description":"training ggroup code","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/companyCode"},{"name":"workplaceCode","in":"path","description":"workpalce code","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"training group participant","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrainingGroupParticitpantResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TrainingGroupParticitpantResource"}}},"required":true,"x-bodyName":"trainingGroupParticitpant"},"responses":{"200":{"description":"Updates training group participant information","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["Training"],"summary":"Delete participant training group","description":"\nRequired User Permissions: Centros de Formación","operationId":"Training_RemoveTrainingGroupParticipant","parameters":[{"name":"centerCode","in":"path","description":"training center code","required":true,"schema":{"type":"string"}},{"name":"year","in":"path","description":"year","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"groupCode","in":"path","description":"training group code","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/companyCode"},{"name":"workplaceCode","in":"path","description":"workplace code","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Updates training group participant information","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/training/centers/{centerCode}/years/{year}/groups/{groupCode}/actions":{"get":{"tags":["Training"],"summary":"List training group actions","description":"\nRequired User Permissions: Centros de Formación","operationId":"Training_GetTrainingGroupActions","parameters":[{"name":"centerCode","in":"path","description":"training center code","required":true,"schema":{"type":"string"}},{"name":"year","in":"path","description":"year","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"groupCode","in":"path","description":"training group code","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns training group actions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrainingActionDigestResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TrainingActionDigestResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/training/centers/{centerCode}/years/{year}/groups/{groupCode}/actions/{actionCode}":{"get":{"tags":["Training"],"summary":"Get training group action","description":"\nRequired User Permissions: Centros de Formación","operationId":"Training_GetTrainingGroupAction","parameters":[{"name":"centerCode","in":"path","description":"training center code","required":true,"schema":{"type":"string"}},{"name":"year","in":"path","description":"year","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"groupCode","in":"path","description":"training group code","required":true,"schema":{"type":"string"}},{"name":"actionCode","in":"path","description":"training action code","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns training group action information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrainingActionResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TrainingActionResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/training/centers/{centerCode}":{"get":{"tags":["Training"],"summary":"Get training center","description":"\nRequired User Permissions: Centros de Formación","operationId":"Training_GetTrainingCenter","parameters":[{"name":"centerCode","in":"path","description":"training center code","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns training center information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrainingCenterResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TrainingCenterResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/training/centers/{centerCode}/years":{"get":{"tags":["Training"],"summary":"List years of operation for training center","description":"\nRequired User Permissions: Centros de Formación","operationId":"Training_GetTrainingYears","parameters":[{"name":"centerCode","in":"path","description":"training center code","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns training center active years","content":{"application/json":{"schema":{"type":"integer","format":"int32"}},"application/xml":{"schema":{"type":"integer","format":"int32"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/training/groups/{year}":{"get":{"tags":["Training"],"summary":"List training groups by year","operationId":"Training_GetTrainingGroupsForYear","parameters":[{"name":"year","in":"path","description":"year","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns training centers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrainingGroupForYear"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TrainingGroupForYear"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/training/groups/{groupId}/participants":{"get":{"tags":["Training"],"summary":"List participants for a training group","operationId":"Training_GetTrainingGroupParticipantsForGroupId","parameters":[{"name":"groupId","in":"path","description":"group id","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns training centers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrainingGroupParticipantById"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TrainingGroupParticipantById"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/variableconcepts/{variableconceptcode}":{"get":{"tags":["Variable concepts"],"summary":"Get employee variable concept","description":"GET /api/companies/258/employees/000049/variableconcept/25C3D5F6-4BC5-42FD-9610-0000EA087647<br />\nRequired User Permissions: Conceptos Variables","operationId":"EmployeesVariableConcepts_GetVariableConcept","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"variableconceptcode","in":"path","description":"variable concept code","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/pageNumber"},{"name":"startDate","in":"query","description":"start date (optional)","schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee variable concept","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VariableConceptsResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VariableConceptsResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}},"delete":{"tags":["Variable concepts"],"summary":"Delete employee variable concept","description":"DELETE /api/companies/258/employees/000049/variableconcept/25C3D5F6-4BC5-42FD-9610-0000EA087647<br />\nRequired User Permissions: Conceptos Variables","operationId":"EmployeesVariableConcepts_DeleteVariableConcept","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"variableconceptcode","in":"path","description":"Variable concept code","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"204":{"description":"Delete employee variable concept successfully","content":{"application/json":{},"application/xml":{}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/variableconcepts/{startDate}/{endDate}":{"get":{"tags":["Variable concepts"],"summary":"List employee variable concepts","description":"GET /api/companies/258/employees/000049/variableconcepts<br />\nRequired User Permissions: Conceptos Variables","operationId":"EmployeesVariableConcepts_GetVariableConceptInDateRange","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"name":"startDate","in":"path","description":"Start date","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"endDate","in":"path","description":"End date","required":true,"schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns employee variable concept","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VariableConceptsResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VariableConceptsResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/employees/{employeeCode}/variableconcepts":{"post":{"tags":["Variable concepts"],"summary":"Create employee variable concept","description":"POST /api/companies/258/employees/000049/variableconcept<br />\r\n{<br />\r\n   \"inputData\": \"<br />\r\n     {<br />\r\n         \"conceptCode\": 1,<br />\r\n         \"startDate\": \"2019-04-01T10:00:00.000Z\",<br />\r\n         \"endDate\": \"2019-04-01T10:00:00.000Z\",<br />\r\n         \"collectionDate\": \"2019-04-01T10:00:00.000Z\",<br />\r\n         \"payTypeId\": 1,<br />\r\n         \"amount\": 5,<br />\r\n         \"units\": 1, <br />\r\n         \"prorateInPaySections\": \"false\", <br />\r\n         \"attribution\": \"030101\", <br />\r\n         \"enrolmentDropProrate\": \"false\" <br />\r\n     }\"<br />\r\n}<br />\nRequired User Permissions: Conceptos Variables","operationId":"EmployeesVariableConcepts_PostVariableConcept","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/employeeCode"},{"$ref":"#/components/parameters/api-version"}],"requestBody":{"description":"variable concept code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewVariableConceptsResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/NewVariableConceptsResource"}}},"required":true,"x-bodyName":"variableconcept"},"responses":{"200":{"description":"Creates employee variable concept","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariableConceptsResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/VariableConceptsResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"423":{"description":"Locked","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/workplaces":{"get":{"tags":["Workplaces"],"summary":"List workplaces","description":"GET /api/companies/258/Workplaces<br />\r\n{<br />\r\n   \"filter\": \"workplaceCode eq 1 and (dropDate eq null or dropDate ge 2001-02-28)\",<br />\r\n   \"orderBy\": \"workplaceCode asc\"<br />\r\n   \"pageNumber\": 1,<br />\r\n   \"pageSize\": 25,<br />\r\n}<br />\nRequired User Permissions: Listado de Centros","operationId":"CompaniesWorkplacesCollection_GetCollectionWorkplaces","parameters":[{"$ref":"#/components/parameters/companyCode"},{"$ref":"#/components/parameters/pageNumber"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/orderBy"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns workplaces data","headers":{"x-pagination":{"description":"Collection pagination","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CompanyWorkplacesCollectionResource"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CompanyWorkplacesCollectionResource"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/workplaces/{workplacecode}/contactdata/address":{"get":{"tags":["Workplaces"],"summary":"Get workplace address","description":"GET /api/companies/90001/workplaces/1/contactdata/address<br />\nRequired User Permissions: Ficha de Empresa / Centros de Trabajo","operationId":"CompanyWorkplacesAddressEntity_GetCompanyWorkplaceAddressInformation","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"workplacecode","in":"path","description":"Workplace code","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns workplace address","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyWorkplacesAddressEntityResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CompanyWorkplacesAddressEntityResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"404":{"description":"Not found","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/workplaces/{workplacecode}/sspaymentnumbers":{"get":{"tags":["Workplaces"],"summary":"List workplace Social Security numbers","description":"\nRequired User Permissions: Ficha de Empresa / Cotización","operationId":"PayInfo_GetSSPaymentNumberIDsForWorkplace","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"workplacecode","in":"path","description":"workplace code","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns SSPayment numbers","content":{"application/json":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}},"application/xml":{"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/workplaces/{workplacecode}/sspaymentnumbers/{sspaymentnumberid}":{"get":{"tags":["Workplaces"],"summary":"Get workplace Social Security number","description":"\nRequired User Permissions: Ficha de Empresa / Cotización","operationId":"PayInfo_GetSSPaymentNumberDetailsForWorkplace","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"workplacecode","in":"path","description":"workplace code","required":true,"schema":{"type":"string"}},{"name":"sspaymentnumberid","in":"path","description":"sspaymentnumber id","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns SSPayment number details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CCCDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CCCDetails"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/workplaces/{companyWorkplaceCode}/bankaccounts":{"get":{"tags":["Workplaces"],"summary":"List workplace bank accounts","description":"\nRequired User Permissions: Ficha de Empresa / Formas de pago","operationId":"CompanyWorkplaceBanking_GetCompanyWorkplaceBankAccounts","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"companyWorkplaceCode","in":"path","description":"workplace code","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns bank account codes for company workplace","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkplaceBankAccountCodeModel"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkplaceBankAccountCodeModel"}}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/workplaces/{companyWorkplaceCode}/bankaccounts/{bankAccountCode}":{"get":{"tags":["Workplaces"],"summary":"Get workplace bank account","description":"\nRequired User Permissions: Ficha de Empresa / Formas de pago","operationId":"CompanyWorkplaceBanking_GetCompanyWorkplaceBankAccount","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"companyWorkplaceCode","in":"path","description":"workplace code","required":true,"schema":{"type":"string"}},{"name":"bankAccountCode","in":"path","description":"bank account code","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns bank account information for company work place","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkplaceBankAccountModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/WorkplaceBankAccountModel"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}},"/api/companies/{companyCode}/workplaces/{workplacecode}/datacontact":{"get":{"tags":["Workplaces"],"summary":"Get workplace data contact","description":"GET /api/companies/258/workplaces/1/datacontact<br />\nRequired User Permissions: Ficha de Empresa / Centros de Trabajo","operationId":"CompanyWorkplaceDataContact_GetWorkplaceDataContact","parameters":[{"$ref":"#/components/parameters/companyCode"},{"name":"workplacecode","in":"path","description":"","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"Returns workplaces data","headers":{"x-pagination":{"description":"Collection pagination","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyWorkplacesDataContactResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CompanyWorkplacesDataContactResource"}}}},"400":{"description":"Invalid input parameters","content":{"application/json":{},"application/xml":{}}},"401":{"description":"Unauthorized","content":{"application/json":{},"application/xml":{}}},"500":{"description":"Internal server error","content":{"application/json":{},"application/xml":{}}}}}}},"components":{"schemas":{"AgreementModel":{"type":"object","properties":{"agreementID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"description":{"type":"string"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"holidaysDaysNumber":{"type":"integer","format":"int32"},"holidaysDaysType":{"type":"string"},"workingHours":{"type":"integer","format":"int32"},"revision":{"type":"integer","format":"int32"}}},"PayGroupModel":{"type":"object","properties":{"description":{"type":"string"},"groupID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"revision":{"type":"integer","format":"int32"}}},"CalendarDayTypeModel":{"type":"object","properties":{"dayTypeID":{"type":"integer","format":"int32","readOnly":true},"description":{"type":"string","readOnly":true}}},"CalendarWorkDayTypeModel":{"type":"object","properties":{"workDayTypeID":{"type":"integer","format":"int32","readOnly":true},"description":{"type":"string","readOnly":true}}},"NonWorkAccidentsCollectionResource":{"type":"object","properties":{"nonWorkAccidentId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"lastUpdate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}}},"NonWorkAccidentsResource":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"benefitTypeID":{"enum":["Delegated Payment","No Right to Benefit","Direct payment"],"type":"string"},"indComplement":{"type":"boolean"}},"example":{"startDate":"2019-10-01T00:00:00.0000000+00:00","endDate":"2019-10-31T00:00:00.0000000+00:00","benefitTypeID":"No Right to Benefit","indComplement":true}},"EmployeeAgreement":{"type":"object","properties":{"agreementID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"agreementCode":{"type":"string"},"agreementDescription":{"type":"string"},"classificationID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"classificationCode":{"type":"string"},"subClassificationCode":{"type":"string"},"classificationDescription":{"type":"string"},"revision":{"type":"integer","format":"int32"}}},"EmployeeAgreementInfo":{"type":"object","properties":{"agreementCode":{"type":"string"},"categoryCode":{"type":"string"},"subCategoryCode":{"type":"string"},"revision":{"type":"integer","format":"int32"}}},"AvailableJobPositionModel":{"type":"object","properties":{"jobCode":{"type":"string"},"jobDescription":{"type":"string"}}},"RegimeModel":{"type":"object","properties":{"regimeID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"description":{"type":"string"}}},"TariffGroupModel":{"type":"object","properties":{"contributionGroupID":{"type":"integer","format":"int32"},"description":{"type":"string"}}},"OccupationPercentageModel":{"type":"object","properties":{"occupationCode":{"type":"string"},"occupationDescription":{"type":"string"},"percentageIT":{"type":"number","format":"double"},"percentageIMS":{"type":"number","format":"double"}}},"AgreementClassificationModel":{"type":"object","properties":{"classificationID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"classificationCode":{"type":"integer","format":"int32"},"subClassificationCode":{"type":"integer","format":"int32"},"classificationDescription":{"type":"string"},"revision":{"type":"integer","format":"int32"}}},"AgreementRetributedPermissionTypeModel":{"type":"object","properties":{"revision":{"type":"string"},"startValidityDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endValiditydate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"leaveId":{"type":"integer","format":"int32"},"leaveDescription":{"type":"string"},"days":{"type":"integer","format":"int32"},"annualHours":{"type":"string"},"annualRepetitions":{"type":"string"},"agreementType":{"type":"string"}}},"PaymentFrequenciesModel":{"type":"object","properties":{"collectionTypeID":{"type":"integer","format":"int32"},"description":{"type":"string"}}},"EmployeePositionDetails":{"type":"object","properties":{"orgUnitId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"employeeCode":{"type":"string"},"employeeName":{"type":"string"},"jobCode":{"type":"string"},"jobTitle":{"type":"string"},"department":{"type":"string"},"companyName":{"type":"string"},"responsibleTo":{"type":"string"},"responsibleToCode":{"type":"string"},"fte":{"type":"number","format":"double"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endReason":{"type":"integer","format":"int32"},"endReasonDescription":{"type":"string"},"organizationalUnit":{"type":"string"},"positionNo":{"type":"integer","format":"int32"},"totalPostitions":{"type":"integer","format":"int32"}}},"OrganigramNodeResource":{"type":"object","properties":{"children":{"type":"array","items":{"$ref":"#/components/schemas/OrganigramNodeResource"}},"orgUnitID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"orgUnitNodeID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"orgUnitTypeName":{"type":"string"},"orgUnitName":{"type":"string"},"orgUnitDescription":{"type":"string"},"orgUnitCode":{"type":"string"},"orgUnitManagerName":{"type":"string"},"orgUnitCreateDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"orgUnitDropDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"orgUnitManagerCode":{"type":"string"},"orgUnitManagerIdentifierNumber":{"type":"string"},"orgUnitCompanyName":{"type":"string"}}},"CostCenterTreeResource":{"type":"object","properties":{"costAttributionTreeID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"companyID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"tableTypeID":{"type":"integer","format":"int32"},"description":{"type":"string"},"automatic":{"type":"boolean"},"levelAttributionLength1":{"type":"integer","format":"int32"},"levelAttributionLength2":{"type":"integer","format":"int32"},"levelAttributionLength3":{"type":"integer","format":"int32"},"levelAttributionLength4":{"type":"integer","format":"int32"},"levelAttributionLength5":{"type":"integer","format":"int32"},"showImputationCode":{"type":"boolean"},"showImputationEC":{"type":"boolean"},"showLevel":{"type":"boolean"},"companyCostAttributionTreeID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"costCenters":{"type":"array","items":{"$ref":"#/components/schemas/CostCenterTreeNodeResource"}}}},"CostCenterTreeNodeResource":{"type":"object","properties":{"children":{"type":"array","items":{"$ref":"#/components/schemas/CostCenterTreeNodeResource"}},"costAttributionNodeID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"costAttributionTreeID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"costAttributionFatherNodeID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"description":{"type":"string"},"costAttributionNodeCode":{"type":"string"},"level":{"type":"integer","format":"int32"},"codeAccountingLink":{"type":"string"},"levelAttributionCode1":{"type":"string"},"levelAttributionCode2":{"type":"string"},"levelAttributionCode3":{"type":"string"},"levelAttributionCode4":{"type":"string"},"levelAttributionCode5":{"type":"string"}}},"CostCenterNode":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"parentID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"description":{"type":"string"},"attributionCode":{"type":"string"},"level":{"type":"integer","format":"int32"},"accountingLink":{"type":"string"},"code":{"type":"string"}}},"PactedSalary":{"type":"object","properties":{"amount":{"type":"number","format":"double"},"distribution":{"type":"array","items":{"$ref":"#/components/schemas/ConceptDistribution"}},"liquidationType":{"enum":["Net","Gross"],"type":"string"}}},"ConceptDistribution":{"type":"object","properties":{"conceptCode":{"type":"integer","format":"int32"},"concept":{"type":"string"},"percentage":{"type":"number","format":"double"}}},"AgreedSalary":{"type":"object","properties":{"amount":{"type":"number","format":"double"},"liquidationType":{"enum":["Net","Gross"],"type":"string"},"excess":{"$ref":"#/components/schemas/AgreedSalaryExcess"},"extraPayments":{"$ref":"#/components/schemas/AgreedSalaryExtraPays"},"excludedConcepts":{"$ref":"#/components/schemas/AgreedSalaryExcludedConcepts"},"taxationQuote":{"$ref":"#/components/schemas/AgreedSalaryTaxationQuote"},"indicators":{"$ref":"#/components/schemas/Indicators"}}},"AgreedSalaryExcess":{"type":"object","properties":{"distribution":{"type":"array","items":{"$ref":"#/components/schemas/ConceptDistribution"}},"vacationsCollection":{"type":"boolean"}}},"AgreedSalaryExtraPays":{"type":"object","properties":{"extraPayment":{"type":"array","items":{"$ref":"#/components/schemas/AgreedSalaryExtraPay"}}}},"AgreedSalaryExcludedConcepts":{"type":"object","properties":{"excludedConceptGroupID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"concept":{"type":"array","items":{"$ref":"#/components/schemas/ExcludedConcept"}}}},"AgreedSalaryTaxationQuote":{"type":"object","properties":{"quotesCC":{"type":"boolean"},"quotesPC":{"type":"boolean"},"paysIRPFTax":{"type":"boolean"}}},"Indicators":{"type":"object","properties":{"tdIllness":{"type":"boolean"},"tdAccident":{"type":"boolean"},"tdMaternity":{"type":"boolean"},"tdPregnancyRisk":{"type":"boolean"},"strike":{"type":"boolean"},"absenteeism":{"type":"boolean"},"suspension":{"type":"boolean"},"paidLeave":{"type":"boolean"},"partialTime":{"type":"boolean"},"partialUnemployment":{"type":"boolean"},"enrolmentDrop":{"type":"boolean"},"inactivityPeriods":{"type":"boolean"}}},"AgreedSalaryExtraPay":{"type":"object","properties":{"extraPayId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"extraPay":{"type":"string"}}},"ExcludedConcept":{"type":"object","properties":{"conceptCode":{"type":"integer","format":"int32"},"concept":{"type":"string"}}},"RemoteWorkAgreement":{"type":"object","properties":{"agreementStartDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"agreementEndDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"workStartTime1":{"type":"string"},"workEndTime1":{"type":"string"},"workStartTime2":{"type":"string"},"workEndTime2":{"type":"string"},"indAvailabilityRules":{"type":"boolean"},"distancePercentage":{"type":"number","format":"double"},"placeWorkMunicipalityCode":{"type":"string"},"placeWorkMunicipality":{"type":"string"},"remoteWorkMunicipalityCode":{"type":"string"},"remoteWorkMunicipality":{"type":"string"},"placeWorkCountryID":{"type":"integer","format":"int32"},"placeWorkCountry":{"type":"string"},"remoteWorkCountryID":{"type":"integer","format":"int32"},"remoteWorkCountry":{"type":"string"},"noticePeriodDays":{"type":"integer","format":"int32"},"agreementDurationDays":{"type":"integer","format":"int32"},"indWithoutContractID":{"type":"boolean"},"contractType":{"type":"string"},"indContractContrata":{"type":"boolean"}}},"AttrResource":{"type":"object","properties":{"costAttributionNodeCode":{"type":"string"},"percentageAttribution":{"type":"number","format":"double"},"description":{"type":"string"}}},"ProfessionalContactDataEntityResource":{"type":"object","properties":{"directphone":{"type":"string"},"professionalphone":{"type":"string"},"extension":{"type":"string"},"fax":{"type":"string"},"professionalemail":{"type":"string"}}},"CustomDataTemplateDTO":{"type":"object","properties":{"templateCode":{"type":"integer","format":"int32"},"templateName":{"type":"string"},"templateType":{"enum":["employee","company","jobposition"],"type":"string"}}},"EmployeeEducationLevel":{"type":"object","properties":{"educationLevelID":{"type":"integer","format":"int32"}}},"LactancyRiskPut":{"type":"object","properties":{"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"description":{"type":"string"}}},"LactancyRisk":{"required":["startDate"],"type":"object","properties":{"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"description":{"type":"string"}}},"AddressModel":{"required":["streetName"],"type":"object","properties":{"acronymID":{"type":"string"},"streetName":{"type":"string"},"buildingNumber":{"type":"string"},"stairwell":{"type":"string"},"floor":{"type":"string"},"gate":{"type":"string"},"town":{"type":"string"},"postalCode":{"type":"string"},"countryID":{"type":"integer","format":"int32"},"poBox":{"type":"string"},"country":{"type":"string"},"acronym":{"type":"string"}}},"AddressEntityResource":{"type":"object","properties":{"acronym":{"type":"string"},"streetName":{"type":"string"},"buildingNumber":{"type":"string"},"stairWell":{"type":"string"},"floor":{"type":"string"},"gate":{"type":"string"},"town":{"type":"string"},"country":{"type":"string"},"postalCode":{"type":"string"},"municipalityCode":{"type":"string"}}},"UnjustifiedAbsenteeismEntityResource":{"type":"object","properties":{"absenteeismID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indLessThanOneDay":{"type":"boolean"},"durationHours":{"type":"integer","format":"int32"},"durationMinuts":{"type":"integer","format":"int32"},"indDiscountRestsWeekly":{"type":"boolean"},"indDiscountNaturalDays":{"type":"boolean"},"lastUpdate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}},"example":{"absenteeismID":"97881845-4a08-4a9e-8e9e-9298f038a45d","startDate":"2019-05-21T00:00:00.0000000+00:00","endDate":"2019-05-31T00:00:00.0000000+00:00","indLessThanOneDay":false,"durationHours":0,"durationMinuts":0,"indDiscountRestsWeekly":false,"indDiscountNaturalDays":false,"lastUpdate":"0001-01-01T00:00:00.0000000+00:00"}},"UnjustifiedAbsenteeismCollectionItemResource":{"type":"object","properties":{"absenteeismID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"lastUpdate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}}},"EmployeeContractAgreement":{"type":"object","properties":{"contractCode":{"type":"string"},"contractDescription":{"type":"string"},"labourPeriodStartDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"labourPeriodEndDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"contributionTypeID":{"type":"integer","format":"int32"},"contributionType":{"type":"string"},"contributionModalityType":{"type":"string"},"cnoOccupationID":{"type":"string"},"indDeterminedDuration7days":{"type":"integer","format":"int32"},"contributionAgrarianMode":{"type":"integer","format":"int32"},"testPeriod":{"type":"integer","format":"int32"},"indTestDaysType":{"type":"integer","format":"int32"},"noticeDays":{"type":"integer","format":"int32"},"workReason":{"type":"string"},"citricRegimeContribution":{"type":"integer","format":"int32"},"citricRegimePermanenceCoefficient":{"type":"integer","format":"int32"},"jobPosition":{"type":"string"},"annualGrossText":{"type":"string"},"annualGrossAmount":{"type":"number","format":"double"},"ocupationTGSSID":{"type":"string"},"collectionTypeID":{"type":"integer","format":"int32"},"collectionType":{"type":"string"}}},"EmployeeContractInfoResource":{"type":"object","properties":{"contractType":{"type":"integer","format":"int32"},"contributionType":{"type":"integer","format":"int32"},"indDeterminedDuration7days":{"type":"boolean"},"contributionAgrarianMode":{"enum":["SistemaGeneral","JornadasReales"],"type":"string"},"labourPeriodStartDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"labourPeriodEndDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"testPeriod":{"type":"integer","format":"int32"},"indTestDaysType":{"enum":["Meses","Dias"],"type":"string"},"noticeDays":{"type":"integer","format":"int32"},"workReason":{"type":"string"},"citricRegimeContribution":{"enum":["NoProcede","LDiasTrabajados","NDiasAlta"],"type":"string"},"citricRegimePermanenceCoefficient":{"enum":["Automatico","LunesAViernes","LunesASabado"],"type":"string"},"jobposition":{"type":"string"},"cnoOccupationID":{"type":"string"},"annualGrossText":{"type":"string"},"annualGrossAmount":{"type":"number","format":"double"},"tgssCode":{"type":"string"},"collectionTypeID":{"type":"integer","format":"int32"},"tariffGroupID":{"type":"integer","format":"int32"}}},"TokenValidationHandler":{"type":"object","properties":{"innerHandler":{"$ref":"#/components/schemas/HttpMessageHandler"}},"description":"Token validator for Authorization Request using a DelegatingHandler"},"HttpMessageHandler":{"type":"object"},"EmployeeContractHistoryResource":{"type":"object","properties":{"contractCode":{"type":"integer","format":"int32"},"contractDescription":{"type":"string"},"affiliationDescription":{"type":"string"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"fileContractName":{"type":"string"},"indEmptyContractText":{"type":"boolean"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indOralContract":{"type":"boolean"},"publishedA3Doc":{"type":"boolean"},"publishedPortal":{"type":"boolean"},"a3DocDocumentId":{"type":"integer","format":"int32"}}},"EmployeesCollectionResource":{"type":"object","properties":{"employeeId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"employeeCode":{"type":"string"},"completeName":{"type":"string"},"identifierNumber":{"type":"string"},"dropDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"workplaceCode":{"type":"integer","format":"int32"},"tariffGroupID":{"type":"integer","format":"int32"},"extraPayGroupID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"lastUpdate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"ssNAF":{"type":"string"},"personTypeDescription":{"enum":["Trabajador","Profesional","ETT"],"type":"string"},"personTypeID":{"type":"integer","format":"int32"},"enrolmentDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indNonRemuneratedPractices":{"type":"boolean"},"collectionTypeID":{"type":"integer","format":"int32"},"collectionTypeDescription":{"enum":["Daily","Monthly"],"type":"string"}}},"NewEmployee":{"required":["workplaceCode","identification","agreement","contribution"],"type":"object","properties":{"workplaceCode":{"maximum":999999,"minimum":1,"type":"integer","format":"int32"},"identification":{"$ref":"#/components/schemas/NewEmployeeIdentification"},"agreement":{"$ref":"#/components/schemas/NewEmployeeAgreement"},"contribution":{"$ref":"#/components/schemas/NewEmployeeContribution"},"address":{"$ref":"#/components/schemas/NewEmployeeAddress"}},"example":{"workplaceCode":1,"identification":{"identificationType":1,"identifierNumber":"Y9997282T","employeeCode":"10001","legalName":"Bilbo","secondName1":"Baggins","secondName2":"Bobbins","sex":"H","ssAffiliationNumberPrefix":"99","ssAffiliationNumber":"12345678","ssAffiliationNumberSuffix":"99","enrollmentDate":"1975-01-01","personType":"2","birthRegion":"BARCELONA","birthCountry":"ESPAÑA"},"agreement":{"nonRenumerated":false,"companyAgreementCode":"1010101","classificationCode":1,"jobPositionCode":"1001","subClassificationCode":9,"cnoOccupationID":"0001"},"contribution":{"contributionTypeID":1,"regime":"4265119c-fed8-4a8c-8c44-3f53dbc2af89","tariffGroupID":2,"occupationCodeTGSS":"x","ims":3.35,"it":3.35,"paymentFrequency":2},"address":{"acronymID":"Calle","streetName":"a street","buildingNumber":"12","stairwell":"1","floor":"1","gate":"l","town":"Atown","postalCode":"09999","countryID":724,"poBox":"09"}}},"NewEmployeeIdentification":{"required":["identificationType","identifierNumber","legalName","secondName1","sex","ssAffiliationNumberPrefix","ssAffiliationNumber","ssAffiliationNumberSuffix","enrollmentDate","personType"],"type":"object","properties":{"identificationType":{"maximum":10,"minimum":1,"type":"integer","format":"int32"},"identifierNumber":{"type":"string"},"employeeCode":{"type":"string"},"legalName":{"type":"string"},"secondName1":{"type":"string"},"secondName2":{"type":"string"},"sex":{"type":"string"},"ssAffiliationNumberPrefix":{"pattern":"^[0-9]{2}$","type":"string"},"ssAffiliationNumber":{"pattern":"^[0-9]{8}$","type":"string"},"ssAffiliationNumberSuffix":{"pattern":"^[0-9]{2}$","type":"string"},"enrollmentDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"personType":{"type":"string"},"birthRegion":{"type":"string"},"birthCountry":{"type":"string"}}},"NewEmployeeAgreement":{"type":"object","properties":{"nonRenumerated":{"type":"boolean"},"companyAgreementCode":{"type":"string"},"revision":{"type":"integer","format":"int32"},"classificationCode":{"type":"integer","format":"int32"},"jobPositionCode":{"type":"string"},"subClassificationCode":{"type":"integer","format":"int32"},"cnoOccupationID":{"type":"string"}}},"NewEmployeeContribution":{"required":["contributionTypeID","regime","tariffGroupID","paymentFrequency"],"type":"object","properties":{"contributionTypeID":{"type":"integer","format":"int32"},"regime":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"tariffGroupID":{"type":"integer","format":"int32"},"occupationCodeTGSS":{"type":"string"},"ims":{"type":"number","format":"double"},"it":{"type":"number","format":"double"},"paymentFrequency":{"type":"integer","format":"int32"}}},"NewEmployeeAddress":{"required":["streetName"],"type":"object","properties":{"acronymID":{"type":"string"},"streetName":{"type":"string"},"buildingNumber":{"type":"string"},"stairwell":{"type":"string"},"floor":{"type":"string"},"gate":{"type":"string"},"town":{"type":"string"},"postalCode":{"type":"string"},"countryID":{"type":"integer","format":"int32"},"poBox":{"type":"string"}}},"LaborLifeDetails":{"type":"object","properties":{"periodStartDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"motive":{"type":"string"},"isIRPFChange":{"type":"boolean"},"isPeriodChange":{"type":"boolean"},"motiveAll":{"type":"string"},"indCreta":{"type":"boolean"}}},"HRRequestRequestNewEmployee":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/RequestNewEmployee"},"observations":{"type":"string"}},"example":{"data":{"identification":{"name":"Bilbo","surname":"Baggins","surname2":"Bobbins","sex":"H","identificationDocumentTypeID":1,"identificationDocumentNumber":"Y3227222T","dateOfBirth":"2026-02-25T12:53:38.1147214+00:00"},"contactDetails":{"street":"a street","town":"Atown","countryID":724,"postalCode":"09999","buildingNumber":"1","floor":"1","gate":"2","stairwell":"L","streetType":"Calle","phone":"677999999","email":"someone@somwhere.com"},"bank":{"bankCode":"1234","branchCode":"0001","checkDigit":"01","accountNumber":"1234567890"},"fiscal":{"ssAffiliationNumberPrefix":"99","ssAffiliationNumber":"12345678","ssAffiliationNumberSuffix":"99","birthCountryID":724,"birthRegion":"Barcelona"},"ocupational":{"jobPositionCode":"1001","companyAgreementCode":"10001010","classificationCode":2},"enrolmentDate":"2022-05-01"},"observations":"some observations"}},"RequestNewEmployee":{"required":["identification","contactDetails","enrolmentDate"],"type":"object","properties":{"identification":{"$ref":"#/components/schemas/RequestNewEmployeeIdentification"},"contactDetails":{"$ref":"#/components/schemas/RequestNewEmployeeContactDetails"},"bank":{"$ref":"#/components/schemas/RequestNewEmployeeBankAccount"},"fiscal":{"$ref":"#/components/schemas/RequestNewEmployeeFiscal"},"ocupational":{"$ref":"#/components/schemas/RequestEmployeeOcupational"},"enrolmentDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}}},"RequestNewEmployeeIdentification":{"required":["name","surname","sex","identificationDocumentTypeID","identificationDocumentNumber","dateOfBirth"],"type":"object","properties":{"name":{"type":"string"},"surname":{"type":"string"},"surname2":{"type":"string"},"sex":{"type":"string"},"identificationDocumentTypeID":{"type":"integer","format":"int32"},"identificationDocumentNumber":{"type":"string"},"dateOfBirth":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}}},"RequestNewEmployeeContactDetails":{"required":["countryID","postalCode","phone","email"],"type":"object","properties":{"street":{"type":"string"},"town":{"type":"string"},"countryID":{"type":"integer","format":"int32"},"postalCode":{"type":"string"},"buildingNumber":{"type":"string"},"floor":{"type":"string"},"gate":{"type":"string"},"stairwell":{"type":"string"},"streetType":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"}}},"RequestNewEmployeeBankAccount":{"required":["bankCode","branchCode","checkDigit","accountNumber"],"type":"object","properties":{"bankCode":{"pattern":"^[0-9]{4}$","type":"string"},"branchCode":{"pattern":"^[0-9]{4}$","type":"string"},"checkDigit":{"pattern":"^[0-9]{2}$","type":"string"},"accountNumber":{"pattern":"^[0-9]{10}$","type":"string"}}},"RequestNewEmployeeFiscal":{"required":["ssAffiliationNumberPrefix","ssAffiliationNumber","ssAffiliationNumberSuffix","birthCountryID"],"type":"object","properties":{"ssAffiliationNumberPrefix":{"pattern":"^[0-9]{2}$","type":"string"},"ssAffiliationNumber":{"pattern":"^[0-9]{8}$","type":"string"},"ssAffiliationNumberSuffix":{"pattern":"^[0-9]{2}$","type":"string"},"birthCountryID":{"type":"integer","format":"int32"},"birthRegion":{"type":"string"}}},"RequestEmployeeOcupational":{"required":["companyAgreementCode","classificationCode"],"type":"object","properties":{"jobPositionCode":{"type":"string"},"companyAgreementCode":{"type":"string"},"classificationCode":{"type":"integer","format":"int32"}}},"DtoProfessional":{"type":"object","properties":{"professionalCode":{"type":"string"},"identifierType":{"enum":["NIF","Pasaporte","TResidencia","PResidencia","NIE","CIF"],"type":"string"},"identifierNumber":{"type":"string"},"legalName":{"type":"string"},"secondName1":{"type":"string"},"secondName2":{"type":"string"},"workplaceCode":{"type":"string"},"perceptionTypeCode":{"type":"string"},"perceptionSubTypeCode":{"type":"integer","format":"int32"},"withholdingPercentage":{"type":"number","format":"double"},"irpfPeriods":{"type":"array","items":{"$ref":"#/components/schemas/DtoIRPFPeriod"}}}},"DtoIRPFPeriod":{"type":"object","properties":{"periodIRPFYear":{"type":"integer","format":"int32"},"periodIRPFMonth":{"type":"integer","format":"int32"},"baseIRPF":{"type":"number","format":"double"},"amountIRPF":{"type":"number","format":"double"}}},"CreatedProfessional":{"type":"object","properties":{"professionalCode":{"type":"string"},"identifierNumber":{"type":"string"}}},"DtoIRPFPeriodReturn":{"type":"object","properties":{"perceptionTypeCode":{"type":"string"},"perceptionSubTypeCode":{"type":"integer","format":"int32"},"periodIRPFYear":{"type":"integer","format":"int32"},"periodIRPFMonth":{"type":"integer","format":"int32"},"baseIRPF":{"type":"number","format":"double"},"amountIRPF":{"type":"number","format":"double"}}},"DtoIRPFData":{"type":"object","properties":{"perceptionTypeCode":{"type":"string"},"perceptionSubTypeCode":{"type":"integer","format":"int32"},"withholdingPercentage":{"type":"number","format":"double","readOnly":true}}},"EmployeeSubClassification":{"type":"object","properties":{"classificationCode":{"type":"integer","format":"int32"},"subClassificationCode":{"type":"integer","format":"int32"},"classificationFactor":{"type":"number","format":"double"},"employeeFactor":{"type":"number","format":"double"},"factor":{"type":"number","format":"double"}}},"BirthPermitsResource":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"incidentTypeID":{"enum":["None","Illness","Accident","Biological Mother","PartialBirthPermitBiologicalMother","Other Parent","PartialBirthPermitOtherParent"],"type":"string"}},"example":{"startDate":"2019-10-01T00:00:00.0000000+00:00","incidentTypeID":"Other Parent"}},"BirthPermitsCollectionResource":{"type":"object","properties":{"birthPermitID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"incidentTypeID":{"enum":["None","Illness","Accident","Biological Mother","PartialBirthPermitBiologicalMother","Other Parent","PartialBirthPermitOtherParent"],"type":"string"},"lastUpdate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}}},"BirthPermitModel":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}}},"CompanyWorkplaceCalendarModel":{"type":"object","properties":{"date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"dayTypeID":{"type":"integer","format":"int32"},"dayType":{"type":"string"},"workDayTypeID":{"type":"integer","format":"int32"},"workDayType":{"type":"string"}}},"AccidentsCollectionResource":{"type":"object","properties":{"accidentId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"lastUpdate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}}},"AccidentsResource":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"benefitTypeID":{"enum":["Delegated Payment","No Right to Benefit","Direct payment"],"type":"string"},"indComplement":{"type":"boolean"}},"example":{"startDate":"2019-10-01T00:00:00.0000000+00:00","endDate":"2019-10-31T00:00:00.0000000+00:00","benefitTypeID":"No Right to Benefit","indComplement":true}},"IllnessesResource":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"benefitTypeID":{"enum":["Delegated Payment","No Right to Benefit","Direct payment"],"type":"string"},"indComplement":{"type":"boolean"}},"example":{"startDate":"2019-10-01T00:00:00.0000000+00:00","endDate":"2019-10-31T00:00:00.0000000+00:00","benefitTypeID":"No Right to Benefit","indComplement":true}},"IllnessesCollectionResource":{"type":"object","properties":{"illnessId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"lastUpdate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}}},"TDUpdate":{"type":"object","properties":{"endDate":{"type":"string","description":"Gets or sets the end date of the temporary disability.","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}},"description":"Represents an update to a temporary disability, including the end date."},"ProfessionalIllnessesCollectionResource":{"type":"object","properties":{"professionalIllnessId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"lastUpdate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}}},"ProfessionalIllnessesResource":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"benefitTypeID":{"enum":["Delegated Payment","No Right to Benefit","Direct payment"],"type":"string"},"indComplement":{"type":"boolean"}},"example":{"startDate":"2019-10-01T00:00:00.0000000+00:00","endDate":"2019-10-31T00:00:00.0000000+00:00","benefitTypeID":"No Right to Benefit","indComplement":true}},"CompanyWorkplacesCollectionResource":{"type":"object","properties":{"companyNumberCode":{"type":"integer","format":"int32"},"companyworkplaceId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"workplaceCode":{"type":"integer","format":"int32"},"workplaceName":{"type":"string"}}},"PaidLeave":{"type":"object","properties":{"absenteeismID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"durationHours":{"type":"integer","format":"int32"},"durationMinuts":{"type":"integer","format":"int32"},"canceledAbsenteeismID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"indDiscountRestsWeekly":{"type":"boolean"},"indLessThanOneDay":{"type":"boolean"},"indDiscountNaturalDays":{"type":"boolean"},"percentageDayAbsenteeisms":{"type":"number","format":"double"},"indCompanyContributionOnly":{"type":"boolean"},"indLateCommunicationDrop":{"type":"boolean"},"forcedDescription":{"type":"string"},"partialWorkdayPercentage":{"type":"number","format":"double"},"leave":{"type":"string"},"leaveId":{"type":"string"}}},"PaidLeaveUpdate":{"type":"object","properties":{"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}}},"PaidLeaveType":{"type":"object","properties":{"leaveID":{"type":"integer","format":"int32"},"leave":{"type":"string"},"shortDescription":{"type":"string"},"days":{"type":"integer","format":"int32"}}},"UnpaidEmploymentSuspensionAbsenteeismCreateModel":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"isDiscountRestsWeekly":{"type":"boolean"},"isDiscountNaturalDays":{"type":"boolean"},"payslipText":{"type":"string"}}},"AbsenteeismStrikeGetModel":{"type":"object","properties":{"isLessThanOneDay":{"type":"boolean"},"duration":{"type":"integer","format":"int32"},"absenteeismID":{"type":"string"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"employeeID":{"type":"string"},"companyCode":{"type":"integer","format":"int32"},"employeeCode":{"type":"string"},"isDiscountRestsWeekly":{"type":"boolean"},"isDiscountNaturalDays":{"type":"boolean"},"payslipText":{"type":"string"},"lastUpdate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}}},"AbsenteeismStrikeCreateModel":{"type":"object","properties":{"isLessThanOneDay":{"type":"boolean"},"duration":{"type":"integer","format":"int32"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"isDiscountRestsWeekly":{"type":"boolean"},"isDiscountNaturalDays":{"type":"boolean"},"payslipText":{"type":"string"}}},"Absenteeism":{"type":"object","properties":{"absenteeismID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"typeOfItAbsenteeism":{"type":"string"},"employeeID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"employeeCode":{"type":"string"},"companyCode":{"type":"string"},"companyWorkplaceCode":{"type":"integer","format":"int32"},"itAbsenteeismWorkPlaceCode":{"type":"integer","format":"int32"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"canceledAbsenteeismID":{"type":"boolean"},"description":{"type":"string"},"percentageDayAbsenteeisms":{"type":"number","format":"double"},"absenteeismModeTypeID":{"type":"string"},"absenteeismModeType":{"type":"string"},"contingencyDescription":{"type":"string"},"securityProfileID":{"type":"integer","format":"int32"},"lastUpdate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}}},"AbsenteeismDetail":{"type":"object","properties":{"absenteesmID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"typeOfItAbsenteeism":{"type":"string"},"employeeID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"employeeCode":{"type":"string"},"companyWorkplaceCode":{"type":"integer","format":"int32"},"itAbsenteeismWorkPlaceCode":{"type":"integer","format":"int32"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"canceledAbsenteeismID":{"type":"boolean"},"description":{"type":"string"},"percentageDayAbsenteeisms":{"type":"number","format":"double"},"absenteeismModeType":{"type":"string"},"contingencyDescription":{"type":"string"},"securityProfileID":{"type":"integer","format":"int32"},"forcedDescription":{"type":"string"},"indDiscountRestsWeekly":{"type":"boolean"},"indDiscountNaturalDays":{"type":"boolean"},"lastUpdate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"absenteeismTypeId":{"enum":["UnjustifiedAbsence","Strike","SuspensionOfEmploymentAndSalary","PaidLeave","Vacation"],"type":"string"},"holiday":{"$ref":"#/components/schemas/Holiday"},"unjustified":{"$ref":"#/components/schemas/Unjustified"},"retributed":{"$ref":"#/components/schemas/Retributed"},"indLessThanOneDay":{"type":"boolean"},"durationHours":{"type":"integer","format":"int32"},"durationMinuts":{"type":"integer","format":"int32"}}},"Holiday":{"type":"object","properties":{"indLessThanOneDay":{"type":"boolean"}}},"Unjustified":{"type":"object","properties":{"durationHours":{"type":"integer","format":"int32"},"durationMinuts":{"type":"integer","format":"int32"},"indCompanyContributionOnly":{"type":"boolean"},"indLateCommunicationDrop":{"type":"boolean"},"partialWorkdayPercentage":{"type":"number","format":"double"}}},"Retributed":{"type":"object","properties":{"leave":{"type":"string"},"leaveId":{"type":"string"}}},"HolidaysEntityResource":{"type":"object","properties":{"absenteeismID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indLessThanOneDay":{"type":"boolean"},"percentageDayAbsenteeisms":{"type":"number","format":"double"}},"example":{"absenteeismID":"bf738cd1-1257-42c5-a510-24ce495ea149","startDate":"2019-06-20T00:00:00.0000000+00:00","endDate":"2019-06-30T00:00:00.0000000+00:00","indLessThanOneDay":true,"percentageDayAbsenteeisms":50}},"HolidaysCollectionItemResource":{"type":"object","properties":{"absenteeismID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"lastUpdate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}}},"VacationDaysSumary":{"type":"object","properties":{"initalDays":{"type":"number","format":"double"},"previousYearDays":{"type":"number","format":"double"},"otherDays":{"type":"number","format":"double"},"total":{"type":"number","format":"double"},"observations":{"type":"string"}}},"OtherDays":{"type":"object","properties":{"observations":{"type":"string"},"days":{"type":"integer","format":"int32"}}},"PartialBirthPermitGetEntity":{"type":"object","properties":{"periods":{"type":"array","items":{"$ref":"#/components/schemas/PartialBirthPermitPeriodGetEntity"}},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indLocked":{"type":"boolean"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"lastUpdate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"birthPermitType":{"enum":["Mother","Other"],"type":"string"},"benefitTypeID":{"enum":["DelegatedPay","NoRightToBenefit","DirectPayment"],"type":"string"},"contingencyID":{"enum":["CommonIllness","NonWorkAccident","WorkAccident","ProfesionalIllness","ObservarionPeriod"],"type":"string"},"indComplement":{"type":"boolean"},"indAutManEndDate":{"type":"boolean"},"forcedDescription":{"type":"string"},"indCovid19":{"type":"boolean"}}},"PartialBirthPermitPeriodGetEntity":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"payLocked":{"type":"boolean"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"percentage":{"type":"number","format":"double"}}},"PartialBirthPermitPutEntity":{"type":"object","properties":{"periods":{"type":"array","items":{"$ref":"#/components/schemas/PartialBirthPermitPeriodPutEntity"}},"birthPermitType":{"enum":["Mother","Other"],"type":"string"},"benefitTypeID":{"enum":["DelegatedPay","NoRightToBenefit","DirectPayment"],"type":"string"},"contingencyID":{"enum":["CommonIllness","NonWorkAccident","WorkAccident","ProfesionalIllness","ObservarionPeriod"],"type":"string"},"indComplement":{"type":"boolean"},"indAutManEndDate":{"type":"boolean"},"forcedDescription":{"type":"string"},"indCovid19":{"type":"boolean"}}},"PartialBirthPermitPeriodPutEntity":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"percentage":{"type":"number","format":"double"}}},"PartialBirthPermitPostEntity":{"type":"object","properties":{"periods":{"type":"array","items":{"$ref":"#/components/schemas/PartialBirthPermitPeriodPostEntity"}},"birthPermitType":{"enum":["Mother","Other"],"type":"string"},"benefitTypeID":{"enum":["DelegatedPay","NoRightToBenefit","DirectPayment"],"type":"string"},"contingencyID":{"enum":["CommonIllness","NonWorkAccident","WorkAccident","ProfesionalIllness","ObservarionPeriod"],"type":"string"},"indComplement":{"type":"boolean"},"indAutManEndDate":{"type":"boolean"},"forcedDescription":{"type":"string"},"indCovid19":{"type":"boolean"}}},"PartialBirthPermitPeriodPostEntity":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"percentage":{"type":"number","format":"double"}}},"EmployeeMedicalResource":{"type":"object","properties":{"checkupDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"invited":{"type":"boolean"},"rejected":{"type":"boolean"},"checked":{"type":"boolean"},"observation":{"type":"string"},"code":{"type":"string"},"description":{"type":"string"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"notes":{"type":"string"},"stateDescription":{"type":"string"},"typeDescription":{"type":"string"}}},"HolyDatesModel":{"type":"object","properties":{"holidayID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"holidayDateDay":{"type":"integer","format":"int32"},"holidayDateMonth":{"type":"integer","format":"int32"},"description":{"type":"string"},"revision":{"type":"integer","format":"int32"}}},"UnemploymentDigestResource":{"type":"object","properties":{"unemploymentID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"companyCode":{"type":"string"},"workplaceCode":{"type":"string"},"employeeCode":{"type":"string"},"unemploymentTypeID":{"type":"integer","format":"int32"},"unemploymentTypeDesc":{"type":"string"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}}},"UnemploymentResource":{"type":"object","properties":{"unemploymentID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"companyCode":{"type":"string"},"workplaceCode":{"type":"string"},"employeeCode":{"type":"string"},"unemploymentTypeID":{"type":"integer","format":"int32"},"unemploymentTypeDesc":{"type":"string"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"percentageUnemployment":{"type":"number","format":"double"},"taxableBaseCC":{"type":"number","format":"double"},"taxableBasePC":{"type":"number","format":"double"},"dismissalTypeID":{"type":"integer","format":"int32"},"dismissalTypeDesc":{"type":"string"},"numERE":{"type":"string"},"ind55YearsContain":{"type":"boolean"},"activityCoeficient":{"type":"string"},"extinctionDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"reductionType":{"type":"string"},"reductionTypeDesc":{"type":"string"},"indForceMajeure":{"type":"boolean"},"indCovid19":{"type":"boolean"},"indContributionPeculiarityCause059":{"type":"boolean"},"dateContributionPeculiarityCause059":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indReincorporationTypeS":{"type":"boolean"},"indReincorporationTypeR":{"type":"boolean"},"indReincorporationTypeY":{"type":"boolean"},"indReincorporationTypeU":{"type":"boolean"},"indErteETOP":{"type":"boolean"},"indContributionPeculiarityCause060":{"type":"boolean"},"dateContributionPeculiarityCause060":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indContributionPeculiarityCause061":{"type":"boolean"},"dateContributionPeculiarityCause061":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indContributionPeculiarityCause062":{"type":"boolean"},"dateContributionPeculiarityCause062":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indReincorporationTypeA3":{"type":"boolean"},"indReincorporationTypeA4":{"type":"boolean"},"indReincorporationTypeA5":{"type":"boolean"},"indReincorporationTypeA6":{"type":"boolean"},"indReincorporationTypeA9":{"type":"boolean"},"indReincorporationTypeB1":{"type":"boolean"},"indReincorporationTypeB2":{"type":"boolean"},"indReincorporationTypeB3":{"type":"boolean"},"indReincorporationTypeB6":{"type":"boolean"},"indReincorporationTypeB7":{"type":"boolean"},"indReincorporationTypeB8":{"type":"boolean"},"indReincorporationTypeB9":{"type":"boolean"},"indCovidOctober2020":{"type":"boolean"},"indContributionPeculiarityCause067":{"type":"boolean"},"dateContributionPeculiarityCause067":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indReincorporationTypeC3":{"type":"boolean"},"indContributionPeculiarityCause068":{"type":"boolean"},"dateContributionPeculiarityCause068":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indReincorporationTypeC9":{"type":"boolean"},"indReincorporationTypeD1":{"type":"boolean"},"indReincorporationTypeD2":{"type":"boolean"},"indReincorporationTypeD3":{"type":"boolean"},"indContributionPeculiarityCause069":{"type":"boolean"},"dateContributionPeculiarityCause069":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indReincorporationTypeD6":{"type":"boolean"},"indReincorporationTypeD7":{"type":"boolean"},"indReincorporationTypeD8":{"type":"boolean"},"indReincorporationTypeD9":{"type":"boolean"},"indContributionPeculiarityCause070":{"type":"boolean"},"dateContributionPeculiarityCause070":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indReincorporationTypeE3":{"type":"boolean"},"indReincorporationTypeE4":{"type":"boolean"},"indReincorporationTypeE5":{"type":"boolean"},"indReincorporationTypeE6":{"type":"boolean"},"indContributionPeculiarityCause071":{"type":"boolean"},"dateContributionPeculiarityCause071":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indReincorporationTypeE9":{"type":"boolean"},"indReincorporationTypeF1":{"type":"boolean"},"indReincorporationTypeF2":{"type":"boolean"},"indReincorporationTypeF3":{"type":"boolean"},"indContributionPeculiarityCause072":{"type":"boolean"},"dateContributionPeculiarityCause072":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indReincorporationTypeF6":{"type":"boolean"},"indReincorporationTypeF7":{"type":"boolean"},"indReincorporationTypeF8":{"type":"boolean"},"indReincorporationTypeF9":{"type":"boolean"},"indContributionPeculiarityCause073":{"type":"boolean"},"dateContributionPeculiarityCause073":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indReincorporationTypeG3":{"type":"boolean"},"indReincorporationTypeG4":{"type":"boolean"},"indReincorporationTypeG5":{"type":"boolean"},"indReincorporationTypeG6":{"type":"boolean"},"indContributionPeculiarityCause074":{"type":"boolean"},"dateContributionPeculiarityCause074":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indReincorporationTypeG9":{"type":"boolean"},"indContributionPeculiarityCause075":{"type":"boolean"},"dateContributionPeculiarityCause075":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indReincorporationTypeH6":{"type":"boolean"},"indReincorporationTypeH7":{"type":"boolean"},"indReincorporationTypeH8":{"type":"boolean"},"indReincorporationTypeH9":{"type":"boolean"},"indContributionPeculiarityCause076":{"type":"boolean"},"dateContributionPeculiarityCause076":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indReincorporationTypeI3":{"type":"boolean"},"indReincorporationTypeI4":{"type":"boolean"},"indReincorporationTypeI5":{"type":"boolean"},"indReincorporationTypeI6":{"type":"boolean"},"indContributionPeculiarityCause077":{"type":"boolean"},"dateContributionPeculiarityCause077":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indReincorporationTypeI9":{"type":"boolean"},"indReincorporationTypeJ1":{"type":"boolean"},"indReincorporationTypeJ2":{"type":"boolean"},"indReincorporationTypeJ3":{"type":"boolean"},"indContributionPeculiarityCause078":{"type":"boolean"},"dateContributionPeculiarityCause078":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indReincorporationTypeJ6":{"type":"boolean"},"indContributionPeculiarityCause079":{"type":"boolean"},"dateContributionPeculiarityCause079":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indReincorporationTypeK3":{"type":"boolean"},"indReincorporationTypeK4":{"type":"boolean"},"indReincorporationTypeK5":{"type":"boolean"},"indReincorporationTypeK6":{"type":"boolean"},"indContributionPeculiarityCause080":{"type":"boolean"},"dateContributionPeculiarityCause080":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indReincorporationTypeK9":{"type":"boolean"},"indReincorporationTypeL1":{"type":"boolean"},"indReincorporationTypeL2":{"type":"boolean"},"indReincorporationTypeL3":{"type":"boolean"},"indContributionPeculiarityCause081":{"type":"boolean"},"dateContributionPeculiarityCause081":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indReincorporationTypeL6":{"type":"boolean"},"indReincorporationTypeL7":{"type":"boolean"},"indReincorporationTypeL8":{"type":"boolean"},"indReincorporationTypeL9":{"type":"boolean"},"indContributionPeculiarityCause083":{"type":"boolean"},"dateContributionPeculiarityCause083":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indContributionPeculiarityCause084":{"type":"boolean"},"dateContributionPeculiarityCause084":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indContributionPeculiarityCause085":{"type":"boolean"},"dateContributionPeculiarityCause085":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indContributionPeculiarityCause086":{"type":"boolean"},"dateContributionPeculiarityCause086":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indContributionPeculiarityCause089":{"type":"boolean"},"dateContributionPeculiarityCause089":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indContributionPeculiarityCause090":{"type":"boolean"},"dateContributionPeculiarityCause090":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indContributionPeculiarityCause091":{"type":"boolean"},"dateContributionPeculiarityCause091":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indContributionPeculiarityCause092":{"type":"boolean"},"dateContributionPeculiarityCause092":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indTraining":{"type":"boolean"},"trainingStartDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"trainingEndDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indContributionPeculiarityCause087":{"type":"boolean"},"dateContributionPeculiarityCause087":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indContributionPeculiarityCause088":{"type":"boolean"},"dateContributionPeculiarityCause088":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indContributionPeculiarityCause095":{"type":"boolean"},"dateContributionPeculiarityCause095":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indContributionPeculiarityCause096":{"type":"boolean"},"dateContributionPeculiarityCause096":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}}},"EmployeeJobHistory":{"type":"object","properties":{"jobPositionHistoryFTE":{"type":"string"},"jobPositionHistoryInitDate":{"type":"string"},"jobPositionHistoryEndDate":{"type":"string"},"jobPositionHistoryEndCause":{"type":"string"},"jobPositionHistoryEmployeeName":{"type":"string"},"jobPositionHistoryJobTitleName":{"type":"string"},"jobPositionHistoryJobPositionCode":{"type":"string"},"jobPositionHistoryOrgUnitName":{"type":"string"},"jobPositionHistoryCompanyName":{"type":"string"},"description":{"type":"string"},"jobTitleDescriptionName":{"type":"string"},"jobTitleDescriptionCode":{"type":"string"},"jobPositionHistoryJobTitleDescriptionCode":{"type":"string"},"jobPositionHistoryJobTitleDescriptionName":{"type":"string"}}},"CalendarDay":{"type":"object","properties":{"date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"hours":{"type":"number","format":"double"},"percentage":{"type":"number","format":"double"},"dayType":{"type":"string"},"workDayType":{"type":"string"},"blocked":{"type":"boolean"},"calendar":{"enum":["Workplace","Personal"],"type":"string"}}},"CalendarWorkDayPercentage":{"type":"object","properties":{"lastWorkDayTypeSelected":{"type":"integer","format":"int32"},"lastWorkDayPercentage":{"type":"number","format":"double"},"lastWorkDayHours":{"type":"number","format":"double"},"lastWorkDayTypeSelectedDescription":{"type":"string"}}},"EmployeeLaborLife":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"motive":{"type":"string"}}},"EmployeeLaborLifeDetail":{"type":"object","properties":{"workplaceCode":{"type":"integer","format":"int32"},"workplaceName":{"type":"string"},"ssAffiliationNumberPrefix":{"type":"integer","format":"int32"},"ssAffiliationNumber":{"type":"integer","format":"int64"},"ssAffiliationNumberSuffix":{"type":"integer","format":"int32"},"sex":{"type":"string"},"birthCounty":{"type":"string"},"birthTown":{"type":"string"},"fatherName":{"type":"string"},"motherName":{"type":"string"},"identifierNumber":{"type":"string"},"labourPeriodStartDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"labourPeriodEndDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"contractCode":{"type":"integer","format":"int32"},"enrolmentDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"seniorityCompanyDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"extraPayCalculationDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"dropDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"agreementCode":{"type":"string"},"agreementDescription":{"type":"string"},"classificationCode":{"type":"integer","format":"int32"},"subClassificationCode":{"type":"integer","format":"int32"},"classificationDescription":{"type":"string"},"jobTitleCode":{"type":"string"},"jobTitleDescription":{"type":"string"},"tariffGroup":{"type":"string"},"collectionType":{"type":"string"}}},"InactivityDay":{"type":"object","properties":{"day":{"type":"integer","format":"int32"},"inactive":{"type":"boolean"}}},"Format304CalendarModel":{"type":"object","properties":{"respectBankHolidays":{"type":"boolean"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"dayType":{"enum":["Complete","Partial","Reduced"],"type":"string"},"monday":{"enum":["Empty","WorkDay","RestDay"],"type":"string"},"tuesday":{"enum":["Empty","WorkDay","RestDay"],"type":"string"},"wednesday":{"enum":["Empty","WorkDay","RestDay"],"type":"string"},"thursday":{"enum":["Empty","WorkDay","RestDay"],"type":"string"},"friday":{"enum":["Empty","WorkDay","RestDay"],"type":"string"},"saturday":{"enum":["Empty","WorkDay","RestDay"],"type":"string"},"sunday":{"enum":["Empty","WorkDay","RestDay"],"type":"string"},"mondayHoursOrPercentage":{"type":"number","format":"double"},"tuesdayHoursOrPercentage":{"type":"number","format":"double"},"wednesdayHoursOrPercentage":{"type":"number","format":"double"},"thursdayHoursOrPercentage":{"type":"number","format":"double"},"fridayHoursOrPercentage":{"type":"number","format":"double"},"saturdayHoursOrPercentage":{"type":"number","format":"double"},"sundayHoursOrPercentage":{"type":"number","format":"double"}}},"CompanyWorkplacesAddressEntityResource":{"type":"object","properties":{"acronym":{"type":"string"},"streetName":{"type":"string"},"buildingNumber":{"type":"string"},"stairWell":{"type":"string"},"floor":{"type":"string"},"gate":{"type":"string"},"city":{"type":"string"},"region":{"type":"string"},"postalCode":{"type":"string"}}},"CompaniesCollectionResource":{"type":"object","properties":{"companyCode":{"type":"integer","format":"int32"},"companyName":{"type":"string"},"identifierNumber":{"type":"string"},"lastUpdate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}}},"PersonalContactDataEntityResource":{"type":"object","properties":{"personalphone":{"type":"string"},"personalphone2":{"type":"string"},"personalemail":{"type":"string"}}},"WithoutBreakdownsGetOutputEntityResource":{"type":"object","properties":{"contentFileBase64":{"type":"string"},"warnings":{"type":"string"}}},"WithoutBreakdownsPostInputEntityResource":{"type":"object","properties":{"accountingCompanyCode":{"type":"integer","format":"int32"},"includeArrearOrDifferences":{"type":"boolean"},"includeExtraPay":{"type":"boolean"},"payDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"payTypeID":{"enum":["Monthly","Extra","Arrear"],"type":"string"}},"example":{"accountingCompanyCode":1234,"includeArrearOrDifferences":false,"includeExtraPay":true,"payDate":"2019-10-01T00:00:00.0000000+00:00","payTypeID":"Extra"}},"WithoutBreakdownsPostOutputEntityResource":{"type":"object","properties":{"processID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"monitorUri":{"type":"string"}}},"JobTitleEntityResource":{"type":"object","properties":{"jobTitleID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"jobTitleCode":{"type":"string"},"jobTitleDescription":{"type":"string"}}},"JobTitleInformation":{"type":"object","properties":{"jobTitleCode":{"type":"string"},"percentage":{"type":"number","format":"double"}}},"IdentificationResource":{"type":"object","properties":{"employeeCode":{"type":"string","description":"EmployeeCode"},"workplaceCode":{"type":"string","description":"WorkplaceCode"},"name":{"type":"string","description":"Name"},"secondName1":{"type":"string","description":"SecondName1"},"secondName2":{"type":"string","description":"SecondName2"},"identifierNumber":{"type":"string","description":"IdentifierNumber"},"identifierNumberExpiryDate":{"type":"string","description":"IdentifierNumberExpiryDate","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"identificationTypeID":{"type":"integer","description":"IdentificationTypeID","format":"int32"},"identificationTypeDescription":{"type":"string","description":"IdentificationTypeDescription"},"ssAffiliationNumber":{"type":"string","description":"SSAffiliationNumber"},"birthPlace":{"type":"string","description":"BirthPlace"},"initialDate":{"type":"string","description":"InitialDate","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"gender":{"type":"string","description":"Employee gender belongs to male, female"},"birthCountry":{"type":"string","description":"BirthCountry"},"civilStatus":{"type":"string","description":"Employee civilStatus belongs to"},"fatherName":{"type":"string","description":"FatherName"},"motherName":{"type":"string","description":"MotherName"},"transferToGt":{"type":"boolean","description":"TransferToGt"},"personTypeID":{"type":"string","description":"PersonTypeID"},"personTypeDescription":{"type":"string","description":"PersonTypeDescription"},"sex":{"type":"string","description":"Sex"},"occupationCodeTGSS":{"type":"string","description":"OccupationCodeTGSS"}},"description":"IdentificationResource"},"EmployeeDetails":{"type":"object","properties":{"identificationTypeID":{"maximum":99,"minimum":0,"type":"integer","format":"int32"},"birthPlace":{"type":"string"},"birthCountryID":{"type":"integer","format":"int32"},"sex":{"type":"string"},"fatherName":{"type":"string"},"motherName":{"type":"string"},"ssAffiliationNumberPrefix":{"maximum":99,"minimum":0,"type":"integer","format":"int32"},"ssAffiliationNumber":{"maximum":99999999,"minimum":0,"type":"integer","format":"int64"},"ssAffiliationNumberSuffix":{"maximum":99,"minimum":0,"type":"integer","format":"int32"},"personTypeID":{"enum":["Trabajador","Profesional","ETT"],"type":"string"},"identifierNumber":{"type":"string"},"identifierNumberExpiryDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"givenName":{"type":"string"},"secondName1":{"type":"string"},"secondName2":{"type":"string"},"initialDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"civilStatusID":{"enum":["Single","Married","Separated","Divorced","Widower","Priest"],"type":"string"},"transferToGt":{"type":"boolean"},"workplaceCode":{"type":"string"}}},"SpecialPut":{"type":"object","properties":{"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"description":{"type":"string"}}},"Special":{"required":["startDate"],"type":"object","properties":{"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"description":{"type":"string"},"specialType":{"enum":["Type1","Type2","Type3"],"type":"string"}}},"PayAdvance":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"description":{"type":"string"},"date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"totalAmount":{"type":"number","format":"double"},"remainingAmount":{"type":"number","format":"double"},"totalMonthly":{"type":"number","format":"double"},"remainingMonthly":{"type":"number","format":"double"},"fundingSource":{"type":"string","readOnly":true},"extraPaymentSources":{"type":"array","items":{"$ref":"#/components/schemas/ExtraPaymentFundingSource"}}}},"ExtraPaymentFundingSource":{"type":"object","properties":{"payment":{"type":"integer","format":"int32"},"paymentId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"description":{"type":"string"},"amount":{"type":"number","format":"double"}}},"EmployeeAdvance":{"type":"object","properties":{"fundingSource":{"enum":["NextExtraPayment","NextMonthlyPayment"],"type":"string"},"extraPaymentSources":{"type":"array","items":{"$ref":"#/components/schemas/ExtraPaymentSource"}},"date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"totalAmount":{"type":"number","format":"double"},"advanceDescription":{"type":"string"}}},"ExtraPaymentSource":{"type":"object","properties":{"extraPaymentId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"amount":{"type":"number","format":"double"}}},"CCCDetails":{"type":"object","properties":{"workPlaceName":{"type":"string"},"ssPaymentNumber":{"type":"string"},"indFormation":{"type":"integer","format":"int32"},"activityID":{"type":"string"},"activityDescription":{"type":"string"},"activityID93":{"type":"string"},"activityDescription93":{"type":"string"},"regimeTypeID":{"type":"string"},"regimeTypeIDDescription":{"type":"string"},"redRegimeID":{"type":"string"}}},"PayEmbargo":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"description":{"type":"string"},"date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"totalAmount":{"type":"number","format":"double"},"remainingAmount":{"type":"number","format":"double"},"totalMonthly":{"type":"number","format":"double"},"remainingMonthly":{"type":"number","format":"double"},"fundingSource":{"type":"string","readOnly":true},"cancellationDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}}},"TheoreticalGross":{"type":"object","properties":{"year":{"type":"integer","format":"int32"},"autGrossCW":{"type":"number","format":"double"},"manGrossCW":{"type":"number","format":"double"},"indAutManCW":{"type":"boolean"},"autGrossPW":{"type":"number","format":"double"},"manGrossPW":{"type":"number","format":"double"},"indAutManPW":{"type":"boolean"},"calculationDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}}},"TheoreticalGrossPut":{"type":"object","properties":{"manGrossCW":{"type":"number","format":"double"},"manGrossPW":{"type":"number","format":"double"},"calculationDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}}},"ExtraPayment":{"type":"object","properties":{"extraPayID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"collectionDateDay":{"type":"integer","format":"int32"},"collectionDateMonth":{"type":"integer","format":"int32"},"amount":{"type":"number","format":"double"},"extraPayName":{"type":"string"}}},"PayModel":{"type":"object","properties":{"payDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"payId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"payType":{"type":"string"},"payTypeId":{"type":"integer","format":"int32"},"periodEndDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"periodStartDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"accruedStartDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"accruedEndDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indCheque":{"type":"boolean"},"totalDeductions":{"type":"number","format":"double"},"systemDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"payLocked":{"type":"boolean"},"workplaceName":{"type":"string"},"workplaceCode":{"type":"string"}}},"PaySubClassificationsModel":{"type":"object","properties":{"paySubClassificationsID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"classificationCode":{"type":"string"},"classificationDescription":{"type":"string"},"classificationFactor":{"type":"number","format":"double"},"employeeFactor":{"type":"number","format":"double"},"factor":{"type":"number","format":"double"}}},"PayConceptsModel":{"type":"object","properties":{"conceptCode":{"type":"integer","format":"int32","readOnly":true},"conceptType":{"type":"string","readOnly":true},"description":{"type":"string","readOnly":true},"payConceptAmount":{"type":"number","format":"double"},"payConceptUnits":{"type":"number","format":"double"},"payConceptUnitsAmount":{"type":"number","format":"double"},"indMonthlyPayCollection":{"type":"boolean"},"indExtraPayCollection":{"type":"boolean"},"conceptCollectionTypeID":{"type":"integer","format":"int32"},"conceptCollectionTypeDesc":{"type":"string"},"paySubClassificationsID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"isDiscount":{"type":"boolean"}}},"PayBonificationsModel":{"type":"object","properties":{"payTypeID":{"type":"integer","format":"int32"},"payTypeDescription":{"type":"string"},"payDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"paymentDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"accruedStartDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"accruedEndDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"periodStartDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"periodEndDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"bonificationTypeID":{"type":"integer","format":"int32"},"bonificationTypeDescription":{"type":"string"},"bonificationTypePercentage":{"type":"number","format":"double"},"bonificationTypePercentageIncrement":{"type":"number","format":"double"},"bonificationStartDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"bonificationEndDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"dispositionDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"validityStartDate":{"type":"string"},"validityPercentage":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"validityAmount":{"type":"number","format":"double"},"duration":{"type":"integer","format":"int32"},"bonification":{"type":"boolean"},"commonContingencies":{"type":"boolean"},"accidentContingencies":{"type":"boolean"},"unemploymentContingencies":{"type":"boolean"},"fpContingencies":{"type":"boolean"},"fogasaContingencies":{"type":"boolean"},"bonusCommunityCode":{"type":"string"},"situationTypeID":{"type":"integer","format":"int32"},"situationCode":{"type":"integer","format":"int32"},"situationCodeDescription":{"type":"string"},"bonificationValidityAmount":{"type":"number","format":"double"},"bonificationValidityUnits":{"type":"number","format":"double"},"description":{"type":"string"}}},"CalculatedInternalConceptsModel":{"type":"object","properties":{"indPayrollSheet":{"type":"boolean"},"indDeduction":{"type":"boolean"},"indForcedConcept":{"type":"boolean"},"indPaysIRPFTax":{"type":"boolean"},"indQuotesCC":{"type":"boolean"},"indQuotesPC":{"type":"boolean"},"internalConceptID":{"type":"integer","format":"int32"},"longDescription":{"type":"string"},"shortDescription":{"type":"string"},"calculatedAmount":{"type":"number","format":"double"},"calculatedPercentage":{"type":"number","format":"double"},"calculatedUnits":{"type":"number","format":"double"},"compensationDeductionID":{"type":"integer","format":"int32"},"craID":{"type":"integer","format":"int32"},"isDiscount":{"type":"boolean"}}},"ReturnArrestImports":{"type":"object","properties":{"embargoRest":{"type":"number","format":"double"},"descuentoEmbargo":{"type":"number","format":"double"},"embargoTotal":{"type":"number","format":"double"}}},"AddEmployeeConcept":{"type":"object","properties":{"conceptCollectionTypeID":{"type":"integer","format":"int32"},"showOnPayrollSheet":{"type":"boolean"},"observations":{"type":"string"},"conceptCode":{"type":"string"},"amount":{"type":"number","format":"double"}}},"EmployeeConceptInfoListModel":{"type":"object","properties":{"conceptCode":{"type":"integer","format":"int32"},"description":{"type":"string"},"amount":{"type":"number","format":"double"},"conceptType":{"type":"string"},"inKind":{"type":"boolean"},"manual":{"type":"boolean"},"conceptCollectionTypeID":{"type":"integer","format":"int32"},"conceptCollectionTypeDesc":{"type":"string"}}},"EmployeeConceptInfoModelL1":{"type":"object","properties":{"conceptCode":{"type":"integer","format":"int32"},"description":{"type":"string"},"amount":{"type":"number","format":"double"},"conceptType":{"type":"string"},"inKind":{"type":"boolean"},"conceptCollectionTypeID":{"type":"integer","format":"int32"},"conceptCollectionTypeDesc":{"type":"string"},"indAbsenteeism":{"type":"boolean"},"indAutonomousSS":{"type":"boolean"},"indCollectionDiscount":{"type":"boolean"},"indEnrolmentDrop":{"type":"boolean"},"indExtraHours":{"type":"integer","format":"int32"},"indExtraPayCollection":{"type":"boolean"},"indForceFactor":{"type":"boolean"},"indHoliDays":{"type":"boolean"},"indInactivityPeriods":{"type":"boolean"},"indIncentive":{"type":"boolean"},"indInKindCompensation":{"type":"integer","format":"int32"},"indIRPFNotSubject":{"type":"boolean"},"indIrregular":{"type":"boolean"},"indLaborUnionQuote":{"type":"boolean"},"indModified":{"type":"boolean"},"indMonthlyPayCollection":{"type":"boolean"},"indMutualityContribution":{"type":"integer","format":"int32"},"indMutualityReduction":{"type":"boolean"},"indNotClassificationFactor":{"type":"boolean"},"indOnAccountConcept":{"type":"boolean"},"indOrphanSchoolContribution":{"type":"boolean"},"indOtherFreeIncome":{"type":"boolean"},"indPaidLeave":{"type":"boolean"},"indPartialExemption":{"type":"boolean"},"indPartialTime":{"type":"boolean"},"indPartialUnemployment":{"type":"boolean"},"indPayrollSheet":{"type":"boolean"},"indPaysIRPFTax":{"type":"boolean"},"indPensionPlans":{"type":"integer","format":"int32"},"indPensionReduction":{"type":"boolean"},"indQuotesCC":{"type":"boolean"},"indQuotesPC":{"type":"boolean"},"indShowOnPayrollSheet":{"type":"boolean"},"indStrike":{"type":"boolean"},"indSuspension":{"type":"boolean"},"indTDAccident":{"type":"boolean"},"indTDIllness":{"type":"boolean"},"indTDMaternity":{"type":"boolean"},"indTDPregnancyRisk":{"type":"boolean"},"indUnitaryAmount":{"type":"boolean"},"indUnpaidLeave":{"type":"boolean"},"indVacationsCollection":{"type":"boolean"}}},"CompanyConcept":{"type":"object","properties":{"conceptCode":{"type":"integer","format":"int32"},"description":{"type":"string"},"conceptType":{"type":"string"}}},"ExcludedConceptGroup":{"type":"object","properties":{"groupID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"description":{"type":"string"}}},"PayAccrueds":{"type":"object","properties":{"situationType":{"type":"string"},"situationBreakDown":{"type":"string"},"units_N_Collection":{"type":"number","format":"double"},"units_N_Contribution":{"type":"number","format":"double"},"units_L":{"type":"number","format":"double"},"units_LL":{"type":"number","format":"double"},"units_LX":{"type":"number","format":"double"},"units_LLX":{"type":"number","format":"double"},"units_DSL":{"type":"number","format":"double"},"units_DSS":{"type":"number","format":"double"},"units_DSD":{"type":"number","format":"double"},"units_FT":{"type":"number","format":"double"},"units_H":{"type":"number","format":"double"},"percentage":{"type":"number","format":"double"},"payTemporaryDisabilityID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"payAbsenteeismID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"situationStartDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"situationEndDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"situationBreakDownStartDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"situationBreakDownEndDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"payUnemploymentID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"units_SAB":{"type":"number","format":"double"},"units_DOM":{"type":"number","format":"double"},"units_N_ContributionForCollection":{"type":"number","format":"double"},"termType":{"type":"string"},"termOrderID":{"type":"integer","format":"int32"},"termStartDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"termEndDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"units_H_SLD":{"type":"number","format":"double"}}},"PayAccrualInfo":{"type":"object","properties":{"calendarDaysWorked":{"type":"number","format":"double"},"calendarDaysAbsent":{"type":"number","format":"double"},"workDayType":{"type":"string"},"daysAccrued":{"type":"number","format":"double"},"percentage":{"type":"number","format":"double"}}},"EmployeePayData":{"type":"object","properties":{"payID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"identifierNumber":{"type":"string"},"workDayTypeID":{"type":"integer","format":"int32"},"workDayPercentage":{"type":"number","format":"double"},"ssAffiliationNumberPrefix":{"type":"integer","format":"int32"},"ssAffiliationNumber":{"type":"integer","format":"int32"},"ssAffiliationNumberSuffix":{"type":"integer","format":"int32"},"agreementCode":{"type":"string"},"classificationCode":{"type":"integer","format":"int32"},"classificationDescription":{"type":"string"},"regimeTypeID":{"type":"string"},"tariffGroupID":{"type":"integer","format":"int32"},"contractCode":{"type":"integer","format":"int32"},"collectionTypeID":{"type":"integer","format":"int32"},"seniorityCalculationDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"contributionTypeID":{"type":"integer","format":"int32"},"indFormation":{"type":"integer","format":"int32"},"commonContingenciesMax":{"type":"number","format":"double"},"commonContingenciesMin":{"type":"number","format":"double"},"accidentsBaseMax":{"type":"number","format":"double"},"accidentsBaseMin":{"type":"number","format":"double"},"accidentsUnemploymentMax":{"type":"number","format":"double"},"accidentsUnemploymentMin":{"type":"number","format":"double"},"accidentsTrainingMax":{"type":"number","format":"double"},"accidentsTrainingMin":{"type":"number","format":"double"},"accidentsFogasaMax":{"type":"number","format":"double"},"accidentsFogasaMin":{"type":"number","format":"double"},"enrolmentDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"dropDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"extraPayCalculationDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"ssPaymentNumberID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"ssPaymentNumber":{"type":"string"},"indNoResident":{"type":"integer","format":"int32"},"agreementDescription":{"type":"string"},"contractDescription":{"type":"string"},"contributionTypeDescription":{"type":"string"},"ccGroupDescription":{"type":"string"},"dropCauseID":{"type":"integer","format":"int32"},"subClassificationCode":{"type":"integer","format":"int32"},"subClassificationDescription":{"type":"string"},"jobTitleCode":{"type":"string"},"jobTitle":{"type":"string"},"contributionAgrarianModeID":{"type":"integer","format":"int32"},"indReductionRealDay":{"type":"boolean"},"agrarianCensusExclusionTypeID":{"type":"integer","format":"int32"},"labourPeriodStartDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"labourPeriodEndDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"seniorityCompanyDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"extensionStartDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"extensionEndDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"extensionsNumber":{"type":"integer","format":"int32"},"indIgnoreMinTax":{"type":"boolean"},"workplaceBankAccountID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"indEmployeeSubClassification":{"type":"boolean"},"citricRegimeContributionTypeID":{"type":"integer","format":"int32"},"indENotGenSegmCRW":{"type":"boolean"},"indEAutManNotGenSegmCRW":{"type":"boolean"},"citricRegimePermanenceCoefficientTypeID":{"type":"integer","format":"int32"},"payLocked":{"type":"boolean"},"baseAC":{"type":"number","format":"double"},"baseCC":{"type":"number","format":"double"},"prorratedExtraPay":{"type":"number","format":"double"},"totalBaseIRPF":{"type":"number","format":"double"},"totalDeduction":{"type":"number","format":"double"},"totalGross":{"type":"number","format":"double"},"totalRemuneration":{"type":"number","format":"double"},"costBusiness":{"type":"number","format":"double"},"percentageIMS":{"type":"number","format":"double"},"percentageIT":{"type":"number","format":"double"},"indPublication":{"type":"boolean"},"workplaceCode":{"type":"string"},"publicationDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"hasMailTo":{"type":"boolean","readOnly":true},"irpfPercentage":{"type":"number","format":"double"}}},"CompanyPayData":{"type":"object","properties":{"payDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"payID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"payType":{"type":"string"},"payTypeID":{"type":"integer","format":"int32"},"periodEndDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"periodStartDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"accruedStartDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"accruedEndDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"workplaceCode":{"type":"string"},"workplaceName":{"type":"string"},"employeeId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"employeeCode":{"type":"string"},"completeName":{"type":"string"},"identifierNumber":{"type":"string"},"baseCC":{"type":"number","format":"double"},"baseAC":{"type":"number","format":"double"},"prorratedExtraPay":{"type":"number","format":"double"},"totalBaseIRPF":{"type":"number","format":"double"},"totalDeduction":{"type":"number","format":"double"},"totalGross":{"type":"number","format":"double"},"totalRemuneration":{"type":"number","format":"double"},"costBusiness":{"type":"number","format":"double"},"systemDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"payLocked":{"type":"boolean"},"indPublication":{"type":"boolean"},"hasMailTo":{"type":"boolean","readOnly":true}}},"EmployeePayCostAttribution":{"type":"object","properties":{"payCostAttributionID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"payID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"costAttributionID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"costAttributionTreeID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"costAttributionNodeID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"percentageAttribution":{"type":"number","format":"double"},"costAttributionNodeDescription":{"type":"string"},"costAttributionNodeCode":{"type":"string"},"variableConceptID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"percentageTotal":{"type":"number","format":"double"}}},"HistoricPayDaysInfoResource":{"type":"object","properties":{"situationTypeID":{"type":"integer","format":"int32"},"description":{"type":"string"},"units_N_Collection":{"type":"number","format":"double"},"units_N_Contribution":{"type":"number","format":"double"},"units_L":{"type":"number","format":"double"},"units_LL":{"type":"number","format":"double"},"units_LX":{"type":"number","format":"double"},"units_LLX":{"type":"number","format":"double"},"units_DSL":{"type":"number","format":"double"},"units_H":{"type":"number","format":"double"}}},"EmployeeAffiliationDataGet":{"type":"object","properties":{"specialContract":{"type":"string"},"employeeCollective":{"type":"string"},"sustitutionCause":{"type":"string"},"sustitutionEmployee":{"type":"string"},"specialContractID":{"type":"integer","format":"int32"},"employeeCollectiveID":{"type":"integer","format":"int32"},"sustitutionCauseID":{"enum":["none","familyCare","riskBirthPregnancyBreastfeeding","advanceRetirement64","disabled","disabledIT","genderViolence","vacancyCoverage","sexualViolenceVictim","riskRestMinorCarePregnancyBreastfeeding"],"type":"string"},"sustitutionEmployeeID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"sustitutionEmployeeNAFPrefix":{"type":"integer","format":"int32"},"sustitutionEmployeeNAF":{"type":"integer","format":"int32"},"sustitutionEmployeeNAFSuffix":{"type":"integer","format":"int32"}}},"EmployeeAffiliationDataPut":{"type":"object","properties":{"specialContractID":{"type":"integer","format":"int32"},"employeeCollectiveID":{"type":"integer","format":"int32"},"sustitutionCauseID":{"enum":["none","familyCare","riskBirthPregnancyBreastfeeding","advanceRetirement64","disabled","disabledIT","genderViolence","vacancyCoverage","sexualViolenceVictim","riskRestMinorCarePregnancyBreastfeeding"],"type":"string"},"sustitutionEmployeeID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"sustitutionEmployeeNAFPrefix":{"type":"integer","format":"int32"},"sustitutionEmployeeNAF":{"type":"integer","format":"int32"},"sustitutionEmployeeNAFSuffix":{"type":"integer","format":"int32"}}},"WorkplaceBankAccountCodeModel":{"type":"object","properties":{"bankAccountCode":{"type":"object","readOnly":true},"is110":{"type":"object","readOnly":true},"isTC1":{"type":"object","readOnly":true}}},"WorkplaceBankAccountModel":{"type":"object","properties":{"bank1":{"type":"string"},"bank2":{"type":"string","readOnly":true},"bank3":{"type":"string","readOnly":true},"bank4":{"type":"string","readOnly":true},"ibanSuffix":{"type":"string","readOnly":true},"iban":{"type":"string","readOnly":true},"bic":{"type":"string","readOnly":true},"isBigAccount":{"type":"boolean","readOnly":true}}},"TemporaryDisability":{"type":"object","properties":{"temporaryDisabilityID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"employeeID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"employeeCode":{"type":"string"},"incidentTypeID":{"type":"integer","format":"int32"},"description":{"type":"string"},"startdate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"enddate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indCovid19":{"type":"boolean"},"indHospitalization":{"type":"boolean"},"indComplement":{"type":"boolean"},"percentagePartialMaternity":{"type":"number","format":"double"},"benefitTypeId":{"type":"integer","format":"int32"},"contingencyID":{"type":"integer","format":"int32"},"relapsedIncidentID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"parentIncidentID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"lastUpdate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indAutManEndDate":{"type":"boolean"},"forcedDescription":{"type":"string"}}},"Relapse":{"required":["startDate"],"type":"object","properties":{"startDate":{"type":"string","description":"StartDate","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","description":"EndDate","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"forcedDescription":{"type":"string","description":"ForcedDescription"},"indHospitalization":{"type":"boolean","description":"IndHospitalization"}},"description":"Relapse"},"BankAccountsResource":{"required":["entity","agency","digitControl","account"],"type":"object","properties":{"entity":{"pattern":"^[0-9]{4}$","type":"string"},"agency":{"pattern":"^[0-9]{4}$","type":"string"},"digitControl":{"pattern":"^[0-9]{2}$","type":"string"},"account":{"pattern":"^[0-9]{10}$","type":"string"},"iban":{"type":"string"},"holder":{"type":"string"},"isMainAccount":{"type":"boolean"},"distributionAmount":{"type":"number","format":"double"},"distributionPercentage":{"type":"number","format":"double"},"bic":{"type":"string"},"conceptCode":{"type":"integer","format":"int32"},"conceptDescription":{"type":"string"}}},"EmployeeCompanyBankAccountResource":{"required":["entity","agency","digitControl","account"],"type":"object","properties":{"entity":{"pattern":"^[0-9]{4}$","type":"string"},"agency":{"pattern":"^[0-9]{4}$","type":"string"},"digitControl":{"pattern":"^[0-9]{2}$","type":"string"},"account":{"pattern":"^[0-9]{10}$","type":"string"},"iban":{"type":"string"},"holder":{"type":"string"},"isMainAccount":{"type":"boolean"},"distributionAmount":{"type":"number","format":"double"},"distributionPercentage":{"type":"number","format":"double"},"bic":{"type":"string"},"conceptCode":{"type":"integer","format":"int32"},"conceptDescription":{"type":"string"},"indChequeCollection":{"type":"boolean","description":"Gets or sets a value indicating whether cheque collection is enabled."},"indCheque":{"type":"boolean","description":"Gets or sets a value indicating whether cheque payment is enabled."},"indChequeMonthlyPays":{"type":"boolean","description":"Gets or sets a value indicating whether cheques are used for monthly pays."},"indChequeExtraPays":{"type":"boolean","description":"Gets or sets a value indicating whether cheques are used for extra pays."},"indChequeArrearPays":{"type":"boolean","description":"Gets or sets a value indicating whether cheques are used for arrear pays."},"indChequeSettlementPays":{"type":"boolean","description":"Gets or sets a value indicating whether cheques are used for settlement pays."},"indChequeDifferencesPays":{"type":"boolean","description":"Gets or sets a value indicating whether cheques are used for differences pays."},"indChequeExpensesNotesPays":{"type":"boolean","description":"Gets or sets a value indicating whether cheques are used for expenses notes pays."},"indChequeSettlementMonthlyPays":{"type":"boolean","description":"Gets or sets a value indicating whether cheques are used for settlement monthly pays."},"indChequeAdvancePays":{"type":"boolean","description":"Gets or sets a value indicating whether cheques are used for advance pays."}}},"EmployeeBankAccountCodeModel":{"type":"object","properties":{"bankAccountCode":{"type":"string","format":"uuid","readOnly":true,"example":"00000000-0000-0000-0000-000000000000"},"isMainAccount":{"type":"boolean","readOnly":true}}},"PayBankAccountResource":{"type":"object","properties":{"payBankAccountCode":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}},"CostAttributionModel":{"required":["startDate"],"type":"object","properties":{"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"levels":{"type":"array","items":{"$ref":"#/components/schemas/CostAttributionLevelModel"}},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}}},"CostAttributionLevelModel":{"type":"object","properties":{"costAttributionNodeID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"percentage":{"type":"number","format":"double"},"costAttributionTreeID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}},"EmployeeIncentive":{"type":"object","properties":{"incentiveID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"incentiveDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"incentiveTypeID":{"type":"integer","format":"int32"},"incentiveDescription":{"type":"string"},"amount":{"type":"number","format":"double"},"observations":{"type":"string"}}},"EmployeeSanction":{"type":"object","properties":{"sanctionID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"sanctionDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"sanctionTypesDescription":{"type":"string"},"sanctionSeriousnessDescription":{"type":"string"},"observations":{"type":"string"}}},"EmployeeIRPFDataModel":{"type":"object","properties":{"pensionPlan":{"type":"number","format":"double"},"detractions":{"type":"number","format":"double"},"spousePension":{"type":"number","format":"double"},"foodAnnualAllowance":{"type":"number","format":"double"},"perceptionTypeCode":{"type":"string"},"subPerceptionKey":{"type":"integer","format":"int32"},"withholdingPercentage":{"type":"number","format":"double"},"disabilityLevel":{"type":"number","format":"double"},"indHelp":{"type":"boolean"},"familySituationCode":{"type":"integer","format":"int32"},"spouseNIF":{"type":"string"},"indAscendants":{"type":"boolean"},"indDescendants":{"type":"boolean"},"indNoResident":{"type":"integer","format":"int32"},"noResidentCountryID":{"type":"string"},"indMobility":{"type":"boolean"},"mobilityDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indAutMan":{"type":"integer","format":"int32"},"childrenNumber":{"type":"integer","format":"int32"},"irpfBasePercentage":{"type":"number","format":"double"},"indEconomicActivities":{"type":"boolean"},"noResidentAddress":{"type":"string"},"noResidentAddressComplement":{"type":"string"},"noResidentCity":{"type":"string"},"noResidentRegion":{"type":"string"},"noResidentZip":{"type":"string"},"noResidentNIF":{"type":"string"},"noResidentCountryBirth":{"type":"string"},"noResidentTaxResident":{"type":"string"},"indHomeInvestment":{"type":"boolean"},"homePreviousWithholdingPercentage":{"type":"number","format":"double"},"homeAcquerementDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"referencePercentage":{"type":"number","format":"double"},"indBusinessAmountLessThan100000":{"type":"boolean"}}},"IRPFCalcuation":{"type":"object","properties":{"retentionPercentage":{"type":"number","format":"double"},"lastForecastDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"fixedRemuneration":{"$ref":"#/components/schemas/FixedRemuneration"},"variableRemuneration":{"$ref":"#/components/schemas/VariableRemuneration"},"irregularExpensesIncome":{"$ref":"#/components/schemas/IrregularExpensesIncome"},"reductions":{"$ref":"#/components/schemas/Reductions"},"results":{"$ref":"#/components/schemas/Results"},"simulatedRemuneration":{"$ref":"#/components/schemas/SimulatedRemuneration"},"controlSpecies":{"$ref":"#/components/schemas/ControlSpecies"}}},"FixedRemuneration":{"type":"object","properties":{"charged":{"type":"number","format":"double"},"earning":{"type":"number","format":"double"},"imported":{"type":"number","format":"double"},"importedOverride":{"type":"boolean"}}},"VariableRemuneration":{"type":"object","properties":{"charged":{"type":"number","format":"double"},"imported":{"type":"number","format":"double"},"importedOverride":{"enum":["Automatic","SemiAutomatic","Manual"],"type":"string"},"previousYear":{"type":"number","format":"double"},"previousYearOverride":{"type":"boolean"}}},"IrregularExpensesIncome":{"type":"object","properties":{"monetaryInKindCompensation":{"type":"number","format":"double"},"netIncomeWork":{"type":"number","format":"double"},"pensionPlans":{"type":"number","format":"double"},"pensionPlansOverride":{"type":"boolean"},"mutualSocialSecurityContribution":{"type":"number","format":"double"},"mutualSocialSecurityContributionOverride":{"type":"boolean"},"reductionIrregularIncome":{"type":"number","format":"double"},"reductionIrregularIncomeOverride":{"type":"boolean"},"quotationSocialSecurityMutualEmployee":{"type":"number","format":"double"},"quotationSocialSecurityMutualEmployeeOverride":{"type":"boolean"},"socialSecuritySelfEmployed":{"type":"number","format":"double"},"socialSecuritySelfEmployedOverride":{"type":"boolean"},"deductionsPassiveRights":{"type":"number","format":"double"},"orphanageSchoolQuotes":{"type":"number","format":"double"},"orphanageSchoolQuotesOverride":{"type":"boolean"}}},"Reductions":{"type":"object","properties":{"workReductions":{"type":"number","format":"double"},"reductionsActiveWorkers":{"type":"number","format":"double"},"reductionDueToMinimumStaff":{"type":"number","format":"double"},"recipientReductions":{"type":"number","format":"double"},"reductionForFamilyMinimum":{"type":"number","format":"double"},"spousalCompensatoryPensions":{"type":"number","format":"double"},"childSupportAnnuities":{"type":"number","format":"double"},"reductionCopaAmerica":{"type":"number","format":"double"}}},"Results":{"type":"object","properties":{"taxableBaseForType":{"type":"number","format":"double"},"retentionFee":{"type":"number","format":"double"},"limitQuota35":{"type":"number","format":"double"},"limitQuota45":{"type":"number","format":"double"}}},"SimulatedRemuneration":{"type":"object","properties":{"fixedRemuneration":{"type":"number","format":"double"},"fixedRemunerationOverride":{"type":"boolean"},"socialSecurityWorker":{"type":"number","format":"double"},"socialSecurityWorkerOverride":{"type":"boolean"},"withholdingsMade":{"type":"number","format":"double"},"withholdingsMadeOverride":{"type":"boolean"}}},"ControlSpecies":{"type":"object","properties":{"remunerationInKindPercentage":{"type":"number","format":"double"},"totaRemuneration":{"type":"number","format":"double"},"monetaryCompensation":{"type":"number","format":"double"},"benefitsInKind":{"type":"number","format":"double"},"estimatedSMI":{"type":"number","format":"double"}}},"IRPFCalcuationPut":{"type":"object","properties":{"fixedRemuneration":{"$ref":"#/components/schemas/FixedRemunerationPut"},"variableRemuneration":{"$ref":"#/components/schemas/VariableRemunerationPut"}}},"FixedRemunerationPut":{"type":"object","properties":{"imported":{"type":"number","format":"double"},"importedOverride":{"type":"boolean"}}},"VariableRemunerationPut":{"type":"object","properties":{"imported":{"type":"number","format":"double"},"importedOverride":{"enum":["Automatic","SemiAutomatic","Manual"],"type":"string"},"previousYear":{"type":"number","format":"double"},"previousYearOverride":{"type":"boolean"}}},"EmployeeIRPFDataDescendantModelWithId":{"type":"object","properties":{"irpfDescendantID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"birthDate":{"maximum":2900,"minimum":1900,"type":"integer","format":"int32"},"deductionPercentage":{"type":"integer","format":"int32"},"disabilityPercentage":{"type":"number","format":"double"},"leaveDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"withHelp":{"type":"boolean"},"welcome":{"type":"boolean"},"welcomeDate":{"type":"integer","format":"int32"},"order":{"type":"integer","format":"int32"}}},"EmployeeIRPFDataDescendantModel":{"type":"object","properties":{"birthDate":{"maximum":2900,"minimum":1900,"type":"integer","format":"int32"},"deductionPercentage":{"type":"integer","format":"int32"},"disabilityPercentage":{"type":"number","format":"double"},"leaveDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"withHelp":{"type":"boolean"},"welcome":{"type":"boolean"},"welcomeDate":{"type":"integer","format":"int32"},"order":{"type":"integer","format":"int32"}}},"EmployeeIRPFDataAscendantModelWithId":{"type":"object","properties":{"irpfAscendantID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"descendantsLivingWith":{"type":"integer","format":"int32"},"disabilityPercentage":{"type":"number","format":"double"},"birthDate":{"maximum":2900,"minimum":1900,"type":"integer","format":"int32"},"leaveDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"withHelp":{"type":"boolean"},"order":{"type":"integer","format":"int32"}}},"EmployeeIRPFDataAscendantModel":{"type":"object","properties":{"descendantsLivingWith":{"type":"integer","format":"int32"},"disabilityPercentage":{"type":"number","format":"double"},"birthDate":{"maximum":2900,"minimum":1900,"type":"integer","format":"int32"},"leaveDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"withHelp":{"type":"boolean"},"order":{"type":"integer","format":"int32"}}},"ProfIRPFDataLine":{"type":"object","properties":{"date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"base":{"type":"number","format":"double"},"withholding":{"type":"number","format":"double"},"perceptionCode":{"type":"string"},"subPerceptionKey":{"type":"integer","format":"int32"},"administrationCode":{"type":"string"},"perceptionDescritpion":{"type":"string"}}},"AccountingLinkGroupResource":{"type":"object","properties":{"acountingLinkGroupID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"groupDescription":{"type":"string"}}},"SingleBodyFieldIdGuid":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}},"ClauseResource":{"type":"object","properties":{"clauseID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"clauseDescription":{"type":"string"},"clauseText":{"type":"string"}}},"AgreementLookupResource":{"type":"object","properties":{"agreementCode":{"type":"string"},"description":{"type":"string"},"endValidityDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"field":{"type":"string"},"holidaysDaysNumber":{"type":"integer","format":"int32"},"holidaysDaysType":{"type":"string"},"revision":{"type":"integer","format":"int32"},"startValidityDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"workingHours":{"type":"integer","format":"int32"}}},"AgreementSeniorityGroupLookupResource":{"type":"object","properties":{"groupID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"description":{"type":"string"},"seniorityCollectionTypeID":{"type":"integer","format":"int32"},"formulaID":{"type":"integer","format":"int32"},"consolidationDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}}},"AgreementSeniorityGroupResource":{"type":"object","properties":{"groupID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"description":{"type":"string"},"seniorityCollectionTypeID":{"type":"integer","format":"int32"},"formulaID":{"type":"integer","format":"int32"},"consolidationDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indMonthlyPayCollection":{"type":"boolean"},"indVacationsCollection":{"type":"boolean"},"indQuotesCC":{"type":"boolean"},"indQuotesPC":{"type":"boolean"},"indPaysIRPFTax":{"type":"boolean"},"indTDAccident":{"type":"boolean"},"indTDIllness":{"type":"boolean"},"indTDMaternity":{"type":"boolean"},"indTDPregnancyRisk":{"type":"boolean"},"indAbsenteeism":{"type":"boolean"},"indSuspension":{"type":"boolean"},"indPartialTime":{"type":"boolean"},"indPartialUnemployment":{"type":"boolean"},"indStrike":{"type":"boolean"},"indEnrolmentDrop":{"type":"boolean"},"indHolidays":{"type":"boolean"},"indAgreementArrears":{"type":"boolean"},"indSeniorityChange":{"type":"integer","format":"int32"},"indInactivityPeriods":{"type":"boolean"}}},"AgreementITComplementResource":{"type":"object","properties":{"groupID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"description":{"type":"string"},"startDay":{"type":"integer","format":"int32"},"endDay":{"type":"integer","format":"int32"},"percentage":{"type":"number","format":"double"},"complementTypeID":{"type":"integer","format":"int32"},"complementTypeDescription":{"type":"string"}}},"BasicCopyData":{"type":"object","properties":{"baseCopyClauseID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"baseCopyFirmTypeID":{"enum":["SignedByLegalRepresentatives","NoLegalRepresentation","NoCopyProvided","RefuseToSign"],"type":"string"}}},"PartTimeData":{"type":"object","properties":{"workDayTypeID":{"enum":["Anual","Daily","Monthly","Weekly"],"type":"string"},"workDayHours":{"type":"integer","format":"int32"},"workDayMinutes":{"maximum":59,"minimum":0,"type":"integer","format":"int32"},"agreementHours":{"type":"integer","format":"int32"},"agreementMinutes":{"maximum":59,"minimum":0,"type":"integer","format":"int32"},"undatedActivity":{"type":"boolean"}}},"TimeTable":{"type":"object","properties":{"workDayTypeID":{"enum":["Complete","Partial","FollowingClause"],"type":"string"},"totalWeekHours":{"type":"number","format":"double"},"completeWorkDayStartID":{"enum":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"],"type":"string"},"completeWorkDayEndID":{"enum":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"],"type":"string"},"workDayDistribution":{"type":"string"},"indComplementaryHours":{"type":"boolean"},"annexDocument":{"type":"string"},"partialPeriodTypeID":{"enum":["Year","Month","Week","Day"],"type":"string"},"partialHours":{"type":"number","format":"double"},"workDayNotLessThan":{"enum":["NotSpecified","ComparableFullTimeWorker","FullTimeScheduleCollectiveAgreement","LegalMaximum"],"type":"string"},"workDayMax":{"type":"integer","format":"int32"}}},"EmployeeClauseResource":{"type":"object","properties":{"clauseID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"clauseDescription":{"type":"string"},"clauseText":{"type":"string"},"indCompanyClause":{"type":"boolean"}}},"PregnancyRiskPut":{"type":"object","properties":{"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"description":{"type":"string"}}},"PregnancyRisk":{"required":["startDate"],"type":"object","properties":{"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"description":{"type":"string"}}},"HolidaysPercentagesCollectionResource":{"type":"object","properties":{"percentage":{"type":"number","format":"double"},"description":{"type":"string"}},"description":""},"EmployeeFormationResource":{"type":"object","properties":{"reserve":{"type":"boolean"},"comments":{"type":"string"},"test_Comments":{"type":"string"},"totalPresent":{"type":"integer","format":"int32"},"totalAbsent":{"type":"integer","format":"int32"},"personalCosts_ManualAutomatic":{"type":"string"},"personalCosts_Cost":{"type":"string"},"personalCosts_LabourHours":{"type":"string"},"personalCosts_HourCost":{"type":"string"},"retires":{"type":"integer","format":"int32"},"priorityEmployee":{"type":"boolean"},"discapacity":{"type":"boolean"},"functionalAreaId":{"type":"integer","format":"int32"},"profCategoryId":{"type":"integer","format":"int32"},"studiesLevelId":{"type":"integer","format":"int32"},"otherTitles":{"type":"string"},"functionalAreaDescription":{"type":"string"},"profCategoryDescription":{"type":"string"},"studiesLevelDescription":{"type":"string"},"called_Done":{"type":"boolean"},"other_Done":{"type":"boolean"},"cancelation":{"type":"boolean"},"modification":{"type":"boolean"},"other_Notices":{"type":"boolean"},"called_Date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"cancelation_Date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"modification_Date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"other_Notices_Date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"invitationMeans":{"type":"string"},"cancelation_Media":{"type":"string"},"modification_Media":{"type":"string"},"other_Notices_Media":{"type":"string"},"called_Comments":{"type":"string"},"cancelation_Comments":{"type":"string"},"modification_Comments":{"type":"string"},"other_Notices_Comments":{"type":"string"},"certificate_Done":{"type":"boolean"},"achievement_Certificate":{"type":"boolean"},"certificate_Date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"achievement_Certificate_Date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"other_Certificate_Date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"att_Certificate_Media":{"type":"string"},"achievement_Certificate_Media":{"type":"string"},"other_Certificate_Media":{"type":"string"},"certificate_Comments":{"type":"string"},"achievement_Certificate_Comments":{"type":"string"},"other_Certificate_Comments":{"type":"string"},"presence":{"type":"string"},"called_NotificationType":{"type":"string"},"userId":{"type":"string"},"test_Done":{"type":"boolean"},"test_Date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"niss":{"type":"string"},"classificationDescription":{"type":"string"},"contributionTypeDescription":{"type":"string"},"regimeDescription":{"type":"string"},"genderViolenceVictim":{"type":"boolean"},"terrorismVictim":{"type":"boolean"},"phoneNumber":{"type":"string"},"hasAccreditingDiploma":{"type":"boolean"}}},"CompanyWorkplacesDataContactResource":{"type":"object","properties":{"phonenumber1":{"type":"string"},"phonenumber2":{"type":"string"},"extension1":{"type":"string"},"extension2":{"type":"string"},"fax":{"type":"string"},"email1":{"type":"string"},"email2":{"type":"string"}}},"HiringDatesEntityResource":{"type":"object","properties":{"enrolmentDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"dropDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"dropCause":{"enum":["_Vacio","Alta","Voluntaria del Trabajador","Baja despido disciplinario individual","Baja no voluntaria por otras causas","Baja por fusión-absorción empresa","Fallecimiento","Situación de Pensionista","Exc. Servicio Militar","Exc. Voluntaria","Agotamiento I.T.","Exc. Cuidado de Hijos","Baja suspensión temporal ERE","Exc. Cuidado de Familiares","Otras causas de suspensión","Baja despido colectivo","Suspensión por violencia de género","Baja por dimisión","Baja por no superar periodo de prueba","Baja despido causas objetivas empresa","Baja despido causa objetiva trabajador","Baja por fin contrato temporal o duración determinada","Baja por pase a inactividad fijos discontinuos","Otras causas de Baja","01 Despido del trabajador","02 Despido por causas objetivas. Amortización por causas económicas, técnicas, organizativas o de producción.","03 Muerte del empresario","04 Jubilación del empresario","05 Incapacidad del empresario","06 Cese por declaración de invalidez permanente total del trabajador","07 Cese en periodo de prueba a instancia del empresario","08 Cese en periodo de prueba por acuerdo del Consejo Rector en el supuesto de socios de cooperativas","09 Cese en periodo de prueba a instancia del trabajador","10 Cese por voluntad del empresario en la relación laboral de alta dirección","11 Fin del contrato temporal a instancia del empresario","12 Fin del contrato temporal a instancia del trabajador","13 Fin de la relación administrativa temporal de funcionarios de empleo y contratados administrativos","14 Resolución del trabajador por traslado.","15 Fin o interrupción de la actividad de los trabajadores fijos-discontinuos","16 Extinción del contrato autorizada en E.R.E. o por auto judicial o constatada por la autoridad laboral en cooperativas","17 Suspensión del contrato autorizada en E.R.E. o por auto judicial o constatada por la autoridad laboral en cooperativas","18 Reducción temporal de jornada autorizada en E.R.E. o por auto judicial o constatada por la autoridad laboral en cooperativas","19 Suspensión voluntaria de la relación laboral. Víctimas de violencia de género.","20 Expulsión del socio en la cooperativa, por acuerdo del Consejo Rector","21 Baja voluntaria del trabajador","22 Finalización o resolución involuntaria del compromiso con las Fuerzas Armadas","23 Fin de actuación sin finalización de contrato, en el caso de artístas","24 Fin de la actividad fija discontinua por la realización de trabajos fijos y periodicos que se repiten en fechas ciertas","25 Finalización del vínculo societario de duración determinada, fijado en el acuerdo de admisión y en los estatutos de la cooperativa","26 Excedencia","27 Cese involuntario y con carácter definitivo en cargo público o sindical ","28 Pérdida con carácter involuntario y definitivo de la dedicación exclusiva o parcial por parte de un cargo público o sindical","29 Conclusión del servicio o del tiempo máximo como reservista voluntario activado en las Fuerzas Armadas","30 Despido por causas objetivas. Ineptitud, falta de adaptación y asistencia al trabajo.","31 Resolución del trabajador por modificación sustancial de las condiciones de trabajo. ","32 Extinción voluntaria de la relación laboral. Víctimas de violencia de género.","33 Resolución del trabajador por causa justa.","41 Fallecimiento del trabajador","42 Pase a la situación de pensionista (jubilación del trabajador)","43 Baja por excedencia voluntaria/forzosa","44 Baja por excedencia maternal/cuidado de hijos","45 Baja por cuidado de familiares","46 Baja por agotamiento de I.T."],"type":"string"},"dropCauseId":{"type":"integer","format":"int32"},"extraPayCalculationDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"seniorityCalculationDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"seniorityCompanyDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"labourPeriodStartDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"labourPeriodEndDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"contributionTypeID":{"type":"integer","format":"int32"},"contributionType":{"type":"string"}}},"HiringDatesEntityPutResource":{"type":"object","properties":{"enrolmentDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"dropDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"dropCauseId":{"type":"integer","format":"int32"},"extraPayCalculationDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"seniorityCalculationDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"seniorityCompanyDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"labourPeriodStartDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"labourPeriodEndDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"contributionTypeID":{"type":"integer","format":"int32"}}},"PregnancyRisksCollectionResource":{"type":"object","properties":{"temporaryDisabilityId":{"type":"string","description":"Identifier of the temporary disability episode this pregnancy risk belongs to.","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"startDate":{"type":"string","description":"Start date of the pregnancy risk period.","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","description":"End date of the pregnancy risk period. Not emitted when it has the default {System.DateTime} value.","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"lastUpdate":{"type":"string","description":"Last update timestamp for this pregnancy risk record. Not emitted when it has the default {System.DateTime} value.","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}},"description":"Data contract representing a pregnancy risk record within a temporary disability collection."},"ClassificationEntityResource":{"type":"object","properties":{"classificationID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"classificationCode":{"type":"string"},"classificationDescription":{"type":"string"}}},"VariableConceptsResource":{"type":"object","properties":{"contributionCollectionTypeID":{"enum":["Immediate","Repeated","Once"],"type":"string"},"conceptCode":{"type":"string"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"collectionDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"payTypeId":{"type":"integer","format":"int32"},"amount":{"type":"number","format":"double"},"units":{"type":"number","format":"double"},"prorateInPaySections":{"type":"boolean"},"attribution":{"type":"string"},"enrolmentDropProrate":{"type":"boolean"},"variableConceptID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}},"NewVariableConceptsResource":{"type":"object","properties":{"contributionCollectionTypeID":{"enum":["Immediate","Repeated","Once"],"type":"string"},"conceptCode":{"type":"string"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"collectionDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"payTypeId":{"type":"integer","format":"int32"},"amount":{"type":"number","format":"double"},"units":{"type":"number","format":"double"},"prorateInPaySections":{"type":"boolean"},"attribution":{"type":"string"},"enrolmentDropProrate":{"type":"boolean"}},"example":{"contributionCollectionTypeID":"Immediate","conceptCode":"1","startDate":"2019-04-01T10:30:00.0000000+00:00","payTypeId":1,"amount":5,"units":1,"prorateInPaySections":false,"attribution":"030101","enrolmentDropProrate":false}},"TDDetail":{"type":"object","properties":{"temporaryDisabilityID":{"type":"string","description":"Unique identifier of the temporary disability.","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"employeeID":{"type":"string","description":"Unique identifier of the employee associated with the TD.","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"employeeCode":{"type":"string","description":"Employee code."},"incidentType":{"enum":["Illness","Accident","Maternity","PartialMaternity","PregnancyRisk","RelapseIllness","RelapseAccident","Paternity","PartialPaternity"],"type":"string","description":"Type of incident causing the temporary disability."},"startDate":{"type":"string","description":"Start date of the temporary disability.","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","description":"End date of the temporary disability.","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"lastUpdate":{"type":"string","description":"Last update date of the TD record.","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indHospitalization":{"type":"boolean","description":"Indicates if there was hospitalization associated with the TD."},"forcedDescription":{"type":"string","description":"Optional forced description of the TD."},"fiscal":{"$ref":"#/components/schemas/TDDetailFiscal"},"relapse":{"$ref":"#/components/schemas/TDDetailRelapse"},"maternity":{"$ref":"#/components/schemas/TDDetailMaternity"},"illness":{"$ref":"#/components/schemas/TDDetaiIllness"},"confirmationReports":{"type":"array","items":{"$ref":"#/components/schemas/TDConfirmationReport"},"description":"List of confirmation reports associated with the TD."},"accidentReport":{"$ref":"#/components/schemas/TDAccidentReport"},"hospitalizationReports":{"type":"array","items":{"$ref":"#/components/schemas/TDHospitalizationReport"},"description":"List of hospitalization reports associated with the TD."},"accidentNotLeaveReport":{"$ref":"#/components/schemas/TDAccidentNotLeaveReport"},"leaveReport":{"$ref":"#/components/schemas/TDLeaveReport"}},"description":"Represents the details of a Temporary Disability (TD) record for an employee."},"TDDetailFiscal":{"type":"object","properties":{"benefitType":{"enum":["DelegatedPay","NoRightToBenefit","DirectPayment"],"type":"string","description":"Type of benefit applied."},"contingencyType":{"enum":["CommonIllness","NonWorkAccident","WorkAccident","ProfesionalIllness","ObservarionPeriod"],"type":"string","description":"Contingency type of the TD."},"indComplement":{"type":"boolean","description":"Indicates whether a complement applies."}},"description":"Fiscal details for a temporary disability."},"TDDetailRelapse":{"type":"object","properties":{"relapsedIncidentID":{"type":"string","description":"Identifier of the relapsed incident.","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"parentIncidentID":{"type":"string","description":"Identifier of the parent incident related to the relapse.","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}},"description":"Relapse information for a temporary disability."},"TDDetailMaternity":{"type":"object","properties":{"percentagePartialMaternity":{"type":"number","description":"Percentage of partial maternity.","format":"double"}},"description":"Maternity specific details for a temporary disability."},"TDDetaiIllness":{"type":"object","properties":{"indCovid19":{"type":"boolean","description":"Indicates if the illness is related to COVID-19."},"indAutManEndDate":{"type":"boolean","description":"Indicates if end date is handled automatically or manually."}},"description":"Illness specific details for a temporary disability."},"TDConfirmationReport":{"type":"object","properties":{"confirmationReportID":{"type":"string","description":"Unique identifier of the confirmation report.","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"reportDate":{"type":"string","description":"Date of the report.","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"reportNumber":{"type":"integer","description":"Confirmation report sequence number.","format":"int32"},"collegiateNumber":{"type":"string","description":"Medical collegiate number."},"cias":{"type":"string","description":"CIAS reference."},"insuranceCompany":{"type":"string","description":"Insurance company name."},"insuranceChangeDate":{"type":"string","description":"Date when insurance changed.","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"sendingStateID":{"type":"integer","description":"Sending state identifier.","format":"int32"},"tdProcessType":{"type":"string","description":"Process type name mapped from {WKE.HCM.Payroll.Api.Models.Entities.TD.TDConfirmationReport.TDProcessTypeID}."},"indLastConfirmationReportTransfer":{"type":"boolean","description":"Indicates if this is the last confirmation report transfer."},"tdEntityIssueTypeID":{"type":"integer","description":"Entity issue type ID.","format":"int32"},"tdEmployeeSituationTypeID":{"type":"integer","description":"Employee situation type ID.","format":"int32"},"healthcareCardNumber":{"type":"string","description":"Healthcare card number."},"tdEmployeeSituationType":{"type":"string","description":"Employee situation type name mapped from {WKE.HCM.Payroll.Api.Models.Entities.TD.TDConfirmationReport.TDEmployeeSituationTypeID}."},"tdProcessTypeID":{"type":"integer","description":"Process type ID.","format":"int32"},"nextMedicalRevisionDate":{"type":"string","description":"Next medical revision date.","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"tdEntityIssueType":{"type":"string","description":"Issuing entity type name mapped from {WKE.HCM.Payroll.Api.Models.Entities.TD.TDConfirmationReport.TDEntityIssueTypeID}."},"complimentDate365Days":{"type":"string","description":"Compliment date reaching 365 days.","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"sendingStat":{"type":"string","description":"Sending state name mapped from {WKE.HCM.Payroll.Api.Models.Entities.TD.TDConfirmationReport.SendingStateID}."}},"description":"Medical confirmation report details associated with TD."},"TDAccidentReport":{"type":"object","properties":{"accidentSiteID":{"type":"integer","description":"Site identifier where the accident occurred.","format":"int32"},"indTrafficAccident":{"type":"boolean","description":"Indicates if it was a traffic accident."},"countrySiteID":{"type":"integer","description":"Country identifier of the accident site.","format":"int32"},"regionSiteID":{"type":"string","description":"Region identifier of the accident site.","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"municipalitySiteID":{"type":"integer","description":"Municipality identifier of the accident site.","format":"int32"},"streetNameSite":{"type":"string","description":"Street name of the accident site."},"publicViaSite":{"type":"string","description":"Public via of the accident site."},"otherSite":{"type":"string","description":"Other details of the accident site."},"indSameWorkPlace":{"type":"boolean","description":"Indicates if the accident occurred in the same workplace."},"indSameWorkPlaceDades":{"type":"boolean","description":"Indicates if the accident occurred in the same workplace (Dades)."},"relationWorkPlaceID":{"type":"integer","description":"Relationship with the workplace identifier.","format":"int32"},"identificationNumberWorkPlace":{"type":"string","description":"Workplace identification number."},"taxIdentificationWorkPlace":{"type":"string","description":"Workplace tax identification."},"workPlaceName":{"type":"string","description":"Workplace name."},"streetNameWorkPlace":{"type":"string","description":"Workplace street name."},"regionWorkPlaceID":{"type":"string","description":"Workplace region identifier.","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"municipalityWorkPlaceID":{"type":"integer","description":"Workplace municipality identifier.","format":"int32"},"postalCodeWorkPlaceID":{"type":"integer","description":"Workplace postal code identifier.","format":"int32"},"telefonWorkPlace":{"type":"string","description":"Workplace phone number."},"insoleWorkPlace":{"type":"integer","description":"Insole of the workplace.","format":"int32"},"economicActivityWorkPlaceDescription":{"type":"string","description":"Description of economic activity of the workplace."},"economicActivityWorkPlaceID":{"type":"integer","description":"Identifier of economic activity of the workplace.","format":"int32"},"accidentDate":{"type":"string","description":"Date of the accident.","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"leaveDate":{"type":"string","description":"Leave date due to the accident.","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"weekDay":{"type":"string","description":"Weekday of the accident."},"hourDayID":{"type":"integer","description":"Identifier of the hour of day when the accident occurred.","format":"int32"},"hourWorkID":{"type":"integer","description":"Identifier of the hour of work when the accident occurred.","format":"int32"},"indUsualWork":{"type":"boolean","description":"Indicates if it was usual work."},"indEvaluationRisk":{"type":"boolean","description":"Indicates if there was a risk evaluation."},"accidentDescription":{"type":"string","description":"Description of the accident."},"siteTypePersonDescription":{"type":"string","description":"Description of the site type person."},"siteTypeID":{"type":"integer","description":"Site type identifier.","format":"int32"},"jobTypeDescription":{"type":"string","description":"Job type description."},"jobTypeID":{"type":"integer","description":"Job type identifier.","format":"int32"},"materialAgentFormID":{"type":"integer","description":"Material agent form identifier.","format":"int32"},"materialAgentPhysicalActivityID":{"type":"integer","description":"Material agent physical activity identifier.","format":"int32"},"physicalActivityDescription":{"type":"string","description":"Physical activity description."},"physicalActivityID":{"type":"integer","description":"Physical activity identifier.","format":"int32"},"deviationDescription":{"type":"string","description":"Deviation description."},"deviationID":{"type":"integer","description":"Deviation identifier.","format":"int32"},"formDescription":{"type":"string","description":"Form description."},"formID":{"type":"integer","description":"Form identifier.","format":"int32"},"materialAgentDeviationID":{"type":"integer","description":"Material agent deviation identifier.","format":"int32"},"materialAgentFormDescription":{"type":"string","description":"Material agent form description."},"indMoreWorker":{"type":"boolean","description":"Indicates if more than one worker was involved."},"indWitness":{"type":"boolean","description":"Indicates if there were witnesses."},"witnessDades":{"type":"string","description":"Witness details."},"lesionDescriptionID":{"type":"integer","description":"Lesion description identifier.","format":"int32"},"lesionGradeID":{"type":"integer","description":"Lesion grade identifier.","format":"int32"},"injuredBodyPartID":{"type":"integer","description":"Injured body part identifier.","format":"int32"},"nameDoctor":{"type":"string","description":"Doctor name."},"addressDoctor":{"type":"string","description":"Doctor address."},"telefoneDoctor":{"type":"string","description":"Doctor phone."},"hospitalAttendanceID":{"type":"integer","description":"Hospital attendance identifier.","format":"int32"},"indHospitalization":{"type":"boolean","description":"Indicates if there was hospitalization."},"hospitalName":{"type":"string","description":"Hospital name."},"personSignsName":{"type":"string","description":"Name of the person who signs the report."},"personSignsQuality":{"type":"string","description":"Quality of the person who signs the report."},"locationSignsReport":{"type":"string","description":"Location where the report is signed."},"dateSignsReport":{"type":"string","description":"Date when the report is signed.","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"entityAgentID":{"type":"string","description":"Entity agent identifier."},"numberFileEntityAgent":{"type":"string","description":"Number file entity agent."},"labAuthority":{"type":"string","description":"Labor authority."},"sendingStateID":{"type":"integer","description":"Sending state identifier.","format":"int32"},"indPrevServiceCompany":{"type":"boolean","description":"Indicates if there is a prevention service by the company."},"indPrevServiceOwn":{"type":"boolean","description":"Indicates if there is an own prevention service."},"indPrevServiceForeign":{"type":"boolean","description":"Indicates if there is a foreign prevention service."},"indPrevServiceEmployee":{"type":"boolean","description":"Indicates if there is a prevention service for employees."},"indPrevServiceCommunity":{"type":"boolean","description":"Indicates if there is a community prevention service."},"indNoPrevService":{"type":"boolean","description":"Indicates if there is no prevention service."},"ocupationTGSSID":{"type":"string","description":"TGSS occupation ID."},"countrySite":{"type":"string","description":"Country name of the accident site."},"municipalitySite":{"type":"string","description":"Municipality name of the accident site."},"regionWorkPlace":{"type":"string","description":"Region name of the workplace."},"lesionDescription":{"type":"string","description":"Lesion description text."},"lesionGrade":{"type":"string","description":"Lesion grade text."},"accidentSite":{"type":"string","description":"Accident site text."},"deviation":{"type":"string","description":"Deviation text."},"formm":{"type":"string","description":"Form text."},"hospitalAttendance":{"type":"string","description":"Hospital attendance text."},"jobType":{"type":"string","description":"Job type text."},"injuredBodyPart":{"type":"string","description":"Injured body part text."},"materialAgentDeviation":{"type":"string","description":"Material agent deviation text."},"materialAgentForm":{"type":"string","description":"Material agent form text."},"materialAgentPhysicalActivity":{"type":"string","description":"Material agent physical activity text."},"physicalActivity":{"type":"string","description":"Physical activity text."},"siteType":{"type":"string","description":"Site type text."},"relationWorkplace":{"type":"string","description":"Relationship with workplace text."}},"description":"Accident report details associated with TD."},"TDHospitalizationReport":{"type":"object","properties":{"hospitalizationID":{"type":"string","description":"Unique identifier of hospitalization.","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"startDate":{"type":"string","description":"Start date of hospitalization.","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","description":"End date of hospitalization.","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}},"description":"Hospitalization report associated with a TD."},"TDAccidentNotLeaveReport":{"type":"object","properties":{"economicActivityWorkPlaceDescription":{"type":"string","description":"Description of economic activity of the workplace."},"accidentNotLeaveReportDate":{"type":"string","description":"Date of the accident not leave report.","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"accidentDate":{"type":"string","description":"Date of the accident.","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"formID":{"type":"integer","description":"Form identifier.","format":"int32"},"lesionDescriptionID":{"type":"integer","description":"Lesion description identifier.","format":"int32"},"injuredBodyPartID":{"type":"integer","description":"Injured body part identifier.","format":"int32"},"personSignsName":{"type":"string","description":"Name of the person who signs the report."},"personSignsQuality":{"type":"string","description":"Quality of the person who signs the report."},"locationSignsReport":{"type":"string","description":"Location where the report is signed."},"dateSignsReport":{"type":"string","description":"Date when the report is signed.","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"entityAgentID":{"type":"string","description":"Entity agent identifier."},"autonomous":{"type":"boolean","description":"Indicates if autonomous."},"contractType":{"type":"string","description":"Contract type."},"staff":{"type":"integer","description":"Staff count.","format":"int32"},"sendingState":{"type":"integer","description":"Sending state identifier.","format":"int32"},"workPlaceMunicipalityCode":{"type":"string","description":"Workplace municipality code."},"workPlacePostalCode":{"type":"string","description":"Workplace postal code."},"companySS":{"type":"string","description":"Company social security number."}},"description":"Accident not leave report details associated with TD."},"TDLeaveReport":{"type":"object","properties":{"motive":{"type":"string","description":"Medical motive or diagnosis associated with the leave."},"colegiateNumber":{"type":"string","description":"Healthcare professional collegiate number issuing the leave report."},"cias":{"type":"string","description":"CIAS identifier of the issuing healthcare center."},"leaveDate":{"type":"string","description":"Date when the leave begins.","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"daysProbableDuration":{"type":"integer","description":"Probable duration of the leave in days.","format":"int32"},"monthsProbableDuration":{"type":"integer","description":"Probable duration of the leave in months.","format":"int32"},"contributionsBaseCC":{"type":"number","description":"Contribution base for common contingencies.","format":"double"},"contributionsBasePC":{"type":"number","description":"Contribution base for professional contingencies.","format":"double"},"contributionsDays":{"type":"integer","description":"Number of contribution days considered for the calculation.","format":"int32"},"taxableBaseCC":{"type":"number","description":"Taxable base for common contingencies.","format":"double"},"taxableBasePC":{"type":"number","description":"Taxable base for professional contingencies.","format":"double"},"atepDate":{"type":"string","description":"Date of the ATEP (work accident or professional disease) incident, if any.","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"extraHoursContributionsBase":{"type":"number","description":"Contribution base corresponding to extra hours.","format":"double"},"incentiveContributionsBase":{"type":"number","description":"Contribution base corresponding to incentives.","format":"double"},"totalContributionsBase":{"type":"number","description":"Total contribution base used in the calculation.","format":"double"},"dailyAvgContributionsBase":{"type":"number","description":"Average daily contribution base.","format":"double"},"dailyAvgContributionsDays":{"type":"number","description":"Average number of contribution days used for the calculation.","format":"double"},"sendingStateID":{"type":"integer","description":"Identifier of the sending state, when applicable.","format":"int32"},"benefitDays":{"type":"integer","description":"Number of days of benefit entitlement.","format":"int32"},"benefitBase":{"type":"number","description":"Base amount used to calculate the benefit.","format":"double"},"benefitTaxableBase":{"type":"number","description":"Taxable base of the benefit.","format":"double"},"tdEntityIssueTypeID":{"type":"integer","description":"Identifier of the entity issue type for the leave report.","format":"int32"},"tdEmployeeSituationTypeID":{"type":"integer","description":"Identifier of the employee situation type at the time of the leave.","format":"int32"},"healthcareCardNumber":{"type":"string","description":"Healthcare card number of the employee."},"tdProcessTypeID":{"type":"integer","description":"Process type identifier associated with the temporary disability.","format":"int32"},"lastProcessEndDate":{"type":"string","description":"End date of the last process related to the incident, if any.","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"firstProcessEndDate":{"type":"string","description":"End date of the first process related to the incident, if any.","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"tdAccidentTypeID":{"type":"integer","description":"Identifier of the accident type associated with the leave.","format":"int32"},"tdAssistanceTypeID":{"type":"integer","description":"Identifier of the medical assistance type.","format":"int32"},"nextMedicalRevisionDate":{"type":"string","description":"Date of the next programmed medical revision.","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"tdEmployeeSituationType":{"type":"string","description":"TDEmployeeSituationType"},"tdEntityIssueType":{"type":"string","description":"TDEntityIssueType"},"tdAccidentType":{"type":"string","description":"TDAccidentType"},"tdAssistanceType":{"type":"string","description":"medical assistance type."}},"description":"Represents the initial leave report associated with a temporary disability incident.\r\nContains medical, contribution and benefit related data used to calculate and register the leave."},"Municipality":{"type":"object","properties":{"municipalityCode":{"type":"string"},"name":{"type":"string"}}},"RegionCollectionResource":{"type":"object","properties":{"regionCode":{"type":"string"},"name":{"type":"string"}}},"PostalCodeCollectionResource":{"type":"object","properties":{"code":{"type":"string"},"municipality":{"type":"string"}}},"CountriesCollectionResource":{"type":"object","properties":{"isoCountryID":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"IdentificationCollectionResource":{"type":"object","properties":{"companyNumberCode":{"type":"integer","format":"int32"},"employeeCode":{"type":"string"},"workplaceCode":{"type":"string","description":"WorkplaceCode"},"name":{"type":"string","description":"Name"},"secondName1":{"type":"string","description":"SecondName1"},"secondName2":{"type":"string","description":"SecondName2"},"identifierNumber":{"type":"string","description":"IdentifierNumber"},"identifierNumberExpiryDate":{"type":"string","description":"IdentifierNumberExpiryDate","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"identificationTypeID":{"type":"integer","description":"IdentificationTypeID","format":"int32"},"identificationTypeDescription":{"type":"string","description":"IdentificationTypeDescription"},"ssAffiliationNumber":{"type":"string","description":"SSAffiliationNumber"},"birthPlace":{"type":"string","description":"BirthPlace"},"initialDate":{"type":"string","description":"InitialDate","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"gender":{"type":"string","description":"Employee gender belongs to male, female"},"birthCountry":{"type":"string","description":"BirthCountry"},"civilStatus":{"type":"string","description":"Employee civilStatus belongs to"},"fatherName":{"type":"string","description":"FatherName"},"motherName":{"type":"string","description":"MotherName"},"transferToGt":{"type":"boolean","description":"TransferToGt"},"personTypeID":{"type":"string","description":"PersonTypeID"},"personTypeDescription":{"type":"string","description":"PersonTypeDescription"},"sex":{"type":"string","description":"Sex"},"occupationCodeTGSS":{"type":"string","description":"OccupationCodeTGSS"}}},"LocationCollectionResource":{"type":"object","properties":{"companyNumberCode":{"type":"integer","format":"int32"},"employeeCode":{"type":"string"},"completeName":{"type":"string"},"directPhoneNumber":{"type":"string"},"extension":{"type":"string"},"companyMobilePhoneNumber":{"type":"string"},"faxNumber":{"type":"string"},"professionalEmailAddress":{"type":"string"}}},"KeyValuePairStringString":{"type":"object","properties":{"key":{"type":"string","readOnly":true},"value":{"type":"string","readOnly":true}}},"JobTitleDescriptionItem":{"type":"object","properties":{"jobTitleDescriptionId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"jobTitleDescriptionCode":{"type":"string"},"jobTitleDescription":{"type":"string"}}},"JobTitle":{"type":"object","properties":{"jobTitleID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"jobTitleCode":{"type":"string"},"jobTitleDescription":{"type":"string"},"jobTitleFunctionsDescription":{"type":"string"}}},"JobPosition":{"type":"object","properties":{"jobPositionID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"jobPositionCode":{"type":"string"},"jobTitleID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"jobTitleDescription":{"type":"string"},"jobTitleCode":{"type":"string"},"orgUnitID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"orgUnitName":{"type":"string"},"organigramCode":{"type":"string"},"organigramName":{"type":"string"},"jobPositionType":{"enum":["Internal","External"],"type":"string"},"jobPositionCreateDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"jobPositionDropDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"jobPositionDropCause":{"type":"string"},"jobPositionFixedAmount":{"type":"number","format":"float"},"jobPositionFTE":{"type":"number","format":"double"},"jobPositionSuperiorBandAmount":{"type":"number","format":"float"},"jobPositionInferiorBandAmount":{"type":"number","format":"float"},"jobPositionRealFTE":{"type":"number","format":"double"}}},"KeyValuePairInt32String":{"type":"object","properties":{"key":{"type":"integer","format":"int32","readOnly":true},"value":{"type":"string","readOnly":true}}},"Occupation":{"type":"object","properties":{"id":{"type":"string"},"description":{"type":"string"}}},"SpecialContract":{"type":"object","properties":{"id":{"type":"string"},"description":{"type":"string"}}},"CollectiveType":{"type":"object","properties":{"id":{"type":"string"},"description":{"type":"string"}}},"ContractType":{"type":"object","properties":{"contractCode":{"type":"integer","format":"int32"},"description":{"type":"string"}}},"JobPositionDropCause":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"description":{"type":"string"}}},"DismissalTypeResource":{"type":"object","properties":{"dismissalTypeID":{"type":"integer","format":"int32"},"description":{"type":"string"},"dropCode":{"type":"string"},"inemDropCode":{"type":"integer","format":"int32"},"dropTypeDescription":{"type":"string"}}},"PerceptionSubkeyResource":{"type":"object","properties":{"perceptionTypeID":{"type":"integer","description":"PerceptionTypeID","format":"int32"},"perceptionTypeCode":{"type":"string","description":"PerceptionTypeCode"},"perceptionTypeDescription":{"type":"string","description":"PerceptionTypeDescription"},"perceptionSubTypeCode":{"type":"integer","description":"PerceptionSubTypeCode","format":"int32"},"perceptionSubTypeDescription":{"type":"string","description":"PerceptionSubTypeDescription"}},"description":"PerceptionSubkeyResource"},"AddressTypeResource":{"type":"object","properties":{"addressTypeID":{"type":"integer","format":"int32"},"description":{"type":"string"}}},"ContributionTypeResource":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"description":{"type":"string"}}},"IdentificationTypeResource":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"description":{"type":"string"}}},"SexTypeResource":{"type":"object","properties":{"id":{"type":"string"},"description":{"type":"string"}}},"PersonTypeResource":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"description":{"type":"string"}}},"ConceptCollectionType":{"type":"object","properties":{"conceptCollectionTypeID":{"type":"integer","format":"int32"},"description":{"type":"string"}}},"MedicalCheckupStateResource":{"type":"object","properties":{"checkupStateId":{"type":"integer","format":"int32"},"description":{"type":"string"}}},"MedicalCheckupTypeResource":{"type":"object","properties":{"checkupTypeId":{"type":"integer","format":"int32"},"description":{"type":"string"}}},"PayTypeGroup":{"type":"object","properties":{"id":{"type":"string"}}},"MaintenanceGroupModel":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"description":{"type":"string"}}},"TemplateModel":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"TemplateFieldDefinitionModel":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"elType":{"type":"integer","format":"int32"},"defValue":{"type":"string"},"listID":{"type":"string"},"linkedElement":{"type":"string"},"posX":{"type":"integer","format":"int32"},"posY":{"type":"integer","format":"int32"},"sizeX":{"type":"integer","format":"int32"},"sizeY":{"type":"integer","format":"int32"},"style":{"type":"string"},"url":{"type":"string"},"dateFormat":{"type":"string"}}},"TemplateListValues":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}}},"ElementValue":{"type":"object","properties":{"text":{"type":"string"}}},"VacationRequestModel":{"type":"object","properties":{"companyCode":{"type":"integer","format":"int32"},"workplaceCode":{"type":"integer","format":"int32"},"employeeCode":{"type":"string"},"startDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"indCanceled":{"type":"boolean"},"year":{"type":"integer","format":"int32"},"state":{"type":"string"},"state_Date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"description":{"type":"string"},"observations":{"type":"string"}}},"PortalUser":{"type":"object","properties":{"portalCode":{"type":"integer","format":"int32"},"portalName":{"type":"string"},"companyCode":{"type":"integer","format":"int32"},"employeeCode":{"type":"integer","format":"int32"},"username":{"type":"string"},"userID":{"type":"string"},"blocked":{"type":"boolean"},"profileType":{"type":"string"},"profileName":{"type":"string"},"lastBlocked":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"lastLogin":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"}}},"Portal":{"type":"object","properties":{"portalCode":{"type":"integer","format":"int32"},"portalName":{"type":"string"},"companyCode":{"type":"integer","format":"int32"},"companyName":{"type":"string"},"mfaEnabled":{"type":"boolean"}}},"TrainingGroupDigestResource":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"},"year":{"type":"integer","format":"int32"},"state":{"type":"integer","format":"int32"},"cif":{"type":"string"}}},"TrainingCenterDigestResource":{"type":"object","properties":{"code":{"type":"string"},"cif":{"type":"string"},"name":{"type":"string"},"municipallity":{"type":"string"},"country":{"type":"string"}}},"TrainingGroupResource":{"type":"object","properties":{"trainingGroupId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"code":{"type":"string"},"name":{"type":"string"},"year":{"type":"integer","format":"int32"},"state":{"type":"integer","format":"int32"},"comments":{"type":"string"},"adress":{"type":"string"},"postalCode":{"type":"string"},"municipality":{"type":"string"},"initDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"responsible":{"type":"string"},"morningFrom":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"morningTo":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"afternoonFrom":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"afternoonTo":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"monday":{"type":"boolean"},"tuesday":{"type":"boolean"},"wednesday":{"type":"boolean"},"thursday":{"type":"boolean"},"friday":{"type":"boolean"},"saturday":{"type":"boolean"},"sunday":{"type":"boolean"},"laborHours":{"type":"number","format":"double"},"timeTableComments":{"type":"string"},"directCosts":{"type":"number","format":"double"},"asociatedCosts":{"type":"number","format":"double"},"personalCosts":{"type":"number","format":"double"},"personalCosts_Autom":{"type":"boolean"},"portalPublished":{"type":"boolean"},"portalPublishedOption":{"type":"boolean"},"trainingPlace":{"type":"string"},"notifiedFor":{"type":"boolean"},"means_Company":{"type":"boolean"},"means_OrgEntity":{"type":"boolean"},"means_External":{"type":"boolean"},"alternativeAddress":{"type":"boolean"},"nifTutor":{"type":"string"},"tutorGivenName":{"type":"string"},"tutorFirstName1":{"type":"string"},"tutorFirstName2":{"type":"string"},"tutorHours":{"type":"number","format":"double"},"cif":{"type":"string"},"ciF_grouped":{"type":"string"},"country":{"type":"string"},"organizationCosts":{"type":"number","format":"double"},"contactPhoneNumber":{"type":"string"},"aulaVirtual_Means":{"type":"string"},"aulaVirtual_Connnection":{"type":"string"},"aulaVirtual_Contact":{"type":"string"},"aulaVirtual_Phone":{"type":"string"}}},"TrainingGroupParticitpantDigestResource":{"type":"object","properties":{"companyCode":{"type":"string"},"workplaceCode":{"type":"string"},"employeeCode":{"type":"string"},"reserve":{"type":"boolean"},"test_Done":{"type":"boolean"},"certificate_Done":{"type":"boolean"},"retires":{"type":"boolean"},"priorityEmployee":{"type":"boolean"},"discapacity":{"type":"boolean"},"functionalAreaId":{"type":"integer","format":"int32"},"profCategoryId":{"type":"integer","format":"int32"},"studiesLevelId":{"type":"integer","format":"int32"},"otherTitles":{"type":"string"},"other_Done":{"type":"boolean"}}},"TrainingGroupParticitpantResource":{"type":"object","properties":{"companyCode":{"type":"string"},"workplaceCode":{"type":"string"},"employeeCode":{"type":"string"},"reserve":{"type":"boolean"},"comments":{"type":"string"},"called_Done":{"type":"boolean"},"called_Date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"called_NotificationType":{"type":"integer","format":"int32"},"called_Comments":{"type":"string"},"test_Done":{"type":"boolean"},"test_Date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"test_Comments":{"type":"string"},"certificate_Done":{"type":"boolean"},"certificate_Date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"certificate_Comments":{"type":"string"},"personalCosts_HourCost":{"type":"number","format":"double"},"personalCosts_LabourHours":{"type":"number","format":"double"},"personalCosts_Cost":{"type":"number","format":"double"},"personalCosts_ManualAutomatic":{"type":"boolean"},"retires":{"type":"boolean"},"priorityEmployee":{"type":"boolean"},"discapacity":{"type":"boolean"},"functionalAreaId":{"type":"integer","format":"int32"},"profCategoryId":{"type":"integer","format":"int32"},"studiesLevelId":{"type":"integer","format":"int32"},"otherTitles":{"type":"string"},"other_Done":{"type":"boolean"},"hasAccreditingDiploma":{"type":"boolean"}}},"TrainingActionDigestResource":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"},"area":{"type":"integer","format":"int32"}}},"TrainingActionResource":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"},"area":{"type":"integer","format":"int32"},"adressedTo":{"type":"string"},"objectives":{"type":"string"},"contents":{"type":"string"},"modality":{"type":"integer","format":"int32"},"hours1":{"type":"number","format":"double"},"hours2":{"type":"number","format":"double"},"hours3":{"type":"number","format":"double"},"hours4":{"type":"number","format":"double"},"hours_Total":{"type":"number","format":"double"},"type":{"type":"boolean"},"level":{"type":"boolean"},"indAlfInf":{"type":"boolean"},"hoursAlfInf":{"type":"number","format":"double"},"indITTec":{"type":"boolean"},"hoursITTec":{"type":"number","format":"double"},"indPrevRisLab":{"type":"boolean"},"hoursPrevRisLab":{"type":"number","format":"double"},"indSenMedAmb":{"type":"boolean"},"hoursSenMedAmb":{"type":"number","format":"double"},"actionGroup":{"type":"string"},"url":{"type":"string"},"user":{"type":"string"},"userPass":{"type":"string"},"observations":{"type":"string"},"professionalArea":{"type":"integer","format":"int32"},"platformCif":{"type":"string"},"platformBusinessName":{"type":"string"}}},"TrainingCenterResource":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"},"adress":{"type":"string"},"postalCode":{"type":"string"},"municipallity":{"type":"string"},"telephone":{"type":"string"},"contact":{"type":"string"},"comments":{"type":"string"},"cif":{"type":"string"},"country":{"type":"string"}}},"TrainingGroupForYear":{"type":"object","properties":{"trainingGroupId":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"code":{"type":"string"},"name":{"type":"string"},"year":{"type":"integer","format":"int32"},"comments":{"type":"string"},"initDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"endDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"responsible":{"type":"string"},"laborHours":{"type":"number","format":"double"},"directCosts":{"type":"number","format":"double"},"asociatedCosts":{"type":"number","format":"double"},"personalCosts":{"type":"number","format":"double"},"personalCosts_Autom":{"type":"boolean"},"portalPublished":{"type":"boolean"},"actionCode":{"type":"string"},"actionName":{"type":"string"},"groupCompaniesNames":{"type":"string"},"areaDescription":{"type":"string"},"subAreaDescription":{"type":"string"},"groupParticipantsCount":{"type":"integer","format":"int32"},"actionTotalHours":{"type":"number","format":"double"},"actionModality":{"type":"integer","format":"int32"},"actionType":{"type":"boolean"},"actionLevel":{"type":"boolean"},"centerName":{"type":"string"},"totalParticipantsEvaluated":{"type":"integer","format":"int32"},"averagePresence":{"type":"number","format":"double"},"costPersonal":{"type":"number","format":"double"},"costDirect":{"type":"number","format":"double"},"costAssociate":{"type":"number","format":"double"},"costTotal":{"type":"number","format":"double"},"trainingPlace":{"type":"string"},"notifiedFor":{"type":"boolean"},"means_Company":{"type":"boolean"},"means_OrgEntity":{"type":"boolean"},"means_External":{"type":"boolean"},"stateDescription":{"type":"string"},"centerCode":{"type":"string"},"modalityDescription":{"type":"string"},"actionTypeDescription":{"type":"string"},"actionLevelDescription":{"type":"string"}}},"TrainingGroupParticipantById":{"type":"object","properties":{"trainingGroupID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"employeeID":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"},"reserve":{"type":"boolean"},"comments":{"type":"string"},"called_Done":{"type":"integer","format":"int32"},"called_Date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"called_Comments":{"type":"string"},"test_Done":{"type":"boolean"},"test_Date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"test_Comments":{"type":"string"},"certificate_Done":{"type":"integer","format":"int32"},"certificate_Date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"certificate_Comments":{"type":"string"},"invitationMeans":{"type":"string"},"company":{"type":"string"},"name":{"type":"string"},"organizationUnit":{"type":"string"},"workplace":{"type":"string"},"affiliationNumber":{"type":"string"},"dateOfBirth":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"identifierNumber":{"type":"string"},"totalPresent":{"type":"integer","format":"int32"},"totalAbsent":{"type":"integer","format":"int32"},"presence":{"type":"number","format":"double"},"addressEmail":{"type":"string"},"firstName":{"type":"string"},"secondName1":{"type":"string"},"secondName2":{"type":"string"},"personalCosts_ManualAutomatic":{"type":"boolean"},"personalCosts_Cost":{"type":"number","format":"double"},"personalCosts_LabourHours":{"type":"number","format":"double"},"personalCosts_HourCost":{"type":"number","format":"double"},"employeeCode":{"type":"string"},"sex":{"type":"string"},"sexCode":{"type":"string"},"retires":{"type":"boolean"},"priorityEmployee":{"type":"boolean"},"discapacity":{"type":"boolean"},"functionalAreaId":{"type":"integer","format":"int32"},"profCategoryId":{"type":"integer","format":"int32"},"studiesLevelId":{"type":"integer","format":"int32"},"otherTitles":{"type":"string"},"functionalAreaDescription":{"type":"string"},"profCategoryDescription":{"type":"string"},"studiesLevelDescription":{"type":"string"},"companyCIF":{"type":"string"},"ssPaymentNumber":{"type":"string"},"tariffGroupID":{"type":"integer","format":"int32"},"disabilityLevel":{"type":"number","format":"double"},"tariffGroupDescription":{"type":"string"},"cancelation":{"type":"integer","format":"int32"},"modification":{"type":"integer","format":"int32"},"other_Notices":{"type":"integer","format":"int32"},"cancelation_Date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"modification_Date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"other_Notices_Date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"cancelation_Media":{"type":"string"},"modification_Media":{"type":"string"},"other_Notices_Media":{"type":"string"},"cancelation_Comments":{"type":"string"},"modification_Comments":{"type":"string"},"other_Notices_Comments":{"type":"string"},"achievement_Certificate":{"type":"integer","format":"int32"},"achievement_Certificate_Date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"other_Certificate_Date":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00.0000000+00:00"},"att_Certificate_Media":{"type":"string"},"achievement_Certificate_Media":{"type":"string"},"other_Certificate_Media":{"type":"string"},"achievement_Certificate_Comments":{"type":"string"},"other_Certificate_Comments":{"type":"string"},"personalEmail":{"type":"string"},"userId":{"type":"string"},"other_Done":{"type":"integer","format":"int32"},"niss":{"type":"string"},"age":{"type":"integer","format":"int32"},"classificationDescription":{"type":"string"},"contributionTypeDescription":{"type":"string"},"regimeDescription":{"type":"string"},"terrorismVictim":{"type":"integer","format":"int32"},"genderViolenceVictim":{"type":"integer","format":"int32"},"phoneNumber":{"type":"string"},"hasAccreditingDiploma":{"type":"boolean"},"hasERTESituation":{"type":"boolean"},"fijoDiscontinuo":{"type":"boolean"}}}},"parameters":{"api-version":{"name":"api-version","in":"header","description":"Api version","schema":{"type":"string"}},"companyCode":{"name":"companyCode","in":"path","description":"a3innuva Company Code","required":true,"schema":{"maximum":99999,"minimum":1,"type":"integer","format":"int32"}},"employeeCode":{"name":"employeeCode","in":"path","description":"a3Innuva Employee Code","required":true,"schema":{"maxLength":6,"minLength":6,"pattern":"^\\w{6}$","type":"string"}},"pageNumber":{"name":"pageNumber","in":"query","description":"Specify the page to retrieve. Index starts at 1.","required":true,"schema":{"maximum":99999,"minimum":1,"type":"integer","format":"int32"}},"pageSize":{"name":"pageSize","in":"query","description":"Number of results to be returned by page. 50 is the maximum","required":true,"schema":{"maximum":50,"minimum":1,"type":"integer","format":"int32"}},"orderBy":{"name":"orderBy","in":"query","description":"The orderBy query parameter allows to request resources in a particular order.","schema":{"type":"string"}},"filter":{"name":"filter","in":"query","description":"The filter query parameter allows to filter a collection of resources that are addressed by a request URL","schema":{"type":"string"}}},"securitySchemes":{"apiKeyHeader":{"type":"apiKey","description":"a3developer portal subscription key","name":"Ocp-Apim-Subscription-Key","in":"header"},"Authorization":{"type":"http","description":"WKA OAuth authorization token","scheme":"bearer"}}},"security":[{"apiKeyHeader":[]},{"Authorization":[]}]},"markdown":"","status":"publicado","published_at":"2023-06-22T23:43:03.000Z","created_at":"2023-06-22T23:38:49.000Z","updated_at":"2026-02-25T12:56:02.000Z","buttons":[{"id":10,"name":"Consulta la definición de la API","type":"primary","order":1,"link":"https://wke-portal-pre.apimarket.io/apis/a3laboral-services/swagger-ui","class":"secondary"}],"benefits":[],"tags":[],"image":[{"id":3,"name":"wk-api-a3innuva-nomina.png","alternativeText":"","caption":"","width":593,"height":432,"formats":{"thumbnail":{"name":"thumbnail_wk-api-a3innuva-nomina.png","hash":"thumbnail_wk_api_a3innuva_nomina_5540734e36","ext":".png","mime":"image/png","width":214,"height":156,"size":31.96,"path":null,"url":"https://wke-portal.apimarket.io/assets/thumbnail_wk_api_a3innuva_nomina_5540734e36.png"},"small":{"name":"small_wk-api-a3innuva-nomina.png","hash":"small_wk_api_a3innuva_nomina_5540734e36","ext":".png","mime":"image/png","width":500,"height":364,"size":137.01,"path":null,"url":"https://wke-portal.apimarket.io/assets/small_wk_api_a3innuva_nomina_5540734e36.png"}},"hash":"wk_api_a3innuva_nomina_5540734e36","ext":".png","mime":"image/png","size":157.16,"url":"https://wke-portal.apimarket.io/assets/wk_api_a3innuva_nomina_5540734e36.png","previewUrl":null,"provider":"aws-s3-use-cdn","provider_metadata":null,"created_at":"2023-06-23T03:28:40.000Z","updated_at":"2023-06-23T03:28:43.000Z"}],"products":[]},{"id":7,"title":"API a3innuva ERP - Stock avanzado","slug":"a3factura-stock","description":null,"color_status":null,"footerText":null,"version":null,"openDoc":{"openapi":"3.0.4","info":{"title":"API a3innuva ERP - Stock avanzado","description":"API a3innuva ERP - Stock avanzado","termsOfService":"https://a3developers.wolterskluwer.es/user/terms","contact":{"name":"Wolters Kluwer TAA a3developers","url":"https://a3developers.wolterskluwer.es","email":"a3developers@wolterskluwer.com"},"license":{"name":"Terms of Use","url":"https://a3developers.wolterskluwer.es/user/terms"},"version":"v1"},"servers":[{"url":"https://a3api.wolterskluwer.es/a3factura-stock","description":"PRO"}],"paths":{"/api/dimensions/{dimensionId}/attributes":{"get":{"tags":["DimensionAttributes"],"summary":"Retrieves a paginated list of Dimension Attributes based on provided filters.","description":"Retrieves a paginated list of Dimension Attributes based on provided filters.","operationId":"GetAllDimensionAttributes","parameters":[{"name":"dimensionId","in":"path","description":"The unique identifier of the dimension.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"pageNumber","in":"query","description":"Page number for pagination (default is 1).","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Number of records per page (default is 100, max is 300).","schema":{"maximum":300,"minimum":1,"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetDimensionAttributeResultPaginatedResponse"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetDimensionAttributeResultPaginatedResponse"},"example":{"values":[{"correlationId":"string","name":"string","sortIndex":0,"equivalenceValues":[{"correlationId":"string","equivalenceCorrelationId":"string","value":"string"}]}],"pageNumber":0,"pageSize":0,"totalCount":0,"totalPages":0}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"User not authorized to perform this action."},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"post":{"tags":["DimensionAttributes"],"summary":"Creates a new dimension attribute.","description":"Creates a new dimension attribute.","operationId":"CreateDimensionAttribute","parameters":[{"name":"dimensionId","in":"path","description":"The unique identifier of the dimension.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"The dimension attribute details to create.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CreateDimensionAttributeRequest"},"example":{"name":"string","sortIndex":0,"equivalenceValues":[{"equivalenceCorrelationId":"string","value":"string"}]}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateDimensionAttributeRequest"},"example":{"name":"string","sortIndex":0,"equivalenceValues":[{"equivalenceCorrelationId":"string","value":"string"}]}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateDimensionAttributeRequest"},"example":{"name":"string","sortIndex":0,"equivalenceValues":[{"equivalenceCorrelationId":"string","value":"string"}]}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreateDimensionAttributeRequest"},"example":{"name":"string","sortIndex":0,"equivalenceValues":[{"equivalenceCorrelationId":"string","value":"string"}]}}}},"responses":{"201":{"description":"Created","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetDimensionAttributeResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetDimensionAttributeResult"},"example":{"correlationId":"string","name":"string","sortIndex":0,"equivalenceValues":[{"correlationId":"string","equivalenceCorrelationId":"string","value":"string"}]}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"User not authorized to perform this action."},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"409":{"description":"Conflict","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/api/dimensions/{dimensionId}/attributes/{attributeId}":{"get":{"tags":["DimensionAttributes"],"summary":"Retrieves dimension attribute details of dimensionAttributeId.","description":"Retrieves dimension attribute details of dimensionAttributeId.","operationId":"GetDimensionAttributeById","parameters":[{"name":"dimensionId","in":"path","description":"The unique identifier of the dimension.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"attributeId","in":"path","description":"The unique identifier of the dimension attribute.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetDimensionAttributeResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetDimensionAttributeResult"},"example":{"correlationId":"string","name":"string","sortIndex":0,"equivalenceValues":[{"correlationId":"string","equivalenceCorrelationId":"string","value":"string"}]}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"User not authorized to perform this action."},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"put":{"tags":["DimensionAttributes"],"summary":"Updates an existing dimension attribute.","description":"Updates an existing dimension attribute.","operationId":"UpdateDimensionAttribute","parameters":[{"name":"dimensionId","in":"path","description":"The unique identifier of the dimension.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"attributeId","in":"path","description":"The unique identifier of the dimension attribute to update.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"The updated dimension attribute details.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateDimensionAttributeRequest"},"example":{"name":"string","sortIndex":0,"equivalenceValues":[{"correlationId":"string","equivalenceCorrelationId":"string","value":"string"}]}},"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDimensionAttributeRequest"},"example":{"name":"string","sortIndex":0,"equivalenceValues":[{"correlationId":"string","equivalenceCorrelationId":"string","value":"string"}]}},"text/json":{"schema":{"$ref":"#/components/schemas/UpdateDimensionAttributeRequest"},"example":{"name":"string","sortIndex":0,"equivalenceValues":[{"correlationId":"string","equivalenceCorrelationId":"string","value":"string"}]}},"application/*+json":{"schema":{"$ref":"#/components/schemas/UpdateDimensionAttributeRequest"},"example":{"name":"string","sortIndex":0,"equivalenceValues":[{"correlationId":"string","equivalenceCorrelationId":"string","value":"string"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"User not authorized to perform this action."},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"delete":{"tags":["DimensionAttributes"],"summary":"Deletes an existing dimension attribute.","description":"Deletes an existing dimension attribute.","operationId":"DeleteDimensionAttribute","parameters":[{"name":"dimensionId","in":"path","description":"The unique identifier of the dimension.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"attributeId","in":"path","description":"The unique identifier of the dimension attribute to delete.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"User not authorized to perform this action."},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/api/dimensions/{dimensionId}/equivalences":{"get":{"tags":["DimensionEquivalences"],"summary":"Retrieves a paginated list of Dimension Equivalences based on provided filters.","description":"Retrieves a paginated list of Dimension Equivalences based on provided filters.","operationId":"GetAllDimensionEquivalences","parameters":[{"name":"dimensionId","in":"path","description":"The unique identifier of the dimension.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetDimensionEquivalencesResult"}},"examples":{"default":{"value":""}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetDimensionEquivalencesResult"}},"example":[{"correlationId":"string","name":"string"}]}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"User not authorized to perform this action."},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"post":{"tags":["DimensionEquivalences"],"summary":"Creates a new dimension equivalence.","description":"Creates a new dimension equivalence.","operationId":"CreateDimensionEquivalence","parameters":[{"name":"dimensionId","in":"path","description":"The unique identifier of the dimension.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"The dimension equivalence details to create.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CreateDimensionEquivalenceRequest"},"example":{"name":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateDimensionEquivalenceRequest"},"example":{"name":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateDimensionEquivalenceRequest"},"example":{"name":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreateDimensionEquivalenceRequest"},"example":{"name":"string"}}}},"responses":{"201":{"description":"Created","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetDimensionEquivalenceResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetDimensionEquivalenceResult"},"example":{"correlationId":"string","name":"string"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"User not authorized to perform this action."},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"409":{"description":"Conflict","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/api/dimensions/{dimensionId}/equivalences/{equivalenceId}":{"get":{"tags":["DimensionEquivalences"],"summary":"Retrieves dimension Equivalence details of dimensionEquivalenceId.","description":"Retrieves dimension Equivalence details of dimensionEquivalenceId.","operationId":"GetDimensionEquivalenceById","parameters":[{"name":"dimensionId","in":"path","description":"The unique identifier of the dimension.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"equivalenceId","in":"path","description":"The unique identifier of the dimension equivalence.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetDimensionEquivalenceResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetDimensionEquivalenceResult"},"example":{"correlationId":"string","name":"string"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"User not authorized to perform this action."},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"put":{"tags":["DimensionEquivalences"],"summary":"Updates an existing dimension equivalence.","description":"Updates an existing dimension equivalence.","operationId":"UpdateDimensionEquivalence","parameters":[{"name":"dimensionId","in":"path","description":"The unique identifier of the dimension.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"equivalenceId","in":"path","description":"The unique identifier of the dimension equivalence to update.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"The updated dimension equivalence details.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateDimensionEquivalenceRequest"},"example":{"name":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDimensionEquivalenceRequest"},"example":{"name":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/UpdateDimensionEquivalenceRequest"},"example":{"name":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/UpdateDimensionEquivalenceRequest"},"example":{"name":"string"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"User not authorized to perform this action."},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"delete":{"tags":["DimensionEquivalences"],"summary":"Deletes an existing dimension equivalence.","description":"Deletes an existing dimension equivalence.","operationId":"DeleteDimensionEquivalence","parameters":[{"name":"dimensionId","in":"path","description":"The unique identifier of the dimension.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"equivalenceId","in":"path","description":"The unique identifier of the dimension equivalence to update.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"User not authorized to perform this action."},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/api/dimensions/{dimensionId}":{"get":{"tags":["Dimensions"],"summary":"Retrieves dimension details of dimensionId.","description":"Retrieves dimension details of dimensionId.","operationId":"GetDimensionById","parameters":[{"name":"dimensionId","in":"path","description":"The unique identifier of the dimension.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"returnEquivalences","in":"query","description":"Indicates if return equivalences or not. Default false.","schema":{"type":"boolean","default":false}},{"name":"returnAttributes","in":"query","description":"Indicates if return attributes or not. Default false.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetDimensionResponse"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetDimensionResponse"},"example":{"correlationId":"string","code":"string","description":"string","shortDescription":"string","equivalences":[{"correlationId":"string","name":"string"}],"attributes":[{"correlationId":"string","name":"string","sortIndex":0,"equivalenceValues":[{"correlationId":"string","equivalenceCorrelationId":"string","value":"string"}]}]}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"User not authorized to perform this action."},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"put":{"tags":["Dimensions"],"summary":"Updates an existing dimension record.","description":"Updates an existing dimension record.","operationId":"UpdateDimension","parameters":[{"name":"dimensionId","in":"path","description":"The unique identifier of the dimension to update.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"The updated dimension details.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateDimensionRequest"},"example":{"description":"string","shortDescription":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDimensionRequest"},"example":{"description":"string","shortDescription":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/UpdateDimensionRequest"},"example":{"description":"string","shortDescription":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/UpdateDimensionRequest"},"example":{"description":"string","shortDescription":"string"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"User not authorized to perform this action."}}},"delete":{"tags":["Dimensions"],"summary":"Deletes a specific stock dimension.","description":"Deletes a specific stock dimension.","operationId":"DeleteDimension","parameters":[{"name":"dimensionId","in":"path","description":"The unique identifier of the dimension to delete.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/api/dimensions":{"get":{"tags":["Dimensions"],"summary":"Retrieves a paginated list of Dimensions based on provided filters.","description":"Retrieves a paginated list of Dimensions based on provided filters.","operationId":"GetAllDimensions","parameters":[{"name":"SearchBy","in":"query","description":"Search criterion to filter dimensions (e.g., name or code).","schema":{"type":"string"}},{"name":"IDs","in":"query","description":"Search criterion to filter dimensions by IDs.","schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"returnEquivalences","in":"query","description":"Indicates if return equivalences or not. Default false.","schema":{"type":"boolean","default":false}},{"name":"returnAttributes","in":"query","description":"Indicates if return attributes or not. Default false.","schema":{"type":"boolean","default":false}},{"name":"pageNumber","in":"query","description":"Page number for pagination (default is 1).","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Number of records per page (default is 100, max is 300).","schema":{"maximum":300,"minimum":1,"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetDimensionsResponsePaginatedResponse"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetDimensionsResponsePaginatedResponse"},"example":{"values":[{"correlationId":"string","code":"string","description":"string","shortDescription":"string","equivalences":[{"correlationId":"string","name":"string"}],"attributes":[{"correlationId":"string","name":"string","sortIndex":0,"equivalenceValues":[{"correlationId":"string","equivalenceCorrelationId":"string","value":"string"}]}]}],"pageNumber":0,"pageSize":0,"totalCount":0,"totalPages":0}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"User not authorized to perform this action."}}},"post":{"tags":["Dimensions"],"summary":"Creates a new dimension.","description":"Creates a new dimension.","operationId":"CreateDimension","requestBody":{"description":"The dimension details to create.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CreateDimensionRequest"},"example":{"code":"string","description":"string","shortDescription":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateDimensionRequest"},"example":{"code":"string","description":"string","shortDescription":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateDimensionRequest"},"example":{"code":"string","description":"string","shortDescription":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreateDimensionRequest"},"example":{"code":"string","description":"string","shortDescription":"string"}}}},"responses":{"201":{"description":"Created","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetDimensionResponse"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetDimensionResponse"},"example":{"correlationId":"string","code":"string","description":"string","shortDescription":"string","equivalences":[{"correlationId":"string","name":"string"}],"attributes":[{"correlationId":"string","name":"string","sortIndex":0,"equivalenceValues":[{"correlationId":"string","equivalenceCorrelationId":"string","value":"string"}]}]}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"User not authorized to perform this action."}}}},"/api/inventories/lines":{"get":{"tags":["inventories"],"summary":"Retrieves the inventory lines for a specific warehouse on a given date.","description":"Retrieves the inventory lines for a specific warehouse on a given date.","operationId":"GetInventoryLines","parameters":[{"name":"warehouseCorrelationId","in":"query","description":"Unique identifier of the warehouse.","schema":{"type":"string","format":"uuid"}},{"name":"date","in":"query","description":"Date to filter the inventory lines (format: yyyy-MM-dd).","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetInventoryLinesResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetInventoryLinesResult"},"example":{"productId":0,"productCorrelationId":"string","productDescription":"string","productCode":"string","stockUnits":0,"unitValuation":0,"stockValuation":0,"providedUnits":0,"valuationCriteria":"string","warehouseCorrelationId":"string","warehouseCode":"string","warehouseDescription":"string","operationDate":"string"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/products/{productId}/stock/{criteriaValuation}":{"get":{"tags":["products"],"summary":"Retrieves stock details of a product based on valuation criteria.","description":"Retrieves stock details of a product based on valuation criteria.","operationId":"GetStockProduct","parameters":[{"name":"productId","in":"path","description":"The unique identifier of the product.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"criteriaValuation","in":"path","description":"The inventory valuation criteria to filter by.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetStockProductByCriteriaValuationQueryResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetStockProductByCriteriaValuationQueryResult"},"example":{"productCorrelationId":"string","warehouse":{"correlationId":"string","warehouseCode":"string","warehouseDescription":"string","isDefaultWarehouse":true},"stockUnits":0,"purchaseOrderReservationUnits":0,"saleOrderReservationUnits":0,"providedUnits":0,"unitValuation":0,"stockValuation":0,"stockInTransit":0,"leadTime":0,"safetyStock":0,"unitsReorderPoint":0,"maximumStock":0}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/products/{productId}/warehouse/{warehouseId}/stock/{criteriaValuation}":{"get":{"tags":["products"],"summary":"Retrieves stock details of a product filtered by valuation criteria and warehouse.","description":"Retrieves stock details of a product filtered by valuation criteria and warehouse.","operationId":"GetStockProductByCriteriaValuationAndWarehouse","parameters":[{"name":"productId","in":"path","description":"The unique identifier of the product.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"criteriaValuation","in":"path","description":"The inventory valuation criteria to filter by.","required":true,"schema":{"type":"string"}},{"name":"warehouseId","in":"path","description":"The unique identifier of the warehouse.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetStockProductByCriteriaValuationAndWarehouseQueryResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetStockProductByCriteriaValuationAndWarehouseQueryResult"},"example":{"productCorrelationId":"string","warehouse":{"correlationId":"string","warehouseCode":"string","warehouseDescription":"string","isDefaultWarehouse":true},"stockUnits":0,"purchaseOrderReservationUnits":0,"saleOrderReservationUnits":0,"providedUnits":0,"unitValuation":0,"stockValuation":0,"maximumStock":0}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/products/{productId}/warehouse/{warehouseId}/stock":{"get":{"tags":["products"],"summary":"Retrieves stock quantity of a product in a specific warehouse with optional traceability filters.","description":"Retrieves stock quantity of a product in a specific warehouse with optional traceability filters.","operationId":"GetStockProductByWarehouse","parameters":[{"name":"productId","in":"path","description":"The unique identifier of the product.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"warehouseId","in":"path","description":"The unique identifier of the warehouse.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Batch","in":"query","description":"<b>\r\n  <i>*Optional:</i>\r\n</b> Batch to filter by.","schema":{"type":"string"}},{"name":"ExpirationDate","in":"query","description":"<b>\r\n  <i>*Optional:</i>\r\n</b> Expiration date to filter by.","schema":{"type":"string","format":"date-time"}},{"name":"SerialNumber","in":"query","description":"<b>\r\n  <i>*Optional:</i>\r\n</b> Serial number to filter by.","schema":{"type":"string"}},{"name":"EntryDate","in":"query","description":"<b>\r\n  <i>*Optional:</i>\r\n</b> Entry date to filter by.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"number","format":"double"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"type":"number","format":"double"},"example":0}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/products/{parentProductCorrelationId}/variants-stock-information":{"get":{"tags":["products"],"summary":"Retrieves detailed stock information for all variants of a parent product, optionally filtered by warehouse.","description":"Retrieves detailed stock information for all variants of a parent product, optionally filtered by warehouse.","operationId":"GetVariantsStockInformation","parameters":[{"name":"parentProductCorrelationId","in":"path","description":"The unique identifier of the parent product.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"WarehouseCorrelationId","in":"query","description":"Optional. The unique identifier of the warehouse to filter the stock results.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetVariantsStockInformationQueryResponse"}},"examples":{"default":{"value":""}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetVariantsStockInformationQueryResponse"}},"example":[{"variants":[{"productCorrelationId":"string","attributes":[{"dimensionId":"string","shortDescriptionDimension":"string","attributeId":"string","nameAttribute":"string"}],"stockUnits":0,"purchaseOrderReservationUnits":0,"saleOrderReservationUnits":0,"providedUnits":0,"stockInTransit":0}],"summary":{"stockUnits":0,"purchaseOrderReservationUnits":0,"saleOrderReservationUnits":0,"stockInTransit":0,"providedUnits":0}}]}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/regularizations":{"get":{"tags":["regularizations"],"summary":"Retrieves a paginated list of stock regularizations.","description":"Retrieves a paginated list of stock regularizations.","operationId":"GetRegularizations","parameters":[{"name":"WarehouseId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"DateStart","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"DateEnd","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"SearchBy","in":"query","schema":{"type":"string"}},{"name":"pageIndex","in":"query","description":"Page index for pagination (default is 1).","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Page size for pagination (default is 100, max is 300).","schema":{"maximum":300,"minimum":1,"type":"integer","format":"int32","default":100}},{"name":"orderBy","in":"query","description":"Sorting order for the results.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetRegularizationsResultPaginatedResponse"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetRegularizationsResultPaginatedResponse"},"example":{"values":[{"id":"string","number":0,"reason":"string","date":"string","warehouseId":"string","warehouseCode":"string","warehouseDescription":"string"}],"pageNumber":0,"pageSize":0,"totalCount":0,"totalPages":0}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}},"post":{"tags":["regularizations"],"summary":"Creates a new stock regularization.","description":"Creates a new stock regularization.","operationId":"CreateRegularization","requestBody":{"description":"The regularization details to create.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CreateRegularizationRequest"},"example":{"reason":"string","warehouseId":"string","date":"string","regularizationLines":[{"productId":"string","units":0,"purchasePrice":0,"traceabilityDetails":[{"batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string"}]}]}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateRegularizationRequest"},"example":{"reason":"string","warehouseId":"string","date":"string","regularizationLines":[{"productId":"string","units":0,"purchasePrice":0,"traceabilityDetails":[{"batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string"}]}]}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateRegularizationRequest"},"example":{"reason":"string","warehouseId":"string","date":"string","regularizationLines":[{"productId":"string","units":0,"purchasePrice":0,"traceabilityDetails":[{"batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string"}]}]}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreateRegularizationRequest"},"example":{"reason":"string","warehouseId":"string","date":"string","regularizationLines":[{"productId":"string","units":0,"purchasePrice":0,"traceabilityDetails":[{"batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string"}]}]}}}},"responses":{"201":{"description":"Created","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CreateRegularizationResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateRegularizationResult"},"example":{"issues":[{"type":"string","message":"string"}],"correlationId":"string"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/regularizations/{regularizationId}":{"get":{"tags":["regularizations"],"summary":"Retrieves a specific regularization by its identifier.","description":"Retrieves a specific regularization by its identifier.","operationId":"GetRegularizationById","parameters":[{"name":"regularizationId","in":"path","description":"The unique identifier of the regularization.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetRegularizationByIdResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetRegularizationByIdResult"},"example":{"id":"string","number":0,"reason":"string","date":"string","warehouseId":"string","regularizationLines":[{"id":"string","productId":"string","units":0,"valuationCriteria":"string","purchasePrice":0,"traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string"}]}]}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}},"put":{"tags":["regularizations"],"summary":"Updates an existing stock regularization.","description":"Updates an existing stock regularization.","operationId":"UpdateRegularization","parameters":[{"name":"regularizationId","in":"path","description":"The unique identifier of the regularization to update.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"The updated regularization details.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateRegularizationRequest"},"example":{"reason":"string","warehouseId":"string","regularizationLines":[{"id":"string","productId":"string","units":0,"purchasePrice":0,"traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string"}]}]}},"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRegularizationRequest"},"example":{"reason":"string","warehouseId":"string","regularizationLines":[{"id":"string","productId":"string","units":0,"purchasePrice":0,"traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string"}]}]}},"text/json":{"schema":{"$ref":"#/components/schemas/UpdateRegularizationRequest"},"example":{"reason":"string","warehouseId":"string","regularizationLines":[{"id":"string","productId":"string","units":0,"purchasePrice":0,"traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string"}]}]}},"application/*+json":{"schema":{"$ref":"#/components/schemas/UpdateRegularizationRequest"},"example":{"reason":"string","warehouseId":"string","regularizationLines":[{"id":"string","productId":"string","units":0,"purchasePrice":0,"traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string"}]}]}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/UpdateRegularizationResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRegularizationResult"},"example":{"issues":[{"type":"string","message":"string"}]}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}},"delete":{"tags":["regularizations"],"summary":"Deletes a specific stock regularization.","description":"Deletes a specific stock regularization.","operationId":"DeleteRegularization","parameters":[{"name":"regularizationId","in":"path","description":"The unique identifier of the regularization to delete.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/DeleteRegularizationResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRegularizationResult"},"example":{"issues":[{"type":"string","message":"string"}]}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/regularizations/{regularizationId}/export":{"get":{"tags":["regularizations"],"summary":"Exports the details of a specific stock regularization.","description":"Exports the details of a specific stock regularization.","operationId":"ExportRegularization","parameters":[{"name":"regularizationId","in":"path","description":"The unique identifier of the regularization to export.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"202":{"description":"Accepted","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ResultMessage"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ResultMessage"},"example":{"issues":[{"type":"string","message":"string"}],"success":true,"result":{}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/reorderpoints/warehouse/{warehouseId}":{"get":{"tags":["ReorderPoints"],"summary":"Retrieves all products with configured reorder points for a specific warehouse.","description":"Retrieves all products with configured reorder points for a specific warehouse.","operationId":"GetProductsByWarehouse","parameters":[{"name":"warehouseId","in":"path","description":"Unique identifier of the warehouse.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"FilterType","in":"query","schema":{"$ref":"#/components/schemas/ReorderPointType"}},{"name":"SearchBy","in":"query","schema":{"type":"string"}},{"name":"pageIndex","in":"query","description":"Page index for pagination (default is 1).","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Number of records per page (default is 100, max is 300).","schema":{"maximum":300,"minimum":1,"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetProductsReorderPointResultPaginatedResponse"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetProductsReorderPointResultPaginatedResponse"},"example":{"values":[{"productId":"string","productCode":"string","productDescription":"string","leadTime":0,"stockUnits":0,"safetyStock":0,"unitsReorderPoint":0,"calculatedDateDetail":"string","updatedDate":"string","maximumStock":0}],"pageNumber":0,"pageSize":0,"totalCount":0,"totalPages":0}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/reorderpoints/warehouse/{warehouseId}/export":{"get":{"tags":["ReorderPoints"],"summary":"Exports all reorder points for a specific warehouse as a downloadable file.","description":"Exports all reorder points for a specific warehouse as a downloadable file.","operationId":"ExportAll","parameters":[{"name":"warehouseId","in":"path","description":"Unique identifier of the warehouse.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"FilterType","in":"query","schema":{"$ref":"#/components/schemas/ReorderPointType"}},{"name":"SearchBy","in":"query","schema":{"type":"string"}}],"responses":{"202":{"description":"Accepted","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ResultMessage"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ResultMessage"},"example":{"issues":[{"type":"string","message":"string"}],"success":true,"result":{}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/reorderpoints/product/{productId}/warehouse/{warehouseId}":{"get":{"tags":["ReorderPoints"],"summary":"Retrieves the reorder point for a specific product in a warehouse.","description":"Retrieves the reorder point for a specific product in a warehouse.","operationId":"GetReorderPointByProductAndWarehouse","parameters":[{"name":"productId","in":"path","description":"Unique identifier of the product.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"warehouseId","in":"path","description":"Unique identifier of the warehouse.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetReorderPointByProductAndWarehouseResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetReorderPointByProductAndWarehouseResult"},"example":{"id":"string","productId":"string","productCode":"string","productDescription":"string","warehouseId":"string","warehouseCode":"string","warehouseDescription":"string","leadTime":0,"safetyStock":0,"unitsReorderPoint":0,"updatedDate":"string","fromDate":"string","toDate":"string","exceptFromDate":"string","exceptToDate":"string","analyzeTransfers":true,"leadTimeDetail":0,"safetyStockDetail":0,"unitsReorderPointDetail":0,"demandForecastDetail":0,"calculatedDaysDetail":0,"calculatedStockDetail":0,"calculatedDateDetail":"string"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}},"put":{"tags":["ReorderPoints"],"summary":"Creates or updates a reorder point for a specific product in a warehouse.","description":"Creates or updates a reorder point for a specific product in a warehouse.","operationId":"PutReorderPoint","parameters":[{"name":"productId","in":"path","description":"Unique identifier of the product.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"warehouseId","in":"path","description":"Unique identifier of the warehouse.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Reorder point details to create or update.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CreateOrUpdateReorderPointRequest"},"example":{"leadTime":0,"safetyStock":0,"unitsReorderPoint":0,"detail":{"leadTime":0,"safetyStock":0,"unitsReorderPoint":0,"fromDate":"string","toDate":"string","exceptFromDate":"string","exceptToDate":"string","analyzeTransfers":true,"demandForecast":0,"calculatedDays":0,"calculatedStock":0},"maximumStock":0}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrUpdateReorderPointRequest"},"example":{"leadTime":0,"safetyStock":0,"unitsReorderPoint":0,"detail":{"leadTime":0,"safetyStock":0,"unitsReorderPoint":0,"fromDate":"string","toDate":"string","exceptFromDate":"string","exceptToDate":"string","analyzeTransfers":true,"demandForecast":0,"calculatedDays":0,"calculatedStock":0},"maximumStock":0}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateOrUpdateReorderPointRequest"},"example":{"leadTime":0,"safetyStock":0,"unitsReorderPoint":0,"detail":{"leadTime":0,"safetyStock":0,"unitsReorderPoint":0,"fromDate":"string","toDate":"string","exceptFromDate":"string","exceptToDate":"string","analyzeTransfers":true,"demandForecast":0,"calculatedDays":0,"calculatedStock":0},"maximumStock":0}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreateOrUpdateReorderPointRequest"},"example":{"leadTime":0,"safetyStock":0,"unitsReorderPoint":0,"detail":{"leadTime":0,"safetyStock":0,"unitsReorderPoint":0,"fromDate":"string","toDate":"string","exceptFromDate":"string","exceptToDate":"string","analyzeTransfers":true,"demandForecast":0,"calculatedDays":0,"calculatedStock":0},"maximumStock":0}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CreateOrUpdateReorderPointResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrUpdateReorderPointResult"},"example":{"issues":[{"type":"string","message":"string"}],"leadTime":0,"safetyStock":0,"unitsReorderPoint":0,"correlationId":"string"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/reorderpoints/product/{productId}/warehouse/{warehouseId}/calculate":{"post":{"tags":["ReorderPoints"],"summary":"Calculates a reorder point for a specific product in a warehouse based on stock data.","description":"Calculates a reorder point for a specific product in a warehouse based on stock data.","operationId":"CalculateReorderPoint","parameters":[{"name":"productId","in":"path","description":"Unique identifier of the product.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"warehouseId","in":"path","description":"Unique identifier of the warehouse.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Parameters required for the reorder point calculation.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CalculateReorderPointRequest"},"example":{"leadTime":0,"safetyStock":0,"unitsReorderPoint":0,"fromDate":"string","toDate":"string","exceptFromDate":"string","exceptToDate":"string","analyzeTransfers":true,"demandForecast":0,"calculatedDays":0,"calculatedStock":0}},"application/json":{"schema":{"$ref":"#/components/schemas/CalculateReorderPointRequest"},"example":{"leadTime":0,"safetyStock":0,"unitsReorderPoint":0,"fromDate":"string","toDate":"string","exceptFromDate":"string","exceptToDate":"string","analyzeTransfers":true,"demandForecast":0,"calculatedDays":0,"calculatedStock":0}},"text/json":{"schema":{"$ref":"#/components/schemas/CalculateReorderPointRequest"},"example":{"leadTime":0,"safetyStock":0,"unitsReorderPoint":0,"fromDate":"string","toDate":"string","exceptFromDate":"string","exceptToDate":"string","analyzeTransfers":true,"demandForecast":0,"calculatedDays":0,"calculatedStock":0}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CalculateReorderPointRequest"},"example":{"leadTime":0,"safetyStock":0,"unitsReorderPoint":0,"fromDate":"string","toDate":"string","exceptFromDate":"string","exceptToDate":"string","analyzeTransfers":true,"demandForecast":0,"calculatedDays":0,"calculatedStock":0}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CalculateReorderPointResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CalculateReorderPointResult"},"example":{"issues":[{"type":"string","message":"string"}],"productId":"string","warehouseId":"string","leadTime":0,"safetyStock":0,"unitsReorderPoint":0,"fromDate":"string","toDate":"string","exceptFromDate":"string","exceptToDate":"string","analyzeTransfers":true,"demandForecast":0,"calculatedDays":0,"calculatedStock":0,"calculatedDate":"string"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/reorderpoints/warehouse/{warehouseId}/calculate":{"post":{"tags":["ReorderPoints"],"summary":"Calculates reorder points for multiple products within a specific warehouse.","description":"Calculates reorder points for multiple products within a specific warehouse.","operationId":"CalculateMultipleReorderPoints","parameters":[{"name":"warehouseId","in":"path","description":"Unique identifier of the warehouse.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Parameters required for the multiple reorder points calculation.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CalculateMultipleReorderPointsRequest"},"example":{"searchBy":"string","filterType":0,"includedProducts":["string"],"excludedProducts":["string"],"fromDate":"string","toDate":"string","exceptFromDate":"string","exceptToDate":"string","analyzeTransfers":true}},"application/json":{"schema":{"$ref":"#/components/schemas/CalculateMultipleReorderPointsRequest"},"example":{"searchBy":"string","filterType":0,"includedProducts":["string"],"excludedProducts":["string"],"fromDate":"string","toDate":"string","exceptFromDate":"string","exceptToDate":"string","analyzeTransfers":true}},"text/json":{"schema":{"$ref":"#/components/schemas/CalculateMultipleReorderPointsRequest"},"example":{"searchBy":"string","filterType":0,"includedProducts":["string"],"excludedProducts":["string"],"fromDate":"string","toDate":"string","exceptFromDate":"string","exceptToDate":"string","analyzeTransfers":true}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CalculateMultipleReorderPointsRequest"},"example":{"searchBy":"string","filterType":0,"includedProducts":["string"],"excludedProducts":["string"],"fromDate":"string","toDate":"string","exceptFromDate":"string","exceptToDate":"string","analyzeTransfers":true}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CalculateMultipleReorderPointsResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CalculateMultipleReorderPointsResult"},"example":{"issues":[{"type":"string","message":"string"}]}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/stock/product/{productId}/currentstockdetail":{"get":{"tags":["stock"],"summary":"Get the dates and associated stock for a specific serial number by product.","description":"Get the dates and associated stock for a specific serial number by product.","operationId":"GetCurrentStockBySerialNumber","parameters":[{"name":"productId","in":"path","description":"Unique identifier of the product.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"serialnumber","in":"query","description":"SerialNumber as query string.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetCurrentStockBySerialNumberResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetCurrentStockBySerialNumberResult"},"example":{"expirationDate":"string","entryDate":"string","stockUnits":0,"warehouseId":"string","warehouseCode":"string"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/stock/product/{productId}/warehouse/{warehouseId}/currentstockdetail":{"get":{"tags":["stock"],"summary":"Get the list of dates and associated stock for a specific batch by product and warehouse.","description":"Get the list of dates and associated stock for a specific batch by product and warehouse.","operationId":"GetCurrentStockByBatch","parameters":[{"name":"productId","in":"path","description":"Unique identifier of the product.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"warehouseId","in":"path","description":"Unique identifier of the warehouse.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"batch","in":"query","description":"Batch as query string.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetCurrentStockResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetCurrentStockResult"},"example":{"expirationDate":"string","entryDate":"string","stockUnits":0}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/stock/product/{productId}/warehouse/{warehouseId}/stockdetail":{"get":{"tags":["stock"],"summary":"Retrieves the stock detail for a specific product in a warehouse.","description":"Retrieves the stock detail for a specific product in a warehouse.","operationId":"GetCurrentStockDetail","parameters":[{"name":"productId","in":"path","description":"Unique identifier of the product.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"warehouseId","in":"path","description":"Unique identifier of the warehouse.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetCurrentStockDetailResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetCurrentStockDetailResult"},"example":{"issues":[{"type":"string","message":"string"}],"productId":"string","warehouseId":"string","stockUnits":0,"currentStockDetails":[{"batch":"string","expirationDate":"string","serialNumber":"string","entryDate":"string","stockUnits":0,"assignedUnits":0}]}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/stock/product/{productId}/warehouse/{warehouseId}":{"get":{"tags":["stock"],"summary":"Retrieves the stock detail for a specific product in a warehouse, assigning the requested number of units.\r\nIf an expiration validation date is provided, only stock entries with an expiration date on or after this threshold will be considered.","description":"Retrieves the stock detail for a specific product in a warehouse, assigning the requested number of units.\r\nIf an expiration validation date is provided, only stock entries with an expiration date on or after this threshold will be considered.","operationId":"GetCurrentStockDetailAssignedUnits","parameters":[{"name":"productId","in":"path","description":"Unique identifier of the product.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"warehouseId","in":"path","description":"Unique identifier of the warehouse.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"units","in":"query","description":"Number of units to retrieve.","schema":{"type":"number","format":"double"}},{"name":"expirationValidationDate","in":"query","description":"Optional expiration cutoff date. If date is provided,\r\n           only stock details with an expiration date greater than or equal to this value will be considered valid.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetCurrentStockDetailAssignedUnitsResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetCurrentStockDetailAssignedUnitsResult"},"example":{"issues":[{"type":"string","message":"string"}],"productId":"string","warehouseId":"string","currentStockDetails":[{"batch":"string","expirationDate":"string","serialNumber":"string","entryDate":"string","stockUnits":0,"assignedUnits":0}]}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/stockmovements/warehouse/{warehouseId}/product/{productId}":{"get":{"tags":["StockMovements"],"summary":"Retrieves all stock movements for a specific product within a warehouse.","description":"Retrieves all stock movements for a specific product within a warehouse.","operationId":"GetStockMovements","parameters":[{"name":"warehouseId","in":"path","description":"Unique identifier of the warehouse.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productId","in":"path","description":"Unique identifier of the product.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"PageIndex","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"PageSize","in":"query","schema":{"maximum":300,"minimum":1,"type":"integer","format":"int32"}},{"name":"SearchBy","in":"query","schema":{"type":"string"}},{"name":"DateStart","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"DateEnd","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"OperationTypes","in":"query","schema":{"type":"array","items":{"$ref":"#/components/schemas/OperationType"}}},{"name":"Batch","in":"query","schema":{"type":"string"}},{"name":"SerialNumber","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetMovementsResultPaginatedResponse"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetMovementsResultPaginatedResponse"},"example":{"values":[{"operationType":"string","operationId":"string","operationDate":"string","operationName":"string","operationNumber":"string","operationDescription":"string","inUnits":0,"outUnits":0,"unitsStock":0,"cost":0,"thirdParty":"string","price":0,"batch":"string","serialNumber":"string","expirationDate":"string"}],"pageNumber":0,"pageSize":0,"totalCount":0,"totalPages":0}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/stockmovements/warehouse/{warehouseId}/product/{productId}/export":{"get":{"tags":["StockMovements"],"summary":"Exports stock movements for a specific warehouse and product as a downloadable file.","description":"Exports stock movements for a specific warehouse and product as a downloadable file.","operationId":"ExportStockMovements","parameters":[{"name":"warehouseId","in":"path","description":"Unique identifier of the warehouse.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productId","in":"path","description":"Unique identifier of the product.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"DateStart","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"DateEnd","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"OperationTypes","in":"query","schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"name":"SearchBy","in":"query","schema":{"type":"string"}},{"name":"Batch","in":"query","schema":{"type":"string"}},{"name":"SerialNumber","in":"query","schema":{"type":"string"}}],"responses":{"202":{"description":"Accepted","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ResultMessage"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ResultMessage"},"example":{"issues":[{"type":"string","message":"string"}],"success":true,"result":{}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/transfers":{"get":{"tags":["Transfers"],"summary":"Retrieves a paginated list of transfers based on provided filters.","description":"Retrieves a paginated list of transfers based on provided filters.","operationId":"GetTransfers","parameters":[{"name":"WarehouseOriginId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"WarehouseDestinationId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"DateStart","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"DateEnd","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"States","in":"query","schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"name":"SearchBy","in":"query","schema":{"type":"string"}},{"name":"pageIndex","in":"query","description":"Page number (starting from 1).","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Number of items per page (default is 100, max is 300).","schema":{"maximum":300,"minimum":1,"type":"integer","format":"int32","default":100}},{"name":"orderBy","in":"query","description":"Sorting fields (format: [field] [asc|desc]).","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetTransfersResultPaginatedResponse"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetTransfersResultPaginatedResponse"},"example":{"values":[{"state":0,"id":"string","number":0,"reason":"string","date":"string","warehouseOriginId":"string","warehouseOriginCode":"string","warehouseOriginDescription":"string","warehouseDestinationId":"string","warehouseDestinationCode":"string","warehouseDestinationDescription":"string","carrierId":"string","carrierDescription":"string"}],"pageNumber":0,"pageSize":0,"totalCount":0,"totalPages":0}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}},"post":{"tags":["Transfers"],"summary":"Creates a new stock transfer.","description":"Creates a new stock transfer.","operationId":"CreateTransfer","requestBody":{"description":"Details of the transfer to create.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CreateTransferRequest"},"example":{"reason":"string","date":"string","warehouseOriginId":"string","warehouseDestinationId":"string","carrierId":"string","transferLines":[{"productId":"string","units":0,"additionalUnitCost":0,"traceabilityDetails":[{"batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string"}]}]}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateTransferRequest"},"example":{"reason":"string","date":"string","warehouseOriginId":"string","warehouseDestinationId":"string","carrierId":"string","transferLines":[{"productId":"string","units":0,"additionalUnitCost":0,"traceabilityDetails":[{"batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string"}]}]}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateTransferRequest"},"example":{"reason":"string","date":"string","warehouseOriginId":"string","warehouseDestinationId":"string","carrierId":"string","transferLines":[{"productId":"string","units":0,"additionalUnitCost":0,"traceabilityDetails":[{"batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string"}]}]}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreateTransferRequest"},"example":{"reason":"string","date":"string","warehouseOriginId":"string","warehouseDestinationId":"string","carrierId":"string","transferLines":[{"productId":"string","units":0,"additionalUnitCost":0,"traceabilityDetails":[{"batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string"}]}]}}}},"responses":{"201":{"description":"Created","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CreateTransferResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateTransferResult"},"example":{"issues":[{"type":"string","message":"string"}],"correlationId":"string"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/transfers/{transferId}":{"get":{"tags":["Transfers"],"summary":"Retrieves details of a specific transfer by its identifier.","description":"Retrieves details of a specific transfer by its identifier.","operationId":"GetTransferById","parameters":[{"name":"transferId","in":"path","description":"Unique identifier of the transfer.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetTransferByIdResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetTransferByIdResult"},"example":{"id":"string","number":0,"reason":"string","date":"string","state":0,"warehouseOriginId":"string","warehouseDestinationId":"string","carrierId":"string","transferLines":[{"id":"string","productId":"string","units":0,"additionalUnitCost":0,"traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string","unitsReceived":0,"unitsDiscarded":0}],"unitsReceived":0,"unitsDiscarded":0}]}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}},"put":{"tags":["Transfers"],"summary":"Updates an existing stock transfer.","description":"Updates an existing stock transfer.","operationId":"UpdateTransfer","parameters":[{"name":"transferId","in":"path","description":"Unique identifier of the transfer to update.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Updated transfer details.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateTransferRequest"},"example":{"reason":"string","warehouseOriginId":"string","warehouseDestinationId":"string","carrierId":"string","transferLines":[{"id":"string","productId":"string","units":0,"additionalUnitCost":0,"traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string"}]}]}},"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTransferRequest"},"example":{"reason":"string","warehouseOriginId":"string","warehouseDestinationId":"string","carrierId":"string","transferLines":[{"id":"string","productId":"string","units":0,"additionalUnitCost":0,"traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string"}]}]}},"text/json":{"schema":{"$ref":"#/components/schemas/UpdateTransferRequest"},"example":{"reason":"string","warehouseOriginId":"string","warehouseDestinationId":"string","carrierId":"string","transferLines":[{"id":"string","productId":"string","units":0,"additionalUnitCost":0,"traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string"}]}]}},"application/*+json":{"schema":{"$ref":"#/components/schemas/UpdateTransferRequest"},"example":{"reason":"string","warehouseOriginId":"string","warehouseDestinationId":"string","carrierId":"string","transferLines":[{"id":"string","productId":"string","units":0,"additionalUnitCost":0,"traceabilityDetails":[{"id":"string","batch":"string","expirationDate":"string","serialNumber":"string","units":0,"entryDate":"string"}]}]}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/UpdateTransferResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTransferResult"},"example":{"issues":[{"type":"string","message":"string"}]}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}},"delete":{"tags":["Transfers"],"summary":"Deletes an existing stock transfer.","description":"Deletes an existing stock transfer.","operationId":"DeleteTransfer","parameters":[{"name":"transferId","in":"path","description":"Unique identifier of the transfer to delete.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/DeleteTransferResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTransferResult"},"example":{"issues":[{"type":"string","message":"string"}]}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/transfers/export":{"get":{"tags":["Transfers"],"summary":"Exports all transfers matching the provided filters.","description":"Exports all transfers matching the provided filters.","operationId":"ExportAllTransfers","parameters":[{"name":"WarehouseOriginId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"WarehouseDestinationId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"DateStart","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"DateEnd","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"States","in":"query","schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"name":"SearchBy","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Sorting fields (format: [field] [asc|desc]).","schema":{"type":"string"}}],"responses":{"202":{"description":"Accepted","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ResultMessage"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ResultMessage"},"example":{"issues":[{"type":"string","message":"string"}],"success":true,"result":{}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/transfers/{transferId}/export":{"get":{"tags":["Transfers"],"summary":"Exports the details of a specific transfer.","description":"Exports the details of a specific transfer.","operationId":"ExportTransfer","parameters":[{"name":"transferId","in":"path","description":"Unique identifier of the transfer to export.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"202":{"description":"Accepted","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ResultMessage"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ResultMessage"},"example":{"issues":[{"type":"string","message":"string"}],"success":true,"result":{}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/transfers/{transferId}/receptions":{"post":{"tags":["Transfers"],"summary":"Creates a reception (total or partial) for an existing transfer.","description":"Creates a reception (total or partial) for an existing transfer.","operationId":"CreateTransferReception","parameters":[{"name":"transferId","in":"path","description":"Unique identifier of the transfer to receive.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Details of the reception to create.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CreateTransferReceptionRequest"},"example":{"date":"string","reason":"string","transferReceptionLines":[{"transferLineId":"string","units":0,"receptionTraceabilityDetails":[{"transferLineTraceabilityDetailId":"string","units":0}]}]}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateTransferReceptionRequest"},"example":{"date":"string","reason":"string","transferReceptionLines":[{"transferLineId":"string","units":0,"receptionTraceabilityDetails":[{"transferLineTraceabilityDetailId":"string","units":0}]}]}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateTransferReceptionRequest"},"example":{"date":"string","reason":"string","transferReceptionLines":[{"transferLineId":"string","units":0,"receptionTraceabilityDetails":[{"transferLineTraceabilityDetailId":"string","units":0}]}]}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreateTransferReceptionRequest"},"example":{"date":"string","reason":"string","transferReceptionLines":[{"transferLineId":"string","units":0,"receptionTraceabilityDetails":[{"transferLineTraceabilityDetailId":"string","units":0}]}]}}}},"responses":{"201":{"description":"Created","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CreateTransferReceptionResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateTransferReceptionResult"},"example":{"issues":[{"type":"string","message":"string"}],"correlationId":"string"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}},"get":{"tags":["Transfers"],"summary":"Retrieves a paginated list of receptions related to a specific transfer.","description":"Retrieves a paginated list of receptions related to a specific transfer.","operationId":"GetReceptionsByTransferId","parameters":[{"name":"transferId","in":"path","description":"Unique identifier of the transfer.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"pageIndex","in":"query","description":"Page number (starting from 1).","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Number of items per page (default is 100, max is 300).","schema":{"maximum":300,"minimum":1,"type":"integer","format":"int32","default":100}},{"name":"orderBy","in":"query","description":"Sorting fields (format: [field] [asc|desc]).","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetTransferReceptionsByIdResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetTransferReceptionsByIdResult"},"example":{"id":"string","date":"string","receptionType":0}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/transfers/{transferId}/receptions/discard":{"post":{"tags":["Transfers"],"summary":"Discards a transfer by creating a discard reception.","description":"Discards a transfer by creating a discard reception.","operationId":"CreateTransferReceptionDiscard","parameters":[{"name":"transferId","in":"path","description":"Unique identifier of the transfer to discard.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Details of the discard to create.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CreateTransferReceptionDiscardRequest"},"example":{"date":"string","reason":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateTransferReceptionDiscardRequest"},"example":{"date":"string","reason":"string"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateTransferReceptionDiscardRequest"},"example":{"date":"string","reason":"string"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreateTransferReceptionDiscardRequest"},"example":{"date":"string","reason":"string"}}}},"responses":{"201":{"description":"Created","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CreateTransferReceptionResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateTransferReceptionResult"},"example":{"issues":[{"type":"string","message":"string"}],"correlationId":"string"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/transfers/receptions/{receptionId}":{"get":{"tags":["Transfers"],"summary":"Retrieves the details of a specific reception or discard.","description":"Retrieves the details of a specific reception or discard.","operationId":"GetReceptionById","parameters":[{"name":"receptionId","in":"path","description":"Unique identifier of the reception or discard.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetTransferReceptionByIdResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetTransferReceptionByIdResult"},"example":{"id":"string","date":"string","receptionType":0,"transferReceptionLines":[{"transferLineId":"string","units":0,"receptionTraceabilityDetails":[{"transferLineTraceabilityDetailId":"string","units":0}]}]}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}},"delete":{"tags":["Transfers"],"summary":"Deletes an existing reception or discard.","description":"Deletes an existing reception or discard.","operationId":"DeleteTransferReception","parameters":[{"name":"receptionId","in":"path","description":"Unique identifier of the reception or discard to delete.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/DeleteTransferReceptionResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTransferReceptionResult"},"example":{"issues":[{"type":"string","message":"string"}]}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/warehouses":{"get":{"tags":["Warehouses"],"summary":"Retrieves a paginated list of warehouses based on provided filters.","description":"Retrieves a paginated list of warehouses based on provided filters.","operationId":"GetAllWarehouses","parameters":[{"name":"SearchBy","in":"query","schema":{"type":"string"}},{"name":"CorrelationIds","in":"query","schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"pageNumber","in":"query","description":"Page number for pagination (default is 1).","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Number of records per page (default is 100, max is 300).","schema":{"maximum":300,"minimum":1,"type":"integer","format":"int32","default":100}},{"name":"includeTransit","in":"query","description":"Whether to include transit warehouses in the result.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetWarehousesQueryResultPaginatedResponse"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetWarehousesQueryResultPaginatedResponse"},"example":{"values":[{"correlationId":"string","code":"string","description":"string","address":{"countryCode":"string","town":"string","street":"string","provinceDescription":"string","zipCode":"string","provinceCode":"string"},"phone":"string","contactPerson":"string","lowStockAlert":true,"allowNegativeStock":true,"isDefault":true}],"pageNumber":0,"pageSize":0,"totalCount":0,"totalPages":0}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}},"post":{"tags":["Warehouses"],"summary":"Creates a new warehouse.","description":"Creates a new warehouse.","operationId":"CreateWarehouse","requestBody":{"description":"Information of the warehouse to create.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CreateWarehouseRequest"},"example":{"code":"string","description":"string","address":{"countryCode":"string","town":"string","street":"string","provinceDescription":"string","zipCode":"string","provinceCode":"string"},"phone":"string","contactPerson":"string","lowStockAlert":true,"allowNegativeStock":true}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateWarehouseRequest"},"example":{"code":"string","description":"string","address":{"countryCode":"string","town":"string","street":"string","provinceDescription":"string","zipCode":"string","provinceCode":"string"},"phone":"string","contactPerson":"string","lowStockAlert":true,"allowNegativeStock":true}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateWarehouseRequest"},"example":{"code":"string","description":"string","address":{"countryCode":"string","town":"string","street":"string","provinceDescription":"string","zipCode":"string","provinceCode":"string"},"phone":"string","contactPerson":"string","lowStockAlert":true,"allowNegativeStock":true}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreateWarehouseRequest"},"example":{"code":"string","description":"string","address":{"countryCode":"string","town":"string","street":"string","provinceDescription":"string","zipCode":"string","provinceCode":"string"},"phone":"string","contactPerson":"string","lowStockAlert":true,"allowNegativeStock":true}}}},"responses":{"201":{"description":"Created","content":{"text/plain":{"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"type":"string","format":"uuid"},"example":"string"}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/warehouses/{warehouseId}":{"get":{"tags":["Warehouses"],"summary":"Retrieves a warehouse by its unique identifier.","description":"Retrieves a warehouse by its unique identifier.","operationId":"GetWarehouseById","parameters":[{"name":"warehouseId","in":"path","description":"Unique identifier of the warehouse.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetWarehouseByIdResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetWarehouseByIdResult"},"example":{"correlationId":"string","code":"string","description":"string","address":{"countryCode":"string","town":"string","street":"string","provinceDescription":"string","zipCode":"string","provinceCode":"string"},"phone":"string","contactPerson":"string","lowStockAlert":true,"allowNegativeStock":true,"isDefault":true,"isTransit":true,"isDisabled":true}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}},"put":{"tags":["Warehouses"],"summary":"Updates an existing warehouse.","description":"Updates an existing warehouse.","operationId":"UpdateWarehouse","parameters":[{"name":"warehouseId","in":"path","description":"Unique identifier of the warehouse to update.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Updated warehouse information.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateWarehouseRequest"},"example":{"code":"string","description":"string","address":{"countryCode":"string","town":"string","street":"string","provinceDescription":"string","zipCode":"string","provinceCode":"string"},"phone":"string","contactPerson":"string","lowStockAlert":true,"allowNegativeStock":true}},"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWarehouseRequest"},"example":{"code":"string","description":"string","address":{"countryCode":"string","town":"string","street":"string","provinceDescription":"string","zipCode":"string","provinceCode":"string"},"phone":"string","contactPerson":"string","lowStockAlert":true,"allowNegativeStock":true}},"text/json":{"schema":{"$ref":"#/components/schemas/UpdateWarehouseRequest"},"example":{"code":"string","description":"string","address":{"countryCode":"string","town":"string","street":"string","provinceDescription":"string","zipCode":"string","provinceCode":"string"},"phone":"string","contactPerson":"string","lowStockAlert":true,"allowNegativeStock":true}},"application/*+json":{"schema":{"$ref":"#/components/schemas/UpdateWarehouseRequest"},"example":{"code":"string","description":"string","address":{"countryCode":"string","town":"string","street":"string","provinceDescription":"string","zipCode":"string","provinceCode":"string"},"phone":"string","contactPerson":"string","lowStockAlert":true,"allowNegativeStock":true}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/warehouses/{warehouseId}/stock":{"get":{"tags":["Warehouses"],"summary":"Retrieves stock details for a specific warehouse, optionally filtered by unit quantity.","description":"Retrieves stock details for a specific warehouse, optionally filtered by unit quantity.","operationId":"GetWarehouseStock","parameters":[{"name":"warehouseId","in":"path","description":"Unique identifier of the warehouse.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"unitStockFilter","in":"query","description":"Stock comparison type (e.g., greater than, less than).","schema":{"type":"integer","format":"int32"}},{"name":"unitStockFilterValue","in":"query","description":"Stock quantity threshold for filtering.","schema":{"type":"number","format":"double"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetWarehouseStockQueryResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetWarehouseStockQueryResult"},"example":{"warehouseStockDtos":[{"productId":0,"productCorrelationId":"string","productDescription":"string","productCode":"string","stockUnits":0,"unitValuation":0,"stockValuation":0,"providedUnits":0,"valuationCriteria":"string","warehouseCorrelationId":"string","warehouseCode":"string","warehouseDescription":"string","leadTime":0,"safetyStock":0,"unitsReorderPoint":0}]}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/warehouses/{warehouseId}/disable":{"put":{"tags":["Warehouses"],"summary":"Disables a warehouse.","description":"Disables a warehouse.","operationId":"UpdateDisableWarehouse","parameters":[{"name":"warehouseId","in":"path","description":"Unique identifier of the warehouse to disable.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/UpdateDisabledWarehouseResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDisabledWarehouseResult"},"example":{"issues":[{"type":"string","message":"string"}]}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}},"/api/warehouses/new":{"get":{"tags":["Warehouses"],"summary":"Retrieves a new warehouse template.","description":"Retrieves a new warehouse template.","operationId":"GetNewWarehouse","responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GetNewWarehouseQueryResult"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/GetNewWarehouseQueryResult"},"example":{"correlationId":"string","code":"string","description":"string","address":{"countryCode":"string","town":"string","street":"string","provinceDescription":"string","zipCode":"string","provinceCode":"string"},"phone":"string","contactPerson":"string","lowStockAlert":true,"allowNegativeStock":true,"isDefault":true}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomProblemDetails"},"example":{"title":"string","status":0,"detail":"string","instance":"string","extensions":{}}}}}}}}},"components":{"schemas":{"AddressDto":{"type":"object","properties":{"countryCode":{"maxLength":2,"type":"string","nullable":true},"town":{"maxLength":100,"type":"string","nullable":true},"street":{"maxLength":100,"type":"string","nullable":true},"provinceDescription":{"maxLength":50,"type":"string","nullable":true},"zipCode":{"type":"string","nullable":true},"provinceCode":{"type":"string","nullable":true}},"additionalProperties":false},"CalculateMultipleReorderPointsRequest":{"type":"object","properties":{"searchBy":{"type":"string","description":"<b>\r\n  <i>*Optional:</i>\r\n</b> Search applied in the calculation of the reorder point","nullable":true},"filterType":{"type":"integer","description":"<b>\r\n  <i>*Required:</i>\r\n</b> Applied filters in the calculation of the reorder point\r\n            <ol><li>All</li><li>Less or equal than units reorder point</li><li>Less or equal than safety stock</li></ol>","format":"int32","nullable":true},"includedProducts":{"type":"array","items":{"type":"string","format":"uuid"},"description":"<b>\r\n  <i>*Required:</i>\r\n</b> Products included in the calculation of the reorder point","nullable":true},"excludedProducts":{"type":"array","items":{"type":"string","format":"uuid"},"description":"<b>\r\n  <i>*Required:</i>\r\n</b> Products excluded in the calculation of the reorder point","nullable":true},"fromDate":{"type":"string","description":"<b>\r\n  <i>*Required:</i>\r\n</b> Date from which to filter all movements of product","format":"date-time","nullable":true},"toDate":{"type":"string","description":"<b>\r\n  <i>*Required:</i>\r\n</b> Date to which to filter all movements of product","format":"date-time","nullable":true},"exceptFromDate":{"type":"string","description":"<b>\r\n  <i>*Optional:</i>\r\n</b>Date from exclude to filter all movements of product","format":"date-time","nullable":true},"exceptToDate":{"type":"string","description":"<b>\r\n  <i>*Optional:</i>\r\n</b>Date to exclude to filter all movements of product","format":"date-time","nullable":true},"analyzeTransfers":{"type":"boolean","description":"<b>\r\n  <i>*Optional:</i>\r\n</b>Inclue transfers to calculate reorder point","nullable":true}},"additionalProperties":false,"description":"Body model to calculate the reorder point for multiples products in a warehouse"},"CalculateMultipleReorderPointsResult":{"type":"object","properties":{"issues":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"nullable":true}},"additionalProperties":false},"CalculateReorderPointRequest":{"type":"object","properties":{"leadTime":{"type":"integer","description":"<b>\r\n  <i>*Required:</i>\r\n</b>Estimated time it takes for a supplier to deliver the ordered products to the warehouse","format":"int32","nullable":true},"safetyStock":{"type":"number","description":"<b>\r\n  <i>*Required:</i>\r\n</b> Extra inventory kept in the warehouse to handle unforeseen events","format":"double","nullable":true},"unitsReorderPoint":{"type":"number","description":"<b>\r\n  <i>*Required:</i>\r\n</b>The point at which the company should place a new stock order with its suppliers","format":"double","nullable":true},"fromDate":{"type":"string","description":"<b>\r\n  <i>*Required:</i>\r\n</b> Date from which to filter all movements of product","format":"date-time","nullable":true},"toDate":{"type":"string","description":"<b>\r\n  <i>*Required:</i>\r\n</b> Date to which to filter all movements of product","format":"date-time","nullable":true},"exceptFromDate":{"type":"string","description":"<b>\r\n  <i>*Optional:</i>\r\n</b>Date from exclude to filter all movements of product","format":"date-time","nullable":true},"exceptToDate":{"type":"string","description":"<b>\r\n  <i>*Optional:</i>\r\n</b>Date to exclude to filter all movements of product","format":"date-time","nullable":true},"analyzeTransfers":{"type":"boolean","description":"<b>\r\n  <i>*Optional:</i>\r\n</b>Inclue transfers to calculate reorder point","nullable":true},"demandForecast":{"type":"number","description":"<b>\r\n  <i>*Optional:</i>\r\n</b>Demand forecast for the product by selected days","format":"double","nullable":true},"calculatedDays":{"type":"integer","description":"<b>\r\n  <i>*Optional:</i>\r\n</b>Calculated days","format":"int32","nullable":true},"calculatedStock":{"type":"number","description":"<b>\r\n  <i>*Optional:</i>\r\n</b>Calculated stock","format":"double","nullable":true}},"additionalProperties":false,"description":"Body model to set the detail of a reorder point in stock for an existing product in a warehouse"},"CalculateReorderPointResult":{"type":"object","properties":{"issues":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"nullable":true},"productId":{"type":"string","format":"uuid","nullable":true},"warehouseId":{"type":"string","format":"uuid","nullable":true},"leadTime":{"type":"integer","format":"int32"},"safetyStock":{"type":"number","format":"double"},"unitsReorderPoint":{"type":"number","format":"double"},"fromDate":{"type":"string","format":"date-time","nullable":true},"toDate":{"type":"string","format":"date-time","nullable":true},"exceptFromDate":{"type":"string","format":"date-time","nullable":true},"exceptToDate":{"type":"string","format":"date-time","nullable":true},"analyzeTransfers":{"type":"boolean","nullable":true},"demandForecast":{"type":"number","format":"double","nullable":true},"calculatedDays":{"type":"integer","format":"int32","nullable":true},"calculatedStock":{"type":"number","format":"double","nullable":true},"calculatedDate":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"CreateDimensionAttributeEquivalenceRequest":{"type":"object","properties":{"equivalenceCorrelationId":{"type":"string","description":"CorrelationId of the equivalence.","format":"uuid"},"value":{"type":"string","description":"Value of the equivalence.","nullable":true}},"additionalProperties":false,"description":"Request to create an attribute equivalence value for a dimension."},"CreateDimensionAttributeRequest":{"type":"object","properties":{"name":{"type":"string","description":"Name of the attribute.","nullable":true},"sortIndex":{"type":"integer","description":"Sort index of the attribute (optional).","format":"int32","nullable":true},"equivalenceValues":{"type":"array","items":{"$ref":"#/components/schemas/CreateDimensionAttributeEquivalenceRequest"},"description":"List of equivalence values for the attribute.","nullable":true}},"additionalProperties":false,"description":"Request to create a dimension attribute."},"CreateDimensionEquivalenceRequest":{"type":"object","properties":{"name":{"type":"string","description":"Name of the equivalence.","nullable":true}},"additionalProperties":false,"description":"Request to create a dimension equivalence."},"CreateDimensionRequest":{"required":["code","description","shortDescription"],"type":"object","properties":{"code":{"type":"string","description":"Unique code of the dimension.","nullable":true},"description":{"type":"string","description":"Full description of the dimension.","nullable":true},"shortDescription":{"type":"string","description":"Short description of the dimension.","nullable":true}},"additionalProperties":false,"description":"Request to create a new dimension."},"CreateOrUpdateReorderPointRequest":{"type":"object","properties":{"leadTime":{"type":"integer","description":"<b>\r\n  <i>*Required:</i>\r\n</b>Estimated time it takes for a supplier to deliver the ordered products to the warehouse","format":"int32","nullable":true},"safetyStock":{"type":"number","description":"<b>\r\n  <i>*Required:</i>\r\n</b> Extra inventory kept in the warehouse to handle unforeseen events","format":"double","nullable":true},"unitsReorderPoint":{"type":"number","description":"<b>\r\n  <i>*Required:</i>\r\n</b>The point at which the company should place a new stock order with its suppliers","format":"double","nullable":true},"detail":{"$ref":"#/components/schemas/ReorderPointDetailDto"},"maximumStock":{"type":"number","description":"<b>\r\n  <i>*Optional:</i>\r\n</b>The maximum stock allowed in the warehouse","format":"double","nullable":true}},"additionalProperties":false,"description":"Body model to set a reorder point in stock for an existing product in a warehouse"},"CreateOrUpdateReorderPointResult":{"type":"object","properties":{"issues":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"nullable":true},"leadTime":{"type":"integer","format":"int32"},"safetyStock":{"type":"number","format":"double"},"unitsReorderPoint":{"type":"number","format":"double"},"correlationId":{"type":"string","format":"uuid"}},"additionalProperties":false},"CreateOrUpdateWarehouseAddressDto":{"type":"object","properties":{"countryCode":{"type":"string","nullable":true},"town":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"provinceDescription":{"type":"string","nullable":true},"zipCode":{"type":"string","nullable":true},"provinceCode":{"type":"string","nullable":true}},"additionalProperties":false},"CreateRegularizationLineRequest":{"type":"object","properties":{"productId":{"type":"string","description":"<b>\r\n  <i>*Required:</i>\r\n</b> Unique identifier of the product involved in the regularization.","format":"uuid","nullable":true},"units":{"type":"number","description":"<b>\r\n  <i>*Required:</i>\r\n</b> Quantity of units being regularized. Can be positive or negative.","format":"double","nullable":true},"purchasePrice":{"type":"number","description":"<b>\r\n  <i>*Required:</i>\r\n</b> Purchase price per unit of the product.","format":"double","nullable":true},"traceabilityDetails":{"type":"array","items":{"$ref":"#/components/schemas/CreateTraceabilityDetailRequest"},"description":"<b>\r\n  <i>*Optional:</i>\r\n</b> List of traceability details for the regularization line.","nullable":true}},"additionalProperties":false,"description":"Represents a line item for creating a stock regularization."},"CreateRegularizationRequest":{"type":"object","properties":{"reason":{"type":"string","description":"<b>\r\n  <i>*Required:</i>\r\n</b> Description of the reason for the regularization.","nullable":true},"warehouseId":{"type":"string","description":"<b>\r\n  <i>*Required:</i>\r\n</b> Unique identifier of the warehouse where the regularization will be performed.","format":"uuid","nullable":true},"date":{"type":"string","description":"<b>\r\n  <i>*Required:</i>\r\n</b> Date when the regularization takes place.","format":"date-time","nullable":true},"regularizationLines":{"type":"array","items":{"$ref":"#/components/schemas/CreateRegularizationLineRequest"},"description":"<b>\r\n  <i>*Required:</i>\r\n</b> List of lines that detail the regularization.","nullable":true}},"additionalProperties":false,"description":"Body model to create a new stock regularization."},"CreateRegularizationResult":{"type":"object","properties":{"issues":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"nullable":true},"correlationId":{"type":"string","format":"uuid"}},"additionalProperties":false},"CreateTraceabilityDetailRequest":{"type":"object","properties":{"batch":{"type":"string","description":"<b>\r\n  <i>*Optional:</i>\r\n</b> Batch number of the product in the line item.","nullable":true},"expirationDate":{"type":"string","description":"<b>\r\n  <i>*Optional:</i>\r\n</b> Expiration date of the product in the line item.","format":"date-time","nullable":true},"serialNumber":{"type":"string","description":"<b>\r\n  <i>*Optional:</i>\r\n</b> Serial number of the product in the line item.","nullable":true},"units":{"type":"number","description":"<b>\r\n  <i>*Optional:</i>\r\n</b> Number of units of the product in the line item.","format":"double","nullable":true},"entryDate":{"type":"string","description":"<b>\r\n  <i>*Optional:</i>\r\n</b> Entry date of the product in the line item.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Request body model for updating the traceability details of a line item."},"CreateTransferLineRequest":{"type":"object","properties":{"productId":{"type":"string","description":"<b>\r\n  <i>*Required:</i>\r\n</b>Unique identifier of the product to transfer","format":"uuid","nullable":true},"units":{"type":"number","description":"<b>\r\n  <i>*Required:</i>\r\n</b>Number of units to transfer of the current product","format":"double","nullable":true},"additionalUnitCost":{"type":"number","description":"<b>\r\n  <i>*Optional:</i>\r\n</b>Aditional cost per unit of the current product","format":"double","nullable":true},"traceabilityDetails":{"type":"array","items":{"$ref":"#/components/schemas/CreateTraceabilityDetailRequest"},"description":"<b>\r\n  <i>*Optional:</i>\r\n</b> List of traceability details for the transfer line.","nullable":true}},"additionalProperties":false,"description":"Body model of a line item for create a transfer."},"CreateTransferReceptionDiscardRequest":{"type":"object","properties":{"date":{"type":"string","description":"<b>\r\n  <i>*Required:</i>\r\n</b>Date of reception\r\n            \n<b>format: [yyyy-MM-dd hh:mm]</b>","format":"date-time","nullable":true},"reason":{"type":"string","description":"<b>\r\n  <i>*Optional:</i>\r\n</b>Reason why discard all pending items in the transfer to be received","nullable":true}},"additionalProperties":false,"description":"Body model to create a discard of a transfer"},"CreateTransferReceptionLineRequest":{"type":"object","properties":{"transferLineId":{"type":"string","description":"<b>\r\n  <i>*Required:</i>\r\n</b>Unique identifier for the line item to be received in the transfer","format":"uuid","nullable":true},"units":{"type":"number","description":"<b>\r\n  <i>*Required:</i>\r\n</b>Number of units to be received of the product in the transfer","format":"double","nullable":true},"receptionTraceabilityDetails":{"type":"array","items":{"$ref":"#/components/schemas/CreateTransferReceptionLineTraceabilityDetailRequest"},"description":"<b>\r\n  <i>*Optional:</i>\r\n</b> List of traceability details for the transfer reception line.","nullable":true}},"additionalProperties":false,"description":"Body model of a line item for create a transfer reception."},"CreateTransferReceptionLineTraceabilityDetailRequest":{"type":"object","properties":{"transferLineTraceabilityDetailId":{"type":"string","description":"<b>\r\n  <i>*Required:</i>\r\n</b>Unique identifier for the traceability detail line item to be received in the transfer","format":"uuid","nullable":true},"units":{"type":"number","description":"<b>\r\n  <i>*Required:</i>\r\n</b>Number of units to be received of the traceability detail of a product in the transfer","format":"double","nullable":true}},"additionalProperties":false,"description":"Body model of a traceability detail item for create a transfer reception line."},"CreateTransferReceptionRequest":{"type":"object","properties":{"date":{"type":"string","description":"<b>\r\n  <i>*Required:</i>\r\n</b>Date of reception\r\n            \n<b>format: [yyyy-MM-dd hh:mm]</b>","format":"date-time","nullable":true},"reason":{"type":"string","description":"<b>\r\n  <i>*Optional:</i>\r\n</b>Reason why discard all pending items in the transfer to be received","nullable":true},"transferReceptionLines":{"type":"array","items":{"$ref":"#/components/schemas/CreateTransferReceptionLineRequest"},"description":"<b>\r\n  <i>*Required:</i>\r\n</b>Detail lines of the reception","nullable":true}},"additionalProperties":false,"description":"Body model to create a reception of a transfer"},"CreateTransferReceptionResult":{"type":"object","properties":{"issues":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"nullable":true},"correlationId":{"type":"string","format":"uuid"}},"additionalProperties":false},"CreateTransferRequest":{"type":"object","properties":{"reason":{"type":"string","description":"<b>\r\n  <i>*Optional:</i>\r\n</b>Description of transfer","nullable":true},"date":{"type":"string","description":"<b>\r\n  <i>*Required:</i>\r\n</b>Date of the transfer\r\n            \n<b>format: [yyyy-MM-dd hh:mm]</b>","format":"date-time","nullable":true},"warehouseOriginId":{"type":"string","description":"<b>\r\n  <i>*Required:</i>\r\n</b>Unique identifier of the warehouse origin of the transfer","format":"uuid","nullable":true},"warehouseDestinationId":{"type":"string","description":"<b>\r\n  <i>*Required:</i>\r\n</b>Unique identifier of the warehouse destination of the transfer","format":"uuid","nullable":true},"carrierId":{"type":"string","description":"<b>\r\n  <i>*Optional:</i>\r\n</b>Unique identifier of the carrier of the transfer","nullable":true},"transferLines":{"type":"array","items":{"$ref":"#/components/schemas/CreateTransferLineRequest"},"description":"<b>\r\n  <i>*Required:</i>\r\n</b>Detail lines of the transfer","nullable":true}},"additionalProperties":false,"description":"Body model to create a transfer"},"CreateTransferResult":{"type":"object","properties":{"issues":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"nullable":true},"correlationId":{"type":"string","format":"uuid"}},"additionalProperties":false},"CreateWarehouseRequest":{"type":"object","properties":{"code":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"address":{"$ref":"#/components/schemas/CreateOrUpdateWarehouseAddressDto"},"phone":{"type":"string","nullable":true},"contactPerson":{"type":"string","nullable":true},"lowStockAlert":{"type":"boolean"},"allowNegativeStock":{"type":"boolean"}},"additionalProperties":false},"CurrentStockDetailMessage":{"type":"object","properties":{"batch":{"type":"string","nullable":true},"expirationDate":{"type":"string","format":"date-time","nullable":true},"serialNumber":{"type":"string","nullable":true},"entryDate":{"type":"string","format":"date-time","nullable":true},"stockUnits":{"type":"number","format":"double"},"assignedUnits":{"type":"number","format":"double","nullable":true}},"additionalProperties":false},"CustomProblemDetails":{"type":"object","properties":{"title":{"type":"string","description":"A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence\r\nof the problem, except for purposes of localization(e.g., using proactive content negotiation;","nullable":true},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem.","format":"int32","nullable":true},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem.","nullable":true},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","nullable":true},"extensions":{"type":"object","additionalProperties":{"nullable":true},"description":"Gets the Dictionary for extension members.\r\n\n\r\nIn case of multiple errors, the details of each error will be included inside the first element of the `Extensions` dictionary.\r\nThe key will be `\"errors\"` and the value will be an array containing all individual error descriptions.\r\n","nullable":true}},"additionalProperties":false,"description":"A machine-readable format for specifying errors in HTTP API responses."},"DeleteRegularizationResult":{"type":"object","properties":{"issues":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"nullable":true}},"additionalProperties":false},"DeleteTransferReceptionResult":{"type":"object","properties":{"issues":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"nullable":true}},"additionalProperties":false},"DeleteTransferResult":{"type":"object","properties":{"issues":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"nullable":true}},"additionalProperties":false},"ErrorMessage":{"type":"object","properties":{"type":{"type":"string","nullable":true},"message":{"type":"string","nullable":true}},"additionalProperties":false},"GetCurrentStockBySerialNumberResult":{"type":"object","properties":{"expirationDate":{"type":"string","format":"date-time","nullable":true},"entryDate":{"type":"string","format":"date-time","nullable":true},"stockUnits":{"type":"number","format":"double"},"warehouseId":{"type":"string","format":"uuid","nullable":true},"warehouseCode":{"type":"string","nullable":true}},"additionalProperties":false},"GetCurrentStockDetailAssignedUnitsResult":{"type":"object","properties":{"issues":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"nullable":true},"productId":{"type":"string","format":"uuid"},"warehouseId":{"type":"string","format":"uuid"},"currentStockDetails":{"type":"array","items":{"$ref":"#/components/schemas/CurrentStockDetailMessage"},"nullable":true}},"additionalProperties":false},"GetCurrentStockDetailResult":{"type":"object","properties":{"issues":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"nullable":true},"productId":{"type":"string","format":"uuid"},"warehouseId":{"type":"string","format":"uuid"},"stockUnits":{"type":"number","format":"double"},"currentStockDetails":{"type":"array","items":{"$ref":"#/components/schemas/CurrentStockDetailMessage"},"nullable":true}},"additionalProperties":false},"GetCurrentStockResult":{"type":"object","properties":{"expirationDate":{"type":"string","format":"date-time","nullable":true},"entryDate":{"type":"string","format":"date-time","nullable":true},"stockUnits":{"type":"number","format":"double"}},"additionalProperties":false},"GetDimensionAttributeEquivalenceValuesResult":{"type":"object","properties":{"correlationId":{"type":"string","description":"Correlation identifier for the equivalence value.","format":"uuid"},"equivalenceCorrelationId":{"type":"string","description":"Correlation identifier for the equivalence name.","format":"uuid"},"value":{"type":"string","description":"Value of the equivalence.","nullable":true}},"additionalProperties":false,"description":"Represents an equivalence value for a dimension attribute."},"GetDimensionAttributeResult":{"type":"object","properties":{"correlationId":{"type":"string","description":"Correlation identifier for the attribute.","format":"uuid"},"name":{"type":"string","description":"Name of the attribute.","nullable":true},"sortIndex":{"type":"integer","description":"Sort index of the attribute.","format":"int32"},"equivalenceValues":{"type":"array","items":{"$ref":"#/components/schemas/GetDimensionAttributeEquivalenceValuesResult"},"description":"List of equivalence values associated with the attribute.","nullable":true}},"additionalProperties":false,"description":"Represents an attribute response for a dimension, including possible equivalence values."},"GetDimensionAttributeResultPaginatedResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/GetDimensionAttributeResult"},"nullable":true},"pageNumber":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"pageSize":{"maximum":300,"minimum":1,"type":"integer","format":"int32"},"totalCount":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}},"additionalProperties":false},"GetDimensionEquivalenceResult":{"type":"object","properties":{"correlationId":{"type":"string","description":"Correlation identifier for the equivalence.","format":"uuid"},"name":{"type":"string","description":"Name of the equivalence.","nullable":true}},"additionalProperties":false,"description":"Represents an equivalence response for a dimension."},"GetDimensionEquivalencesResult":{"type":"object","properties":{"correlationId":{"type":"string","description":"Correlation identifier for the equivalence.","format":"uuid"},"name":{"type":"string","description":"Name of the equivalence.","nullable":true}},"additionalProperties":false,"description":"Represents an equivalence of a dimension."},"GetDimensionResponse":{"type":"object","properties":{"correlationId":{"type":"string","description":"Correlation identifier for tracking the request.","format":"uuid"},"code":{"type":"string","description":"Unique code of the dimension.","nullable":true},"description":{"type":"string","description":"Full description of the dimension.","nullable":true},"shortDescription":{"type":"string","description":"Short description of the dimension.","nullable":true},"equivalences":{"type":"array","items":{"$ref":"#/components/schemas/GetDimensionEquivalenceResult"},"description":"List of equivalence responses associated with the dimension.","nullable":true},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/GetDimensionAttributeResult"},"description":"List of attribute responses associated with the dimension.","nullable":true}},"additionalProperties":false,"description":"Represents the response model for retrieving a dimension, including its equivalences and attributes."},"GetDimensionsResponse":{"type":"object","properties":{"correlationId":{"type":"string","description":"Correlation identifier for the operation.","format":"uuid"},"code":{"type":"string","description":"Unique code of the dimension.","nullable":true},"description":{"type":"string","description":"Full description of the dimension.","nullable":true},"shortDescription":{"type":"string","description":"Short description of the dimension.","nullable":true},"equivalences":{"type":"array","items":{"$ref":"#/components/schemas/GetDimensionEquivalencesResult"},"description":"List of equivalences associated with the dimension.","nullable":true},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/GetDimensionAttributeResult"},"description":"List of attributes associated with the dimension.","nullable":true}},"additionalProperties":false,"description":"Represents the response for retrieving a dimension, including associated equivalences and attributes."},"GetDimensionsResponsePaginatedResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/GetDimensionsResponse"},"nullable":true},"pageNumber":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"pageSize":{"maximum":300,"minimum":1,"type":"integer","format":"int32"},"totalCount":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}},"additionalProperties":false},"GetInventoryLinesResult":{"type":"object","properties":{"productId":{"type":"integer","format":"int32"},"productCorrelationId":{"type":"string","format":"uuid"},"productDescription":{"type":"string","nullable":true},"productCode":{"type":"string","nullable":true},"stockUnits":{"type":"number","format":"double"},"unitValuation":{"type":"number","format":"double"},"stockValuation":{"type":"number","format":"double"},"providedUnits":{"type":"number","format":"double"},"valuationCriteria":{"type":"string","nullable":true},"warehouseCorrelationId":{"type":"string","format":"uuid"},"warehouseCode":{"type":"string","nullable":true},"warehouseDescription":{"type":"string","nullable":true},"operationDate":{"type":"string","format":"date-time"}},"additionalProperties":false},"GetMovementsResult":{"type":"object","properties":{"operationType":{"type":"string","nullable":true},"operationId":{"type":"string","nullable":true},"operationDate":{"type":"string","format":"date-time","nullable":true},"operationName":{"type":"string","nullable":true},"operationNumber":{"type":"string","nullable":true},"operationDescription":{"type":"string","nullable":true},"inUnits":{"type":"number","format":"double","nullable":true},"outUnits":{"type":"number","format":"double","nullable":true},"unitsStock":{"type":"number","format":"double","nullable":true},"cost":{"type":"number","format":"double","nullable":true},"thirdParty":{"type":"string","nullable":true},"price":{"type":"number","format":"double","nullable":true},"batch":{"type":"string","nullable":true},"serialNumber":{"type":"string","nullable":true},"expirationDate":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"GetMovementsResultPaginatedResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/GetMovementsResult"},"nullable":true},"pageNumber":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"pageSize":{"maximum":300,"minimum":1,"type":"integer","format":"int32"},"totalCount":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}},"additionalProperties":false},"GetNewWarehouseQueryResult":{"type":"object","properties":{"correlationId":{"type":"string","format":"uuid"},"code":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"address":{"$ref":"#/components/schemas/AddressDto"},"phone":{"type":"string","nullable":true},"contactPerson":{"type":"string","nullable":true},"lowStockAlert":{"type":"boolean"},"allowNegativeStock":{"type":"boolean"},"isDefault":{"type":"boolean"}},"additionalProperties":false},"GetProductsReorderPointResult":{"type":"object","properties":{"productId":{"type":"string","nullable":true},"productCode":{"type":"string","nullable":true},"productDescription":{"type":"string","nullable":true},"leadTime":{"type":"integer","format":"int32","nullable":true},"stockUnits":{"type":"number","format":"double"},"safetyStock":{"type":"number","format":"double","nullable":true},"unitsReorderPoint":{"type":"number","format":"double","nullable":true},"calculatedDateDetail":{"type":"string","format":"date-time","nullable":true},"updatedDate":{"type":"string","format":"date-time","nullable":true},"maximumStock":{"type":"number","format":"double"}},"additionalProperties":false},"GetProductsReorderPointResultPaginatedResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/GetProductsReorderPointResult"},"nullable":true},"pageNumber":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"pageSize":{"maximum":300,"minimum":1,"type":"integer","format":"int32"},"totalCount":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}},"additionalProperties":false},"GetRegularizationByIdResult":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"integer","format":"int32"},"reason":{"type":"string","nullable":true},"date":{"type":"string","format":"date-time"},"warehouseId":{"type":"string","format":"uuid"},"regularizationLines":{"type":"array","items":{"$ref":"#/components/schemas/RegularizationLineMessage"},"nullable":true}},"additionalProperties":false},"GetRegularizationsResult":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"integer","format":"int32"},"reason":{"type":"string","nullable":true},"date":{"type":"string","format":"date-time"},"warehouseId":{"type":"string","format":"uuid","nullable":true},"warehouseCode":{"type":"string","nullable":true},"warehouseDescription":{"type":"string","nullable":true}},"additionalProperties":false},"GetRegularizationsResultPaginatedResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/GetRegularizationsResult"},"nullable":true},"pageNumber":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"pageSize":{"maximum":300,"minimum":1,"type":"integer","format":"int32"},"totalCount":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}},"additionalProperties":false},"GetReorderPointByProductAndWarehouseResult":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"productId":{"type":"string","format":"uuid"},"productCode":{"type":"string","nullable":true},"productDescription":{"type":"string","nullable":true},"warehouseId":{"type":"string","format":"uuid"},"warehouseCode":{"type":"string","nullable":true},"warehouseDescription":{"type":"string","nullable":true},"leadTime":{"type":"integer","format":"int32"},"safetyStock":{"type":"number","format":"double"},"unitsReorderPoint":{"type":"number","format":"double"},"updatedDate":{"type":"string","format":"date-time"},"fromDate":{"type":"string","format":"date-time","nullable":true},"toDate":{"type":"string","format":"date-time","nullable":true},"exceptFromDate":{"type":"string","format":"date-time","nullable":true},"exceptToDate":{"type":"string","format":"date-time","nullable":true},"analyzeTransfers":{"type":"boolean","nullable":true},"leadTimeDetail":{"type":"integer","format":"int32","nullable":true},"safetyStockDetail":{"type":"number","format":"double","nullable":true},"unitsReorderPointDetail":{"type":"number","format":"double","nullable":true},"demandForecastDetail":{"type":"number","format":"double","nullable":true},"calculatedDaysDetail":{"type":"integer","format":"int32","nullable":true},"calculatedStockDetail":{"type":"number","format":"double","nullable":true},"calculatedDateDetail":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"GetStockProductByCriteriaValuationAndWarehouseQueryResult":{"type":"object","properties":{"productCorrelationId":{"type":"string","format":"uuid"},"warehouse":{"$ref":"#/components/schemas/WarehouseStockView"},"stockUnits":{"type":"number","format":"double"},"purchaseOrderReservationUnits":{"type":"number","format":"double"},"saleOrderReservationUnits":{"type":"number","format":"double"},"providedUnits":{"type":"number","format":"double"},"unitValuation":{"type":"number","format":"double"},"stockValuation":{"type":"number","format":"double"},"maximumStock":{"type":"number","format":"double"}},"additionalProperties":false},"GetStockProductByCriteriaValuationQueryResult":{"type":"object","properties":{"productCorrelationId":{"type":"string","format":"uuid"},"warehouse":{"$ref":"#/components/schemas/WarehouseStockView"},"stockUnits":{"type":"number","format":"double"},"purchaseOrderReservationUnits":{"type":"number","format":"double"},"saleOrderReservationUnits":{"type":"number","format":"double"},"providedUnits":{"type":"number","format":"double"},"unitValuation":{"type":"number","format":"double"},"stockValuation":{"type":"number","format":"double"},"stockInTransit":{"type":"number","format":"double"},"leadTime":{"type":"integer","format":"int32"},"safetyStock":{"type":"number","format":"double"},"unitsReorderPoint":{"type":"number","format":"double"},"maximumStock":{"type":"number","format":"double"}},"additionalProperties":false},"GetTransferByIdResult":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"integer","format":"int32"},"reason":{"type":"string","nullable":true},"date":{"type":"string","format":"date-time"},"state":{"type":"integer","format":"int32","nullable":true},"warehouseOriginId":{"type":"string","format":"uuid"},"warehouseDestinationId":{"type":"string","format":"uuid"},"carrierId":{"type":"string","nullable":true},"transferLines":{"type":"array","items":{"$ref":"#/components/schemas/TransferLineMessageResult"},"nullable":true}},"additionalProperties":false},"GetTransferReceptionByIdResult":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"date":{"type":"string","format":"date-time"},"receptionType":{"$ref":"#/components/schemas/ReceptionType"},"transferReceptionLines":{"type":"array","items":{"$ref":"#/components/schemas/TransferReceptionLineMessage"},"nullable":true}},"additionalProperties":false},"GetTransferReceptionsByIdResult":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"date":{"type":"string","format":"date-time"},"receptionType":{"$ref":"#/components/schemas/ReceptionType"}},"additionalProperties":false},"GetTransfersResult":{"type":"object","properties":{"state":{"type":"integer","format":"int32","nullable":true},"id":{"type":"string","format":"uuid"},"number":{"type":"integer","format":"int32"},"reason":{"type":"string","nullable":true},"date":{"type":"string","format":"date-time"},"warehouseOriginId":{"type":"string","format":"uuid","nullable":true},"warehouseOriginCode":{"type":"string","nullable":true},"warehouseOriginDescription":{"type":"string","nullable":true},"warehouseDestinationId":{"type":"string","format":"uuid","nullable":true},"warehouseDestinationCode":{"type":"string","nullable":true},"warehouseDestinationDescription":{"type":"string","nullable":true},"carrierId":{"type":"string","nullable":true},"carrierDescription":{"type":"string","nullable":true}},"additionalProperties":false},"GetTransfersResultPaginatedResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/GetTransfersResult"},"nullable":true},"pageNumber":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"pageSize":{"maximum":300,"minimum":1,"type":"integer","format":"int32"},"totalCount":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}},"additionalProperties":false},"GetVariantsStockAttributesQueryResponse":{"type":"object","properties":{"dimensionId":{"type":"string","description":"The unique identifier of the dimension.","format":"uuid"},"shortDescriptionDimension":{"type":"string","description":"The short description of the dimension.","nullable":true},"attributeId":{"type":"string","description":"The unique identifier of the attribute.","format":"uuid"},"nameAttribute":{"type":"string","description":"The name of the attribute.","nullable":true}},"additionalProperties":false,"description":"Represents the attributes (dimension and attribute) of a product variant."},"GetVariantsStockInformationQueryResponse":{"type":"object","properties":{"variants":{"type":"array","items":{"$ref":"#/components/schemas/GetVariantsStockQueryResponse"},"description":"The list of stock information for each product variant.","nullable":true},"summary":{"$ref":"#/components/schemas/StockVariantInformationSummaryResponse"}},"additionalProperties":false,"description":"Represents the response containing the stock information for all variants of a product,\r\nincluding a list of variant details and a summary."},"GetVariantsStockQueryResponse":{"type":"object","properties":{"productCorrelationId":{"type":"string","description":"The unique identifier of the product variant.","format":"uuid"},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/GetVariantsStockAttributesQueryResponse"},"description":"The list of attributes (dimensions) that define this variant.","nullable":true},"stockUnits":{"type":"number","description":"The number of units in stock for this variant.","format":"double"},"purchaseOrderReservationUnits":{"type":"number","description":"The number of units reserved for purchase orders.","format":"double"},"saleOrderReservationUnits":{"type":"number","description":"The number of units reserved for sales orders.","format":"double"},"providedUnits":{"type":"number","description":"The number of units provided (supplied).","format":"double"},"stockInTransit":{"type":"number","description":"The number of units in transit for this variant.","format":"double"}},"additionalProperties":false,"description":"Represents the stock information for a single product variant."},"GetWarehouseByIdResult":{"type":"object","properties":{"correlationId":{"type":"string","format":"uuid"},"code":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"address":{"$ref":"#/components/schemas/AddressDto"},"phone":{"type":"string","nullable":true},"contactPerson":{"type":"string","nullable":true},"lowStockAlert":{"type":"boolean","nullable":true},"allowNegativeStock":{"type":"boolean","nullable":true},"isDefault":{"type":"boolean","nullable":true},"isTransit":{"type":"boolean","nullable":true},"isDisabled":{"type":"boolean","nullable":true}},"additionalProperties":false},"GetWarehouseStockQueryResult":{"type":"object","properties":{"warehouseStockDtos":{"type":"array","items":{"$ref":"#/components/schemas/WarehouseStockDto"},"nullable":true}},"additionalProperties":false},"GetWarehousesQueryResult":{"type":"object","properties":{"correlationId":{"type":"string","format":"uuid"},"code":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"address":{"$ref":"#/components/schemas/AddressDto"},"phone":{"type":"string","nullable":true},"contactPerson":{"type":"string","nullable":true},"lowStockAlert":{"type":"boolean","nullable":true},"allowNegativeStock":{"type":"boolean","nullable":true},"isDefault":{"type":"boolean","nullable":true}},"additionalProperties":false},"GetWarehousesQueryResultPaginatedResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/GetWarehousesQueryResult"},"nullable":true},"pageNumber":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"pageSize":{"maximum":300,"minimum":1,"type":"integer","format":"int32"},"totalCount":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}},"additionalProperties":false},"OperationType":{"enum":[0,1,2,3,4,5,6,7,8,9],"type":"integer","format":"int32"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"ReceptionType":{"enum":[0,1],"type":"integer","format":"int32"},"RegularizationLineMessage":{"type":"object","properties":{"id":{"type":"string","format":"uuid","nullable":true},"productId":{"type":"string","format":"uuid","nullable":true},"units":{"type":"number","format":"double"},"valuationCriteria":{"type":"string","nullable":true,"readOnly":true},"purchasePrice":{"type":"number","format":"double"},"traceabilityDetails":{"type":"array","items":{"$ref":"#/components/schemas/TraceabilityDetailMessage"},"nullable":true}},"additionalProperties":false},"ReorderPointDetailDto":{"type":"object","properties":{"leadTime":{"type":"integer","format":"int32"},"safetyStock":{"type":"number","format":"double"},"unitsReorderPoint":{"type":"number","format":"double"},"fromDate":{"type":"string","format":"date-time","nullable":true},"toDate":{"type":"string","format":"date-time","nullable":true},"exceptFromDate":{"type":"string","format":"date-time","nullable":true},"exceptToDate":{"type":"string","format":"date-time","nullable":true},"analyzeTransfers":{"type":"boolean","nullable":true},"demandForecast":{"type":"number","format":"double","nullable":true},"calculatedDays":{"type":"integer","format":"int32","nullable":true},"calculatedStock":{"type":"number","format":"double","nullable":true}},"additionalProperties":false},"ReorderPointType":{"enum":[1,2,3],"type":"integer","format":"int32"},"ResultMessage":{"type":"object","properties":{"issues":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"nullable":true},"success":{"type":"boolean"},"result":{"nullable":true}},"additionalProperties":false},"StockVariantInformationSummaryResponse":{"type":"object","properties":{"stockUnits":{"type":"number","description":"The total number of units in stock for all variants.","format":"double"},"purchaseOrderReservationUnits":{"type":"number","description":"The total number of units reserved for purchase orders across all variants.","format":"double"},"saleOrderReservationUnits":{"type":"number","description":"The total number of units reserved for sales orders across all variants.","format":"double"},"stockInTransit":{"type":"number","description":"The total number of units in transit for all variants.","format":"double"},"providedUnits":{"type":"number","description":"The total number of units provided (supplied) for all variants.","format":"double"}},"additionalProperties":false,"description":"Represents the summary information for the stock of all product variants,\r\nincluding total units, reservations, and units in transit or provided."},"TraceabilityDetailMessage":{"type":"object","properties":{"id":{"type":"string","format":"uuid","nullable":true},"batch":{"type":"string","nullable":true},"expirationDate":{"type":"string","format":"date-time","nullable":true},"serialNumber":{"type":"string","nullable":true},"units":{"type":"number","format":"double","nullable":true},"entryDate":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"TransferLineMessageResult":{"type":"object","properties":{"id":{"type":"string","format":"uuid","nullable":true},"productId":{"type":"string","format":"uuid","nullable":true},"units":{"type":"number","format":"double"},"additionalUnitCost":{"type":"number","format":"double"},"traceabilityDetails":{"type":"array","items":{"$ref":"#/components/schemas/TransferTraceabilityDetailMessage"},"nullable":true},"unitsReceived":{"type":"number","format":"double"},"unitsDiscarded":{"type":"number","format":"double"}},"additionalProperties":false},"TransferReceptionLineMessage":{"type":"object","properties":{"transferLineId":{"type":"string","format":"uuid","nullable":true},"units":{"type":"number","format":"double"},"receptionTraceabilityDetails":{"type":"array","items":{"$ref":"#/components/schemas/TransferReceptionLineTraceabilityDetailMessage"},"nullable":true}},"additionalProperties":false},"TransferReceptionLineTraceabilityDetailMessage":{"type":"object","properties":{"transferLineTraceabilityDetailId":{"type":"string","format":"uuid","nullable":true},"units":{"type":"number","format":"double"}},"additionalProperties":false},"TransferTraceabilityDetailMessage":{"type":"object","properties":{"id":{"type":"string","format":"uuid","nullable":true},"batch":{"type":"string","nullable":true},"expirationDate":{"type":"string","format":"date-time","nullable":true},"serialNumber":{"type":"string","nullable":true},"units":{"type":"number","format":"double","nullable":true},"entryDate":{"type":"string","format":"date-time","nullable":true},"unitsReceived":{"type":"number","format":"double","nullable":true},"unitsDiscarded":{"type":"number","format":"double","nullable":true}},"additionalProperties":false},"UpdateDimensionAttributeEquivalenceRequest":{"type":"object","properties":{"correlationId":{"type":"string","description":"Correlation id.","format":"uuid","nullable":true},"equivalenceCorrelationId":{"type":"string","description":"Correlation id of the equivalence.","format":"uuid"},"value":{"type":"string","description":"Value of the equivalence.","nullable":true}},"additionalProperties":false,"description":"Request to update an attribute equivalence value for a dimension."},"UpdateDimensionAttributeRequest":{"type":"object","properties":{"name":{"type":"string","description":"Name of the attribute.","nullable":true},"sortIndex":{"type":"integer","description":"Sort index of the attribute (optional).","format":"int32","nullable":true},"equivalenceValues":{"type":"array","items":{"$ref":"#/components/schemas/UpdateDimensionAttributeEquivalenceRequest"},"description":"List of equivalence values for the attribute.","nullable":true}},"additionalProperties":false,"description":"Request to update a dimension attribute."},"UpdateDimensionEquivalenceRequest":{"type":"object","properties":{"name":{"type":"string","description":"Name of the equivalence.","nullable":true}},"additionalProperties":false,"description":"Request to update a dimension equivalence."},"UpdateDimensionRequest":{"required":["description","shortDescription"],"type":"object","properties":{"description":{"type":"string","description":"Full description of the dimension.","nullable":true},"shortDescription":{"type":"string","description":"Short description of the dimension.","nullable":true}},"additionalProperties":false,"description":"Request to update a dimension."},"UpdateDisabledWarehouseResult":{"type":"object","properties":{"issues":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"nullable":true}},"additionalProperties":false},"UpdateRegularizationLineRequest":{"type":"object","properties":{"id":{"type":"string","description":"<b>\r\n  <i>*Optional:</i>\r\n</b> Unique identifier of the regularization line. Used for updates.","format":"uuid","nullable":true},"productId":{"type":"string","description":"<b>\r\n  <i>*Required:</i>\r\n</b> Unique identifier of the product involved in the regularization.","format":"uuid","nullable":true},"units":{"type":"number","description":"<b>\r\n  <i>*Required:</i>\r\n</b> Quantity of units being regularized. Can be positive or negative.","format":"double","nullable":true},"purchasePrice":{"type":"number","description":"<b>\r\n  <i>*Required:</i>\r\n</b> Purchase price per unit of the product.","format":"double","nullable":true},"traceabilityDetails":{"type":"array","items":{"$ref":"#/components/schemas/UpdateTraceabilityDetailRequest"},"description":"<b>\r\n  <i>*Optional:</i>\r\n</b> List of traceability details for the regularization line.","nullable":true}},"additionalProperties":false,"description":"Represents a line item for updating a stock regularization."},"UpdateRegularizationRequest":{"type":"object","properties":{"reason":{"type":"string","description":"<b>\r\n  <i>*Required:</i>\r\n</b> Description of the reason for the regularization update.","nullable":true},"warehouseId":{"type":"string","description":"<b>\r\n  <i>*Required:</i>\r\n</b> Unique identifier of the warehouse where the regularization is updated.","format":"uuid","nullable":true},"regularizationLines":{"type":"array","items":{"$ref":"#/components/schemas/UpdateRegularizationLineRequest"},"description":"<b>\r\n  <i>*Required:</i>\r\n</b> Updated list of lines that detail the regularization.","nullable":true}},"additionalProperties":false,"description":"Body model to update an existing stock regularization."},"UpdateRegularizationResult":{"type":"object","properties":{"issues":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"nullable":true}},"additionalProperties":false},"UpdateTraceabilityDetailRequest":{"type":"object","properties":{"id":{"type":"string","description":"<b>\r\n  <i>*Required:</i>\r\n</b> Unique identifier of the line item.","format":"uuid","nullable":true},"batch":{"type":"string","description":"<b>\r\n  <i>*Optional:</i>\r\n</b> Batch of the product in the line item.","nullable":true},"expirationDate":{"type":"string","description":"<b>\r\n  <i>*Optional:</i>\r\n</b> Expiration date of the product in the line item.","format":"date-time","nullable":true},"serialNumber":{"type":"string","description":"<b>\r\n  <i>*Optional:</i>\r\n</b> Serial number of the product in the line item.","nullable":true},"units":{"type":"number","description":"<b>\r\n  <i>*Optional:</i>\r\n</b> Number of units of the product in the line item.","format":"double","nullable":true},"entryDate":{"type":"string","description":"<b>\r\n  <i>*Optional:</i>\r\n</b> Entry date of the product in the line item.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Request body model for updating the traceability details of a line item."},"UpdateTransferLineRequest":{"type":"object","properties":{"id":{"type":"string","description":"<b>\r\n  <i>*Optional:</i>\r\n</b>Unique identifier of the line","format":"uuid","nullable":true},"productId":{"type":"string","description":"<b>\r\n  <i>*Required:</i>\r\n</b>Unique identifier of the product to transfer","format":"uuid","nullable":true},"units":{"type":"number","description":"<b>\r\n  <i>*Required:</i>\r\n</b>Number of units to transfer of the current product","format":"double","nullable":true},"additionalUnitCost":{"type":"number","description":"<b>\r\n  <i>*Optional:</i>\r\n</b>Aditional cost per unit of the current product","format":"double","nullable":true},"traceabilityDetails":{"type":"array","items":{"$ref":"#/components/schemas/UpdateTraceabilityDetailRequest"},"description":"<b>\r\n  <i>*Optional:</i>\r\n</b> List of traceability details for the transfer line.","nullable":true}},"additionalProperties":false,"description":"Body model of a line item for update a transfer."},"UpdateTransferRequest":{"type":"object","properties":{"reason":{"type":"string","description":"<b>\r\n  <i>*Optional:</i>\r\n</b>Description of the transfer","nullable":true},"warehouseOriginId":{"type":"string","description":"<b>\r\n  <i>*Required:</i>\r\n</b>Unique identifier of the warehouse origin of the transfer","format":"uuid","nullable":true},"warehouseDestinationId":{"type":"string","description":"<b>\r\n  <i>*Required:</i>\r\n</b>Unique identifier of the warehouse destination of the transfer","format":"uuid","nullable":true},"carrierId":{"type":"string","description":"<b>\r\n  <i>*Optional:</i>\r\n</b>Unique identifier of the carrier of the transfer","nullable":true},"transferLines":{"type":"array","items":{"$ref":"#/components/schemas/UpdateTransferLineRequest"},"description":"<b>\r\n  <i>*Required:</i>\r\n</b>Detail lines of the transfer","nullable":true}},"additionalProperties":false,"description":"Body model to update an existing transfer"},"UpdateTransferResult":{"type":"object","properties":{"issues":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"nullable":true}},"additionalProperties":false},"UpdateWarehouseRequest":{"type":"object","properties":{"code":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"address":{"$ref":"#/components/schemas/CreateOrUpdateWarehouseAddressDto"},"phone":{"type":"string","nullable":true},"contactPerson":{"type":"string","nullable":true},"lowStockAlert":{"type":"boolean"},"allowNegativeStock":{"type":"boolean"}},"additionalProperties":false},"WarehouseStockDto":{"type":"object","properties":{"productId":{"type":"integer","format":"int32"},"productCorrelationId":{"type":"string","format":"uuid"},"productDescription":{"type":"string","nullable":true},"productCode":{"type":"string","nullable":true},"stockUnits":{"type":"number","format":"double"},"unitValuation":{"type":"number","format":"double"},"stockValuation":{"type":"number","format":"double","readOnly":true},"providedUnits":{"type":"number","format":"double"},"valuationCriteria":{"type":"string","nullable":true},"warehouseCorrelationId":{"type":"string","format":"uuid"},"warehouseCode":{"type":"string","nullable":true},"warehouseDescription":{"type":"string","nullable":true},"leadTime":{"type":"number","format":"double"},"safetyStock":{"type":"number","format":"double"},"unitsReorderPoint":{"type":"number","format":"double"}},"additionalProperties":false},"WarehouseStockView":{"type":"object","properties":{"correlationId":{"type":"string","format":"uuid"},"warehouseCode":{"type":"string","nullable":true},"warehouseDescription":{"type":"string","nullable":true},"isDefaultWarehouse":{"type":"boolean"}},"additionalProperties":false}},"securitySchemes":{"apiKeyHeader":{"type":"apiKey","name":"Ocp-Apim-Subscription-Key","in":"header"},"apiKeyQuery":{"type":"apiKey","name":"subscription-key","in":"query"}}},"security":[{"apiKeyHeader":[]},{"apiKeyQuery":[]}]},"markdown":null,"status":"publicado","published_at":"2025-09-12T10:52:54.000Z","created_at":"2025-09-12T10:52:49.000Z","updated_at":"2026-06-29T11:35:12.000Z","buttons":[{"id":20,"name":"Consulta la definición de la API","type":"secondary","order":0,"link":"https://wke-portal-pre.apimarket.io/apis/a3factura-services-api-2-0/swagger-ui","class":"secondary"}],"benefits":[],"tags":[],"image":[{"id":1,"name":"wk-api-a3factura.png","alternativeText":"","caption":"","width":593,"height":432,"formats":{"thumbnail":{"name":"thumbnail_wk-api-a3factura.png","hash":"thumbnail_wk_api_a3factura_7b8dad77be","ext":".png","mime":"image/png","width":214,"height":156,"size":15.53,"path":null,"url":"https://wke-portal.apimarket.io/assets/thumbnail_wk_api_a3factura_7b8dad77be.png"},"small":{"name":"small_wk-api-a3factura.png","hash":"small_wk_api_a3factura_7b8dad77be","ext":".png","mime":"image/png","width":500,"height":364,"size":65.43,"path":null,"url":"https://wke-portal.apimarket.io/assets/small_wk_api_a3factura_7b8dad77be.png"}},"hash":"wk_api_a3factura_7b8dad77be","ext":".png","mime":"image/png","size":71.75,"url":"https://wke-portal.apimarket.io/assets/wk_api_a3factura_7b8dad77be.png","previewUrl":null,"provider":"aws-s3-use-cdn","provider_metadata":null,"created_at":"2023-06-23T03:28:33.000Z","updated_at":"2023-06-23T03:28:36.000Z"}],"products":[]},{"id":8,"title":"API a3innuva ERP - Logistics","slug":"a3factura-logistics","description":null,"color_status":null,"footerText":null,"version":null,"openDoc":{"openapi":"3.0.4","info":{"title":"API a3innuva ERP - Logistics","description":"API a3innuva ERP - Logistics","termsOfService":"https://a3developers.wolterskluwer.es/user/terms","contact":{"name":"Wolters Kluwer TAA a3developers","url":"https://a3developers.wolterskluwer.es","email":"a3developers@wolterskluwer.com"},"license":{"name":"Terms of Use","url":"https://a3developers.wolterskluwer.es/user/terms"},"version":"v1"},"servers":[{"url":"https://a3api.wolterskluwer.es/a3factura-logistics","description":"PRO"}],"paths":{"/api/v1/carriers":{"post":{"tags":["Carriers"],"summary":"Creates a carrier with the supplied parameters.","description":"Creates a carrier with the supplied parameters.","operationId":"CreateCarrier","requestBody":{"description":"The carrier information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarrierDto"},"example":{"id":"string","name":"string","phone":"string","email":"string","address":{"countryCode":"string","zipCode":"string","town":"string","provinceDescription":"string","provinceCode":"string","street":"string"},"isEnabled":true}},"text/json":{"schema":{"$ref":"#/components/schemas/CarrierDto"},"example":{"id":"string","name":"string","phone":"string","email":"string","address":{"countryCode":"string","zipCode":"string","town":"string","provinceDescription":"string","provinceCode":"string","street":"string"},"isEnabled":true}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CarrierDto"},"example":{"id":"string","name":"string","phone":"string","email":"string","address":{"countryCode":"string","zipCode":"string","town":"string","provinceDescription":"string","provinceCode":"string","street":"string"},"isEnabled":true}}}},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"User not authenticated."},"403":{"description":"User not authorized to perform this action."}}},"get":{"tags":["Carriers"],"summary":"Gets all the Carriers found using the search and pagination criteria.","description":"Gets all the Carriers found using the search and pagination criteria.","operationId":"GetAllCarriers","parameters":[{"name":"PageNumber","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"PageSize","in":"query","schema":{"maximum":300,"minimum":1,"type":"integer","format":"int32"}},{"name":"SearchBy","in":"query","schema":{"type":"string"}},{"name":"Selection","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"IncludeDisabled","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CarrierDto"}},"examples":{"default":{"value":""}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CarrierDto"}},"example":[{"id":"string","name":"string","phone":"string","email":"string","address":{"countryCode":"string","zipCode":"string","town":"string","provinceDescription":"string","provinceCode":"string","street":"string"},"isEnabled":true}]}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"User not authenticated."},"403":{"description":"User not authorized to perform this action."}}}},"/api/v1/carriers/{id}":{"put":{"tags":["Carriers"],"summary":"Updates the carrier with the supplied information.","description":"Updates the carrier with the supplied information.","operationId":"UpdateCarrier","parameters":[{"name":"id","in":"path","description":"The id if the carrier.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"The info of the carrier to update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarrierDto"},"example":{"id":"string","name":"string","phone":"string","email":"string","address":{"countryCode":"string","zipCode":"string","town":"string","provinceDescription":"string","provinceCode":"string","street":"string"},"isEnabled":true}},"text/json":{"schema":{"$ref":"#/components/schemas/CarrierDto"},"example":{"id":"string","name":"string","phone":"string","email":"string","address":{"countryCode":"string","zipCode":"string","town":"string","provinceDescription":"string","provinceCode":"string","street":"string"},"isEnabled":true}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CarrierDto"},"example":{"id":"string","name":"string","phone":"string","email":"string","address":{"countryCode":"string","zipCode":"string","town":"string","provinceDescription":"string","provinceCode":"string","street":"string"},"isEnabled":true}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"User not authenticated."},"403":{"description":"User not authorized to perform this action."},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"get":{"tags":["Carriers"],"summary":"Gets the carrier with the id supplied.","description":"Gets the carrier with the id supplied.","operationId":"GetCarrier","parameters":[{"name":"id","in":"path","description":"The Id of the carrier.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CarrierDto"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/CarrierDto"},"example":{"id":"string","name":"string","phone":"string","email":"string","address":{"countryCode":"string","zipCode":"string","town":"string","provinceDescription":"string","provinceCode":"string","street":"string"},"isEnabled":true}}}},"401":{"description":"User not authenticated."},"403":{"description":"User not authorized to perform this action."},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/api/v1/carriers/{id}/isDisabled":{"put":{"tags":["Carriers"],"summary":"Disables or enables the provided carrier.","description":"Disables or enables the provided carrier.","operationId":"DisableCarrier","parameters":[{"name":"id","in":"path","description":"Id of the Carrier.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Set as true if it needs to be disabled, false otherwise.","content":{"application/json":{"schema":{"type":"boolean"},"example":"True"},"text/json":{"schema":{"type":"boolean"},"example":"True"},"application/*+json":{"schema":{"type":"boolean"},"example":"True"}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"User not authenticated."},"403":{"description":"User not authorized to perform this action."},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"examples":{"default":{"value":""}}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}}},"components":{"schemas":{"AddressDto":{"type":"object","properties":{"countryCode":{"type":"string","nullable":true},"zipCode":{"type":"string","nullable":true},"town":{"type":"string","nullable":true},"provinceDescription":{"type":"string","nullable":true},"provinceCode":{"type":"string","nullable":true},"street":{"type":"string","nullable":true}},"additionalProperties":false},"CarrierDto":{"required":["name"],"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"maxLength":200,"minLength":1,"type":"string"},"phone":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"address":{"$ref":"#/components/schemas/AddressDto"},"isEnabled":{"type":"boolean","readOnly":true}},"additionalProperties":false},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}},"securitySchemes":{"apiKeyHeader":{"type":"apiKey","name":"Ocp-Apim-Subscription-Key","in":"header"},"apiKeyQuery":{"type":"apiKey","name":"subscription-key","in":"query"}}},"security":[{"apiKeyHeader":[]},{"apiKeyQuery":[]}]},"markdown":null,"status":"publicado","published_at":"2025-09-12T10:54:24.000Z","created_at":"2025-09-12T10:54:19.000Z","updated_at":"2026-06-29T11:36:11.000Z","buttons":[{"id":21,"name":"Consulta la definición de la API","type":"secondary","order":0,"link":"https://wke-portal-pre.apimarket.io/apis/a3factura-services-api-2-0/swagger-ui","class":"secondary"}],"benefits":[],"tags":[],"image":[{"id":1,"name":"wk-api-a3factura.png","alternativeText":"","caption":"","width":593,"height":432,"formats":{"thumbnail":{"name":"thumbnail_wk-api-a3factura.png","hash":"thumbnail_wk_api_a3factura_7b8dad77be","ext":".png","mime":"image/png","width":214,"height":156,"size":15.53,"path":null,"url":"https://wke-portal.apimarket.io/assets/thumbnail_wk_api_a3factura_7b8dad77be.png"},"small":{"name":"small_wk-api-a3factura.png","hash":"small_wk_api_a3factura_7b8dad77be","ext":".png","mime":"image/png","width":500,"height":364,"size":65.43,"path":null,"url":"https://wke-portal.apimarket.io/assets/small_wk_api_a3factura_7b8dad77be.png"}},"hash":"wk_api_a3factura_7b8dad77be","ext":".png","mime":"image/png","size":71.75,"url":"https://wke-portal.apimarket.io/assets/wk_api_a3factura_7b8dad77be.png","previewUrl":null,"provider":"aws-s3-use-cdn","provider_metadata":null,"created_at":"2023-06-23T03:28:33.000Z","updated_at":"2023-06-23T03:28:36.000Z"}],"products":[]}]