{
"openapi": "3.1.0",
"info": {
"title": "A-Cube API Italy",
"description": "",
"version": "1.22.5"
},
"servers": [
{
"url": "https://api.acubeapi.com",
"description": "Production environment",
"x-production": "hide"
},
{
"url": "https://api-sandbox.acubeapi.com",
"description": "Sandbox environment"
}
],
"paths": {
"/ade-appointees": {
"post": {
"operationId": "create_ade_appointee",
"tags": [
"AdeAppointee"
],
"responses": {
"201": {
"description": "AdeAppointee resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
},
"403": {
"description": "Forbidden"
}
},
"summary": "Create a new AdE Appointee",
"description": "Creates a AdeAppointee resource.",
"parameters": [],
"requestBody": {
"description": "The new AdeAppointee resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeInput.jsonld-write"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeInput-write"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeInput-write"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeInput-write"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeInput-write"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeInput-write"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeInput-write"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeInput-write"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeInput-write"
}
}
},
"required": true
},
"deprecated": false
}
},
"/ade-appointees/{appointee_fiscal_id}/assign": {
"post": {
"operationId": "assign_brc",
"tags": [
"AdeAppointee"
],
"responses": {
"204": {
"description": "OK"
},
"404": {
"description": "Not found"
},
"201": {
"description": "AdeAppointee resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
},
"403": {
"description": "Forbidden"
}
},
"summary": "Assign an Appointee to a Business Registry Configuration.",
"description": "Assign a Business Registry Configuration (BRC) to the Appointee.\nThe BRC must have the `receipts_enabled` flag set to `true`.\nThe company linked to the BRC must have completed the appointment on the Tax Authority web portal.",
"parameters": [
{
"name": "appointee_fiscal_id",
"in": "path",
"description": "The fiscal identifier of the appointee, or `A-CUBE` in order to use A-Cube's own appointee.",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"requestBody": {
"description": "The new AdeAppointee resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeAssignInput.jsonld-write"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeAssignInput-write"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeAssignInput-write"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeAssignInput-write"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeAssignInput-write"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeAssignInput-write"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeAssignInput-write"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeAssignInput-write"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeAssignInput-write"
}
}
},
"required": true
},
"deprecated": false
}
},
"/ade-appointees/{fiscal_id}/credentials/fisconline": {
"put": {
"operationId": "set_ade_credentials",
"tags": [
"AdeAppointee"
],
"responses": {
"204": {
"description": "OK"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"200": {
"description": "AdeAppointee resource updated",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Set new Agenzia delle Entrate credentials for the Appointee.",
"description": "Update the credentials to authenticate the Appointee into the Tax Authority portal (FiscOnline / Entratel)",
"parameters": [
{
"name": "appointee_fiscal_id",
"in": "path",
"description": "The fiscal identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "id",
"in": "path",
"description": "AdeAppointee identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"requestBody": {
"description": "The updated AdeAppointee resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeCredentialsInput.jsonld-write"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeCredentialsInput-write"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeCredentialsInput-write"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeCredentialsInput-write"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeCredentialsInput-write"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeCredentialsInput-write"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeCredentialsInput-write"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeCredentialsInput-write"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.AdeAppointeeCredentialsInput-write"
}
}
},
"required": true
},
"deprecated": false
}
},
"/ade-appointees/{id}": {
"get": {
"operationId": "api_ade-appointees_id_get",
"tags": [
"AdeAppointee"
],
"responses": {
"200": {
"description": "AdeAppointee resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/AdeAppointee-read"
}
}
}
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Retrieves a AdeAppointee resource.",
"description": "Retrieves an AdE Appointee by internal id",
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "integer"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/api-configurations": {
"get": {
"operationId": "api_api-configurations_get_collection",
"tags": [
"ApiConfiguration"
],
"responses": {
"200": {
"description": "ApiConfiguration collection",
"content": {
"application/ld+json": {
"schema": {
"type": "object",
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiConfiguration.jsonld-read"
}
},
"hydra:totalItems": {
"type": "integer",
"minimum": 0
},
"hydra:view": {
"type": "object",
"properties": {
"@id": {
"type": "string",
"format": "iri-reference"
},
"@type": {
"type": "string"
},
"hydra:first": {
"type": "string",
"format": "iri-reference"
},
"hydra:last": {
"type": "string",
"format": "iri-reference"
},
"hydra:previous": {
"type": "string",
"format": "iri-reference"
},
"hydra:next": {
"type": "string",
"format": "iri-reference"
}
},
"example": {
"@id": "string",
"type": "string",
"hydra:first": "string",
"hydra:last": "string",
"hydra:previous": "string",
"hydra:next": "string"
}
},
"hydra:search": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"hydra:template": {
"type": "string"
},
"hydra:variableRepresentation": {
"type": "string"
},
"hydra:mapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"variable": {
"type": "string"
},
"property": {
"type": [
"string",
"null"
]
},
"required": {
"type": "boolean"
}
}
}
}
}
}
},
"required": [
"hydra:member"
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiConfiguration-read"
}
}
}
}
}
},
"summary": "Retrieves the collection of ApiConfiguration resources.",
"description": "Retrieves the collection of ApiConfiguration resources.",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The collection page number",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 1
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "itemsPerPage",
"in": "query",
"description": "The number of items per page",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 30,
"minimum": 0,
"maximum": 30
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "business_registry_configurations.fiscal_id",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "business_registry_configurations.fiscal_id[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "target_url",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
},
"post": {
"operationId": "api_api-configurations_post",
"tags": [
"ApiConfiguration"
],
"responses": {
"201": {
"description": "ApiConfiguration resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/ApiConfiguration.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiConfiguration-read"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Creates a ApiConfiguration resource.",
"description": "Creates a ApiConfiguration resource.",
"parameters": [],
"requestBody": {
"description": "The new ApiConfiguration resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiConfiguration-write"
}
},
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/ApiConfiguration.jsonld-write"
}
}
},
"required": true
},
"deprecated": false
}
},
"/api-configurations/{uuid}": {
"get": {
"operationId": "api_api-configurations_uuid_get",
"tags": [
"ApiConfiguration"
],
"responses": {
"200": {
"description": "ApiConfiguration resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/ApiConfiguration.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiConfiguration-read"
}
}
}
},
"404": {
"description": "Resource not found"
}
},
"summary": "Retrieves a ApiConfiguration resource.",
"description": "Retrieves a ApiConfiguration resource.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "ApiConfiguration identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
},
"put": {
"operationId": "api_api-configurations_uuid_put",
"tags": [
"ApiConfiguration"
],
"responses": {
"200": {
"description": "ApiConfiguration resource updated",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/ApiConfiguration.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiConfiguration-read"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Replaces the ApiConfiguration resource.",
"description": "Replaces the ApiConfiguration resource.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "ApiConfiguration identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"requestBody": {
"description": "The updated ApiConfiguration resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/ApiConfiguration.jsonld-write"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiConfiguration-write"
}
}
},
"required": true
},
"deprecated": false
},
"delete": {
"operationId": "api_api-configurations_uuid_delete",
"tags": [
"ApiConfiguration"
],
"responses": {
"204": {
"description": "ApiConfiguration resource deleted"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Removes the ApiConfiguration resource.",
"description": "Removes the ApiConfiguration resource.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "ApiConfiguration identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/business-registries": {
"get": {
"operationId": "api_business-registries_get_collection",
"tags": [
"BusinessRegistry"
],
"responses": {
"200": {
"description": "BusinessRegistry collection",
"content": {
"application/ld+json": {
"schema": {
"type": "object",
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistry.jsonld-read"
}
},
"hydra:totalItems": {
"type": "integer",
"minimum": 0
},
"hydra:view": {
"type": "object",
"properties": {
"@id": {
"type": "string",
"format": "iri-reference"
},
"@type": {
"type": "string"
},
"hydra:first": {
"type": "string",
"format": "iri-reference"
},
"hydra:last": {
"type": "string",
"format": "iri-reference"
},
"hydra:previous": {
"type": "string",
"format": "iri-reference"
},
"hydra:next": {
"type": "string",
"format": "iri-reference"
}
},
"example": {
"@id": "string",
"type": "string",
"hydra:first": "string",
"hydra:last": "string",
"hydra:previous": "string",
"hydra:next": "string"
}
},
"hydra:search": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"hydra:template": {
"type": "string"
},
"hydra:variableRepresentation": {
"type": "string"
},
"hydra:mapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"variable": {
"type": "string"
},
"property": {
"type": [
"string",
"null"
]
},
"required": {
"type": "boolean"
}
}
}
}
}
}
},
"required": [
"hydra:member"
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
}
},
"text/html": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
}
},
"application/octet-stream": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
}
},
"application/pdf": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
}
},
"application/zip": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
}
}
}
}
},
"summary": "Retrieves the collection of BusinessRegistry resources.",
"description": "Retrieves the collection of BusinessRegistry resources.",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The collection page number",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 1
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "itemsPerPage",
"in": "query",
"description": "The number of items per page",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 30,
"minimum": 0,
"maximum": 100
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "simpleSearch",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
},
"post": {
"operationId": "api_business-registries_post",
"tags": [
"BusinessRegistry"
],
"responses": {
"201": {
"description": "BusinessRegistry resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Creates a BusinessRegistry resource.",
"description": "Creates a BusinessRegistry resource.",
"parameters": [],
"requestBody": {
"description": "The new BusinessRegistry resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-write"
}
},
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry.jsonld-write"
}
}
},
"required": true
},
"deprecated": false
}
},
"/business-registries/{uuid}": {
"get": {
"operationId": "api_business-registries_uuid_get",
"tags": [
"BusinessRegistry"
],
"responses": {
"200": {
"description": "BusinessRegistry resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
}
}
},
"404": {
"description": "Resource not found"
}
},
"summary": "Retrieves a BusinessRegistry resource.",
"description": "Retrieves a BusinessRegistry resource.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "BusinessRegistry identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
},
"put": {
"operationId": "api_business-registries_uuid_put",
"tags": [
"BusinessRegistry"
],
"responses": {
"200": {
"description": "BusinessRegistry resource updated",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-read"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Replaces the BusinessRegistry resource.",
"description": "Replaces the BusinessRegistry resource.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "BusinessRegistry identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"requestBody": {
"description": "The updated BusinessRegistry resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry.jsonld-write"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-write"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-write"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-write"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-write"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-write"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-write"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-write"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistry-write"
}
}
},
"required": true
},
"deprecated": false
},
"delete": {
"operationId": "api_business-registries_uuid_delete",
"tags": [
"BusinessRegistry"
],
"responses": {
"204": {
"description": "BusinessRegistry resource deleted"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Removes the BusinessRegistry resource.",
"description": "Removes the BusinessRegistry resource.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "BusinessRegistry identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/business-registry-collects": {
"get": {
"operationId": "api_business-registry-collects_get_collection",
"tags": [
"BusinessRegistryCollect"
],
"responses": {
"200": {
"description": "BusinessRegistryCollect collection",
"content": {
"application/ld+json": {
"schema": {
"type": "object",
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput.jsonld-read"
}
},
"hydra:totalItems": {
"type": "integer",
"minimum": 0
},
"hydra:view": {
"type": "object",
"properties": {
"@id": {
"type": "string",
"format": "iri-reference"
},
"@type": {
"type": "string"
},
"hydra:first": {
"type": "string",
"format": "iri-reference"
},
"hydra:last": {
"type": "string",
"format": "iri-reference"
},
"hydra:previous": {
"type": "string",
"format": "iri-reference"
},
"hydra:next": {
"type": "string",
"format": "iri-reference"
}
},
"example": {
"@id": "string",
"type": "string",
"hydra:first": "string",
"hydra:last": "string",
"hydra:previous": "string",
"hydra:next": "string"
}
},
"hydra:search": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"hydra:template": {
"type": "string"
},
"hydra:variableRepresentation": {
"type": "string"
},
"hydra:mapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"variable": {
"type": "string"
},
"property": {
"type": [
"string",
"null"
]
},
"required": {
"type": "boolean"
}
}
}
}
}
}
},
"required": [
"hydra:member"
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
}
},
"text/html": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
}
},
"application/octet-stream": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
}
},
"application/pdf": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
}
},
"application/zip": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
}
}
}
}
},
"summary": "Retrieves the collection of BusinessRegistryCollect resources.",
"description": "Retrieves the collection of BusinessRegistryCollect resources.",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The collection page number",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 1
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "itemsPerPage",
"in": "query",
"description": "The number of items per page",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 30,
"minimum": 0,
"maximum": 100
},
"style": "form",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
},
"post": {
"operationId": "api_business-registry-collects_post",
"tags": [
"BusinessRegistryCollect"
],
"responses": {
"201": {
"description": "BusinessRegistryCollect resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Creates a BusinessRegistryCollect resource.",
"description": "Creates a BusinessRegistryCollect resource.",
"parameters": [],
"requestBody": {
"description": "The new BusinessRegistryCollect resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.CreateBusinessRegistryCollectDataInput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.CreateBusinessRegistryCollectDataInput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.CreateBusinessRegistryCollectDataInput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.CreateBusinessRegistryCollectDataInput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.CreateBusinessRegistryCollectDataInput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.CreateBusinessRegistryCollectDataInput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.CreateBusinessRegistryCollectDataInput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.CreateBusinessRegistryCollectDataInput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.CreateBusinessRegistryCollectDataInput"
}
}
},
"required": true
},
"deprecated": false
}
},
"/business-registry-collects/{uuid}": {
"get": {
"operationId": "api_business-registry-collects_uuid_get",
"tags": [
"BusinessRegistryCollect"
],
"responses": {
"200": {
"description": "BusinessRegistryCollect resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
}
}
},
"404": {
"description": "Resource not found"
}
},
"summary": "Retrieves a BusinessRegistryCollect resource.",
"description": "Retrieves a BusinessRegistryCollect resource.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "BusinessRegistryCollect identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/collect-business-registry-data": {
"post": {
"operationId": "api_collect-business-registry-data_post",
"tags": [
"BusinessRegistryCollect"
],
"responses": {
"204": {
"description": "BusinessRegistryCollect resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.BusinessRegistryCollectOutput-read"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Creates a BusinessRegistryCollect resource.",
"description": "Creates a BusinessRegistryCollect resource.",
"parameters": [],
"requestBody": {
"description": "The new BusinessRegistryCollect resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.UpdateBusinessRegistryCollectDataInput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.UpdateBusinessRegistryCollectDataInput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.UpdateBusinessRegistryCollectDataInput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.UpdateBusinessRegistryCollectDataInput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.UpdateBusinessRegistryCollectDataInput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.UpdateBusinessRegistryCollectDataInput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.UpdateBusinessRegistryCollectDataInput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.UpdateBusinessRegistryCollectDataInput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryCollect.UpdateBusinessRegistryCollectDataInput"
}
}
},
"required": true
},
"deprecated": false
}
},
"/skip-collect-business-registry-data": {
"post": {
"operationId": "api_skip-collect-business-registry-data_post",
"tags": [
"BusinessRegistryCollect"
],
"responses": {
"204": {
"description": "BusinessRegistryCollect resource created",
"content": {
"application/ld+json": {
"schema": {}
},
"application/json": {
"schema": {}
},
"text/html": {
"schema": {}
},
"application/xml": {
"schema": {}
},
"text/xml": {
"schema": {}
},
"application/octet-stream": {
"schema": {}
},
"application/pdf": {
"schema": {}
},
"application/zip": {
"schema": {}
},
"text/csv": {
"schema": {}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Creates a BusinessRegistryCollect resource.",
"description": "Creates a BusinessRegistryCollect resource.",
"parameters": [],
"deprecated": false
}
},
"/business-registry-configurations": {
"get": {
"operationId": "api_business-registry-configurations_get_collection",
"tags": [
"BusinessRegistryConfiguration"
],
"responses": {
"200": {
"description": "BusinessRegistryConfiguration collection",
"content": {
"application/ld+json": {
"schema": {
"type": "object",
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.jsonld-read"
}
},
"hydra:totalItems": {
"type": "integer",
"minimum": 0
},
"hydra:view": {
"type": "object",
"properties": {
"@id": {
"type": "string",
"format": "iri-reference"
},
"@type": {
"type": "string"
},
"hydra:first": {
"type": "string",
"format": "iri-reference"
},
"hydra:last": {
"type": "string",
"format": "iri-reference"
},
"hydra:previous": {
"type": "string",
"format": "iri-reference"
},
"hydra:next": {
"type": "string",
"format": "iri-reference"
}
},
"example": {
"@id": "string",
"type": "string",
"hydra:first": "string",
"hydra:last": "string",
"hydra:previous": "string",
"hydra:next": "string"
}
},
"hydra:search": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"hydra:template": {
"type": "string"
},
"hydra:variableRepresentation": {
"type": "string"
},
"hydra:mapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"variable": {
"type": "string"
},
"property": {
"type": [
"string",
"null"
]
},
"required": {
"type": "boolean"
}
}
}
}
}
}
},
"required": [
"hydra:member"
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
}
},
"text/html": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
}
},
"application/octet-stream": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
}
},
"application/pdf": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
}
},
"application/zip": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
}
}
}
}
},
"summary": "Retrieves the collection of BusinessRegistryConfiguration resources.",
"description": "Retrieves the collection of BusinessRegistryConfiguration resources.",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The collection page number",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 1
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "itemsPerPage",
"in": "query",
"description": "The number of items per page",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 30,
"minimum": 0,
"maximum": 100
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "fiscal_id",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "fiscal_id[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "email",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "name",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "supplier_invoice_enabled",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "boolean"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "apply_signature",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "boolean"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "apply_legal_storage",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "boolean"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "legal_storage_active",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "boolean"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "receipts_enabled",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "boolean"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "customer_invoice_enabled",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "boolean"
},
"style": "form",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
},
"post": {
"operationId": "api_business-registry-configurations_post",
"tags": [
"BusinessRegistryConfiguration"
],
"responses": {
"201": {
"description": "BusinessRegistryConfiguration resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Creates a BusinessRegistryConfiguration resource.",
"description": "Creates a BusinessRegistryConfiguration resource.",
"parameters": [],
"requestBody": {
"description": "The new BusinessRegistryConfiguration resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-write"
}
},
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.jsonld-write"
}
}
},
"required": true
},
"deprecated": false
}
},
"/business-registry-configurations/sub-accounts/{email}": {
"get": {
"operationId": "list_brc_by_sub_account_email",
"tags": [
"BusinessRegistryConfiguration"
],
"responses": {
"200": {
"description": "BusinessRegistryConfiguration resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
}
}
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Resource not found"
}
},
"summary": "List business registry configurations by sub account email",
"description": "Retrieves a BusinessRegistryConfiguration resource.",
"parameters": [
{
"name": "email",
"in": "path",
"description": "The sub account email",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "fiscalId",
"in": "path",
"description": "BusinessRegistryConfiguration identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/business-registry-configurations/{fiscalId}": {
"get": {
"operationId": "api_business-registry-configurations_fiscalId_get",
"tags": [
"BusinessRegistryConfiguration"
],
"responses": {
"200": {
"description": "BusinessRegistryConfiguration resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
}
}
},
"404": {
"description": "Resource not found"
}
},
"summary": "Retrieves a BusinessRegistryConfiguration resource.",
"description": "Retrieve the business registry configuration for the provided fiscal identifier",
"parameters": [
{
"name": "fiscalId",
"in": "path",
"description": "The fiscal identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
},
"put": {
"operationId": "api_business-registry-configurations_fiscalId_put",
"tags": [
"BusinessRegistryConfiguration"
],
"responses": {
"200": {
"description": "BusinessRegistryConfiguration resource updated",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Replaces the BusinessRegistryConfiguration resource.",
"description": "Update the business registry configuration for the provided fiscal identifier",
"parameters": [
{
"name": "fiscalId",
"in": "path",
"description": "The fiscal identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"requestBody": {
"description": "The updated BusinessRegistryConfiguration resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.jsonld-write"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-write"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-write"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-write"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-write"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-write"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-write"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-write"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-write"
}
}
},
"required": true
},
"deprecated": false
},
"delete": {
"operationId": "api_business-registry-configurations_fiscalId_delete",
"tags": [
"BusinessRegistryConfiguration"
],
"responses": {
"202": {
"description": "Archiving requested. Deletion will occur after processing. Empty body."
},
"204": {
"description": "Configuration deleted immediately (no archiving). Empty body."
},
"404": {
"description": "Configuration not found for current user."
},
"409": {
"description": "Cannot delete due to existing references"
}
},
"summary": "Delete a business registry configuration optionally triggering invoice archiving",
"description": "Delete the business registry configuration. Add ?archiveInvoices=true to request asynchronous invoice archiving before final removal.\\n\\nBehavior: \\n- Without parameter or archiveInvoices=false -> Immediate delete (204 No Content).\\n- With archiveInvoices=true -> Starts async archiving (202 Accepted). The configuration is deleted at the end of archiving.\\n",
"parameters": [
{
"name": "fiscalId",
"in": "path",
"description": "The fiscal identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "archiveInvoices",
"in": "query",
"description": "If true (true,1,yes,on), invoices are archived asynchronously before deletion (202). Otherwise immediate deletion (204).",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "boolean"
},
"style": "form",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/business-registry-configurations/{fiscalId}/appoint/fisconline": {
"put": {
"operationId": "onboard_ade_appointee",
"tags": [
"BusinessRegistryConfiguration"
],
"responses": {
"204": {
"description": "OK"
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Wrong credentials"
},
"200": {
"description": "BusinessRegistryConfiguration resource updated",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
}
},
"links": {}
}
},
"summary": "Appoint A-Cube to use the receipt services.",
"description": "Appoint A-Cube to use the receipt services on the Agenzia delle Entrate portal using FiscOnline / Entratel credentials",
"parameters": [
{
"name": "fiscalId",
"in": "path",
"description": "The fiscal identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"requestBody": {
"description": "The updated BusinessRegistryConfiguration resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeInput.jsonld-write"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeInput-write"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeInput-write"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeInput-write"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeInput-write"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeInput-write"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeInput-write"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeInput-write"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeInput-write"
}
}
},
"required": true
},
"deprecated": false
}
},
"/business-registry-configurations/{fiscalId}/appoint/spid": {
"put": {
"operationId": "onboard_ade_appointee_spid",
"tags": [
"BusinessRegistryConfiguration"
],
"responses": {
"200": {
"description": "BusinessRegistryConfiguration resource updated",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeSpidOutput.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeSpidOutput-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeSpidOutput-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeSpidOutput-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeSpidOutput-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeSpidOutput-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeSpidOutput-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeSpidOutput-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeSpidOutput-read"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Appoint an appointee using SPID flow",
"description": "Starts the SPID flow to appoint an appointee (placeholder in migration)",
"parameters": [
{
"name": "fiscalId",
"in": "path",
"description": "The fiscal identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"requestBody": {
"description": "The updated BusinessRegistryConfiguration resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeSpidInput.jsonld-write"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeSpidInput-write"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeSpidInput-write"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeSpidInput-write"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeSpidInput-write"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeSpidInput-write"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeSpidInput-write"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeSpidInput-write"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeSpidInput-write"
}
}
},
"required": true
},
"deprecated": false
}
},
"/business-registry-configurations/{fiscalId}/appoint/status": {
"get": {
"operationId": "appoint_status",
"tags": [
"BusinessRegistryConfiguration"
],
"responses": {
"200": {
"description": "BusinessRegistryConfiguration resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointStatusOutput.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointStatusOutput-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointStatusOutput-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointStatusOutput-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointStatusOutput-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointStatusOutput-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointStatusOutput-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointStatusOutput-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointStatusOutput-read"
}
}
}
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Gets the status of an appointing request",
"description": "Gets the status of an appointing request",
"parameters": [
{
"name": "fiscalId",
"in": "path",
"description": "The fiscal identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/business-registry-configurations/{fiscalId}/credentials/fisconline": {
"put": {
"operationId": "set_ade_credentials_brc",
"tags": [
"BusinessRegistryConfiguration"
],
"responses": {
"204": {
"description": "OK"
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Wrong credentials"
},
"200": {
"description": "BusinessRegistryConfiguration resource updated",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
}
},
"links": {}
}
},
"summary": "Set new Agenzia delle Entrate credentials.",
"description": "Update the credentials to access the Agenzia delle Entrate portal (FiscOnline / Entratel)",
"parameters": [
{
"name": "fiscalId",
"in": "path",
"description": "The fiscal identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"requestBody": {
"description": "The updated BusinessRegistryConfiguration resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.AdeCredentials.jsonld-write"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.AdeCredentials-write"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.AdeCredentials-write"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.AdeCredentials-write"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.AdeCredentials-write"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.AdeCredentials-write"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.AdeCredentials-write"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.AdeCredentials-write"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.AdeCredentials-write"
}
}
},
"required": true
},
"deprecated": false
}
},
"/business-registry-configurations/{fiscalId}/receipt-settings": {
"get": {
"operationId": "get_receipt_settings",
"tags": [
"BusinessRegistryConfiguration"
],
"responses": {
"200": {
"description": "BusinessRegistryConfiguration resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.ReceiptSettingsOutput-read"
}
}
}
},
"404": {
"description": "Resource not found"
}
},
"summary": "Gets settings related to Smart Receipts",
"description": "Retrieves a BusinessRegistryConfiguration resource.",
"parameters": [
{
"name": "fiscalId",
"in": "path",
"description": "The fiscal identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
},
"put": {
"operationId": "put_receipt_settings",
"tags": [
"BusinessRegistryConfiguration"
],
"responses": {
"200": {
"description": "BusinessRegistryConfiguration resource updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.ReceiptSettingsOutput-read"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Updates settings related to Smart Receipts",
"description": "Replaces the BusinessRegistryConfiguration resource.",
"parameters": [
{
"name": "fiscalId",
"in": "path",
"description": "The fiscal identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"requestBody": {
"description": "The updated BusinessRegistryConfiguration resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.ReceiptSettingsInput-write"
}
}
},
"required": true
},
"deprecated": false
}
},
"/business-registry-configurations/{fiscalId}/reporting": {
"get": {
"operationId": "get_reporting",
"tags": [
"BusinessRegistryConfiguration"
],
"responses": {
"200": {
"description": "BusinessRegistryConfiguration resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.ReportingOutput-read"
}
}
}
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Gets reporting parameters for a business registry",
"description": "Retrieves a BusinessRegistryConfiguration resource.",
"parameters": [
{
"name": "fiscalId",
"in": "path",
"description": "The fiscal identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
},
"put": {
"operationId": "put_reporting",
"tags": [
"BusinessRegistryConfiguration"
],
"responses": {
"200": {
"description": "BusinessRegistryConfiguration resource updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.ReportingOutput-read"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Update reporting parameters for a business registry",
"description": "Replaces the BusinessRegistryConfiguration resource.",
"parameters": [
{
"name": "fiscalId",
"in": "path",
"description": "BusinessRegistryConfiguration identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"requestBody": {
"description": "The updated BusinessRegistryConfiguration resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.ReportingInput-write"
}
}
},
"required": true
},
"deprecated": false
}
},
"/business-registry-configurations/{fiscalId}/reset-legal-storage-password": {
"get": {
"operationId": "reset_ewitness_password",
"tags": [
"BusinessRegistryConfiguration"
],
"responses": {
"200": {
"description": "OK"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
}
},
"summary": "Reset legal storage portal password.",
"description": "Ask to reset legal storage portal password for the provided fiscal identifier",
"parameters": [
{
"name": "fiscalId",
"in": "path",
"description": "The fiscal identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/business-registry-configurations/{fiscalId}/sub-accounts": {
"get": {
"operationId": "list_sub_accounts",
"tags": [
"BusinessRegistryConfiguration"
],
"responses": {
"200": {
"description": "BusinessRegistryConfiguration resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.SubAccountOutput-read"
}
}
}
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Resource not found"
}
},
"summary": "List all sub accounts connected to the provided fiscal identifier",
"description": "Retrieves a BusinessRegistryConfiguration resource.",
"parameters": [
{
"name": "fiscalId",
"in": "path",
"description": "The fiscal identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
},
"post": {
"operationId": "add_sub_account",
"tags": [
"BusinessRegistryConfiguration"
],
"responses": {
"201": {
"description": "BusinessRegistryConfiguration resource created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.SubAccountOutput-read"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
},
"403": {
"description": "Forbidden"
}
},
"summary": "Add a new sub account to the provided fiscal identifier",
"description": "Creates a BusinessRegistryConfiguration resource.",
"parameters": [
{
"name": "fiscalId",
"in": "path",
"description": "The fiscal identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"requestBody": {
"description": "The new BusinessRegistryConfiguration resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.SubAccountInput-write"
}
}
},
"required": true
},
"deprecated": false
}
},
"/business-registry-configurations/{fiscalId}/sub-accounts/{email}": {
"delete": {
"operationId": "remove_sub_account",
"tags": [
"BusinessRegistryConfiguration"
],
"responses": {
"204": {
"description": "BusinessRegistryConfiguration resource deleted"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Remove a sub account from the provided fiscal identifier",
"description": "Removes the BusinessRegistryConfiguration resource.",
"parameters": [
{
"name": "fiscalId",
"in": "path",
"description": "The fiscal identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "email",
"in": "path",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/verify/company/{id}": {
"get": {
"operationId": "api_verifycompany_id_get",
"tags": [
"Company"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Company-read"
}
},
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Company.jsonld-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Company-read"
}
}
}
},
"406": {
"description": "Not acceptable - Fiscal id or vat number not valid"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Retrieve basic information about a company",
"description": "This service allows you to return basic information of a company by VAT number or fiscal id",
"parameters": [
{
"name": "id",
"in": "path",
"description": "VAT number WITHOUT the country prefix, fiscal id",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "check-split",
"in": "query",
"description": "Whether to include split payment information. **WARNING**: Setting this parameter to true will also trigger the split payment verification endpoint, resulting in charges for both services.",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "boolean"
},
"style": "form",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/customer-invoice-imports": {
"post": {
"operationId": "api_customer-invoice-imports_post",
"tags": [
"CustomerInvoiceImport"
],
"responses": {
"201": {
"description": "CustomerInvoiceImport resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/CustomerInvoiceImport.CustomerInvoiceImportOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerInvoiceImport.CustomerInvoiceImportOutput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/CustomerInvoiceImport.CustomerInvoiceImportOutput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/CustomerInvoiceImport.CustomerInvoiceImportOutput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/CustomerInvoiceImport.CustomerInvoiceImportOutput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/CustomerInvoiceImport.CustomerInvoiceImportOutput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/CustomerInvoiceImport.CustomerInvoiceImportOutput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/CustomerInvoiceImport.CustomerInvoiceImportOutput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/CustomerInvoiceImport.CustomerInvoiceImportOutput"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Import customer invoice",
"description": "Import a customer invoice that was already sent to SDI. The invoice will not be sent to SDI, but it will be sent to the legal storage if necessary. You can disable webhook events by sending X-DisableEndpoints: true header.",
"parameters": [],
"requestBody": {
"description": "The new CustomerInvoiceImport resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/CustomerInvoiceImport.CustomerInvoiceImportInput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerInvoiceImport.CustomerInvoiceImportInput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/CustomerInvoiceImport.CustomerInvoiceImportInput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/CustomerInvoiceImport.CustomerInvoiceImportInput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/CustomerInvoiceImport.CustomerInvoiceImportInput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/CustomerInvoiceImport.CustomerInvoiceImportInput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/CustomerInvoiceImport.CustomerInvoiceImportInput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/CustomerInvoiceImport.CustomerInvoiceImportInput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/CustomerInvoiceImport.CustomerInvoiceImportInput"
}
}
},
"required": true
},
"deprecated": false
}
},
"/sistema-ts/expenses": {
"get": {
"operationId": "api_sistema-tsexpenses_get_collection",
"tags": [
"Expense"
],
"responses": {
"200": {
"description": "Expense collection",
"content": {
"application/ld+json": {
"schema": {
"type": "object",
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Expense.jsonld-read"
}
},
"hydra:totalItems": {
"type": "integer",
"minimum": 0
},
"hydra:view": {
"type": "object",
"properties": {
"@id": {
"type": "string",
"format": "iri-reference"
},
"@type": {
"type": "string"
},
"hydra:first": {
"type": "string",
"format": "iri-reference"
},
"hydra:last": {
"type": "string",
"format": "iri-reference"
},
"hydra:previous": {
"type": "string",
"format": "iri-reference"
},
"hydra:next": {
"type": "string",
"format": "iri-reference"
}
},
"example": {
"@id": "string",
"type": "string",
"hydra:first": "string",
"hydra:last": "string",
"hydra:previous": "string",
"hydra:next": "string"
}
},
"hydra:search": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"hydra:template": {
"type": "string"
},
"hydra:variableRepresentation": {
"type": "string"
},
"hydra:mapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"variable": {
"type": "string"
},
"property": {
"type": [
"string",
"null"
]
},
"required": {
"type": "boolean"
}
}
}
}
}
}
},
"required": [
"hydra:member"
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Expense-read"
}
}
},
"text/html": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Expense-read"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Expense-read"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Expense-read"
}
}
},
"application/octet-stream": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Expense-read"
}
}
},
"application/pdf": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Expense-read"
}
}
},
"application/zip": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Expense-read"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Expense-read"
}
}
}
}
}
},
"summary": "Retrieves the collection of Expense resources.",
"description": "Retrieves the collection of Expense resources.",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The collection page number",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 1
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "itemsPerPage",
"in": "query",
"description": "The number of items per page",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 30,
"minimum": 0,
"maximum": 100
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "codice_fiscale_proprietario",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "codice_fiscale_proprietario[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "codice_fiscale_cittadino",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "codice_fiscale_cittadino[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "created_at[before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[strictly_before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[strictly_after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
},
"post": {
"operationId": "api_sistema-tsexpenses_post",
"tags": [
"Expense"
],
"responses": {
"201": {
"description": "Expense resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationOutput.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationOutput-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationOutput-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationOutput-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationOutput-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationOutput-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationOutput-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationOutput-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationOutput-read"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Creates a Expense resource.",
"description": "Creates a Expense resource.",
"parameters": [
{
"name": "X-SistemaTS-PinCode",
"in": "header",
"description": "Username password e PIN sono le credenziali del professionista o della struttura per interagire con SistemaTS.\n Qui trovi una guida ufficiale https://sistemats1.sanita.finanze.it/portale/operatori/medici-e-odontoiatri/info-sulle-modalita-di-accesso (sezione Accesso tramite credenziali)",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "X-SistemaTS-Username",
"in": "header",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "X-SistemaTS-Password",
"in": "header",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"requestBody": {
"description": "The new Expense resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationInput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationInput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationInput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationInput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationInput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationInput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationInput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationInput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationInput"
}
}
},
"required": true
},
"deprecated": false
}
},
"/sistema-ts/expenses/{id}": {
"get": {
"operationId": "api_sistema-tsexpenses_id_get",
"tags": [
"Expense"
],
"responses": {
"200": {
"description": "Expense resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Expense.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Expense-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Expense-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Expense-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Expense-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Expense-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Expense-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Expense-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Expense-read"
}
}
}
},
"404": {
"description": "Resource not found"
}
},
"summary": "Retrieves a Expense resource.",
"description": "Retrieves a Expense resource.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Expense identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
},
"put": {
"operationId": "api_sistema-tsexpenses_id_put",
"tags": [
"Expense"
],
"responses": {
"200": {
"description": "Expense resource updated",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationOutput.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationOutput-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationOutput-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationOutput-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationOutput-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationOutput-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationOutput-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationOutput-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationOutput-read"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Replaces the Expense resource.",
"description": "Replaces the Expense resource.",
"parameters": [
{
"name": "X-SistemaTS-PinCode",
"in": "header",
"description": "Username password e PIN sono le credenziali del professionista o della struttura per interagire con SistemaTS.\n Qui trovi una guida ufficiale https://sistemats1.sanita.finanze.it/portale/operatori/medici-e-odontoiatri/info-sulle-modalita-di-accesso (sezione Accesso tramite credenziali)",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "X-SistemaTS-Username",
"in": "header",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "X-SistemaTS-Password",
"in": "header",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "id",
"in": "path",
"description": "Expense identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"requestBody": {
"description": "The updated Expense resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationInput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationInput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationInput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationInput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationInput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationInput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationInput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationInput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationInput"
}
}
},
"required": true
},
"deprecated": false
},
"delete": {
"operationId": "api_sistema-tsexpenses_id_delete",
"tags": [
"Expense"
],
"responses": {
"204": {
"description": "Expense resource deleted"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Removes the Expense resource.",
"description": "Removes the Expense resource.",
"parameters": [
{
"name": "X-SistemaTS-PinCode",
"in": "header",
"description": "Username password e PIN sono le credenziali del professionista o della struttura per interagire con SistemaTS.\n Qui trovi una guida ufficiale https://sistemats1.sanita.finanze.it/portale/operatori/medici-e-odontoiatri/info-sulle-modalita-di-accesso (sezione Accesso tramite credenziali)",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "X-SistemaTS-Username",
"in": "header",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "X-SistemaTS-Password",
"in": "header",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "id",
"in": "path",
"description": "Expense identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/sistema-ts/expenses/{id}/credit-note": {
"post": {
"operationId": "api_sistema-tsexpenses_idcredit-note_post",
"tags": [
"Expense"
],
"responses": {
"200": {
"description": "OK"
},
"404": {
"description": "Not found"
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Create a credit note for an expense",
"description": "Creates a Expense resource.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "X-SistemaTS-PinCode",
"in": "header",
"description": "Username password e PIN sono le credenziali del professionista o della struttura per interagire con SistemaTS.\n Qui trovi una guida ufficiale https://sistemats1.sanita.finanze.it/portale/operatori/medici-e-odontoiatri/info-sulle-modalita-di-accesso (sezione Accesso tramite credenziali)",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "X-SistemaTS-Username",
"in": "header",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "X-SistemaTS-Password",
"in": "header",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"requestBody": {
"description": "The new Expense resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationCreditNoteInput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationCreditNoteInput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationCreditNoteInput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationCreditNoteInput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationCreditNoteInput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationCreditNoteInput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationCreditNoteInput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationCreditNoteInput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Expense.ExpenseOperationCreditNoteInput"
}
}
},
"required": true
},
"deprecated": false
}
},
"/sistema-ts/expenses/{id}/receipt/{protocolId}": {
"get": {
"operationId": "api_expenses_receipt_item",
"tags": [
"Expense"
],
"responses": {
"200": {
"description": "OK"
},
"404": {
"description": "Not found"
}
},
"summary": "Get the Receipt for an expense",
"description": "Retrieves a Expense resource.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "protocolId",
"in": "path",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/sistema-ts/expenses/{id}/receipts": {
"get": {
"operationId": "api_sistema-tsexpenses_idreceipts_get_collection",
"tags": [
"Expense"
],
"responses": {
"200": {
"description": "OK"
},
"404": {
"description": "Not found"
}
},
"summary": "Get the Receipts for an expense",
"description": "Retrieves the collection of Expense resources.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "page",
"in": "query",
"description": "The collection page number",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 1
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "itemsPerPage",
"in": "query",
"description": "The number of items per page",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 30,
"minimum": 0,
"maximum": 100
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "codice_fiscale_proprietario",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "codice_fiscale_proprietario[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "codice_fiscale_cittadino",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "codice_fiscale_cittadino[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "created_at[before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[strictly_before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[strictly_after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/verify/fiscal-id/{id}": {
"get": {
"operationId": "api_verifyfiscal-id_id_get",
"tags": [
"FiscalIdValidity"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FiscalIdValidity"
}
},
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/FiscalIdValidity.jsonld"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/FiscalIdValidity"
}
}
}
},
"406": {
"description": "Not acceptable - Fiscal id not valid"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Check if a fiscal ID is valid",
"description": "This service allows you to verify if a fiscal id is valid, in particular check if the fiscal id is present in the database of the Italian Revenue Agency",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Fiscal id",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/invoices": {
"get": {
"operationId": "api_invoices_get_collection",
"tags": [
"Invoice"
],
"responses": {
"200": {
"description": "Invoice collection",
"content": {
"application/ld+json": {
"schema": {
"type": "object",
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice.jsonld-read"
}
},
"hydra:totalItems": {
"type": "integer",
"minimum": 0
},
"hydra:view": {
"type": "object",
"properties": {
"@id": {
"type": "string",
"format": "iri-reference"
},
"@type": {
"type": "string"
},
"hydra:first": {
"type": "string",
"format": "iri-reference"
},
"hydra:last": {
"type": "string",
"format": "iri-reference"
},
"hydra:previous": {
"type": "string",
"format": "iri-reference"
},
"hydra:next": {
"type": "string",
"format": "iri-reference"
}
},
"example": {
"@id": "string",
"type": "string",
"hydra:first": "string",
"hydra:last": "string",
"hydra:previous": "string",
"hydra:next": "string"
}
},
"hydra:search": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"hydra:template": {
"type": "string"
},
"hydra:variableRepresentation": {
"type": "string"
},
"hydra:mapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"variable": {
"type": "string"
},
"property": {
"type": [
"string",
"null"
]
},
"required": {
"type": "boolean"
}
}
}
}
}
}
},
"required": [
"hydra:member"
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice-read"
}
}
},
"text/html": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice-read"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice-read"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice-read"
}
}
},
"application/octet-stream": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice-read"
}
}
},
"application/pdf": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice-read"
}
}
},
"application/zip": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice-read"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice-read"
}
}
}
}
}
},
"summary": "Retrieves the collection of Invoice resources.",
"description": "Currently the Invoice resource contains a `notification` index with a list of notification for the invoice.\nThe `notification` index is deprecated in favour of using the endpoint `/invoices/{uuid}/notifications`\n\nYou can get an invoice collection in many different formats just specifying a different Accept header:\n\n- **application/json**, default, you get some metadata information together with the json payload that represent the invoice\n- **application/zip**, get a zip file with invoices collection (ZIP format)",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The collection page number",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 1
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "itemsPerPage",
"in": "query",
"description": "The number of items per page",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 30,
"minimum": 0,
"maximum": 30
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[strictly_before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[strictly_after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "invoice_date[before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "invoice_date[strictly_before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "invoice_date[after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "invoice_date[strictly_after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "invoice_number",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "signed",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "boolean"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "downloaded",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "boolean"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "stamp",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "boolean"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "toPa",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "type",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "sender",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "recipient",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "rejectedToFix",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "sender.business_name",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "recipient.business_name",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "recipient.business_vat_number_code",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "recipient.business_vat_number_code[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "recipient.business_fiscal_code",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "recipient.business_fiscal_code[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "sender.business_vat_number_code",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "sender.business_vat_number_code[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "sender.business_fiscal_code",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "sender.business_fiscal_code[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "marking",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "marking[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "document_type",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "document_type[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "order[invoice_date]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
]
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "order[invoice_number]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
]
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "order[uuid]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
]
},
"style": "form",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
},
"post": {
"operationId": "api_invoices_post_collection",
"tags": [
"Invoice"
],
"responses": {
"400": {
"description": "Invalid input"
},
"202": {
"description": "Invoice resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput-read"
}
}
},
"links": {}
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Creates a Invoice resource.",
"description": "Create a new invoice and send it to the government channel",
"parameters": [],
"requestBody": {
"description": "The new Invoice resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceInput-write"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceInput-write"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceInput-write"
}
}
},
"required": true
},
"deprecated": false
}
},
"/invoices/convert": {
"post": {
"operationId": "api_invoices_convert",
"tags": [
"Invoice"
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Invalid input"
},
"201": {
"description": "Invoice resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Invoice.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
}
},
"links": {}
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Convert an invoice between supported formats",
"description": "Convert an invoice between supported formats.\n Sending header `Content-Type: application/json` you will receive back the XML file,\n while sending `Content-Type: application/xml` you will receive the JSON content.",
"parameters": [],
"deprecated": false
}
},
"/invoices/downloaded": {
"post": {
"operationId": "api_invoice_batch_downloaded",
"tags": [
"Invoice"
],
"responses": {
"200": {
"description": "The downloaded flag has been set"
},
"400": {
"description": "Invalid input"
},
"404": {
"description": "Resource not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Setup the downloaded flag for a collection of invoices.",
"description": "Creates a Invoice resource.",
"parameters": [],
"requestBody": {
"description": "The new Invoice resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice.DownloadedEntity-write"
}
},
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Invoice.DownloadedEntity.jsonld-write"
}
}
},
"required": true
},
"deprecated": false
}
},
"/invoices/draft": {
"get": {
"operationId": "api_invoices_get_draft_collection",
"tags": [
"Invoice"
],
"responses": {
"200": {
"description": "Invoice collection",
"content": {
"application/ld+json": {
"schema": {
"type": "object",
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice.jsonld-read"
}
},
"hydra:totalItems": {
"type": "integer",
"minimum": 0
},
"hydra:view": {
"type": "object",
"properties": {
"@id": {
"type": "string",
"format": "iri-reference"
},
"@type": {
"type": "string"
},
"hydra:first": {
"type": "string",
"format": "iri-reference"
},
"hydra:last": {
"type": "string",
"format": "iri-reference"
},
"hydra:previous": {
"type": "string",
"format": "iri-reference"
},
"hydra:next": {
"type": "string",
"format": "iri-reference"
}
},
"example": {
"@id": "string",
"type": "string",
"hydra:first": "string",
"hydra:last": "string",
"hydra:previous": "string",
"hydra:next": "string"
}
},
"hydra:search": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"hydra:template": {
"type": "string"
},
"hydra:variableRepresentation": {
"type": "string"
},
"hydra:mapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"variable": {
"type": "string"
},
"property": {
"type": [
"string",
"null"
]
},
"required": {
"type": "boolean"
}
}
}
}
}
}
},
"required": [
"hydra:member"
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice-read"
}
}
},
"text/html": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice-read"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice-read"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice-read"
}
}
},
"application/octet-stream": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice-read"
}
}
},
"application/pdf": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice-read"
}
}
},
"application/zip": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice-read"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice-read"
}
}
}
}
}
},
"summary": "Get the collection of draft invoices",
"description": "Get the collection of draft invoices",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The collection page number",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 1
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "itemsPerPage",
"in": "query",
"description": "The number of items per page",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 30,
"minimum": 0,
"maximum": 30
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[strictly_before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[strictly_after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "invoice_date[before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "invoice_date[strictly_before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "invoice_date[after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "invoice_date[strictly_after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "invoice_number",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "signed",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "boolean"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "downloaded",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "boolean"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "stamp",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "boolean"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "toPa",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "type",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "sender",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "recipient",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "rejectedToFix",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "sender.business_name",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "recipient.business_name",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "recipient.business_vat_number_code",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "recipient.business_vat_number_code[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "recipient.business_fiscal_code",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "recipient.business_fiscal_code[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "sender.business_vat_number_code",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "sender.business_vat_number_code[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "sender.business_fiscal_code",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "sender.business_fiscal_code[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "marking",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "marking[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "document_type",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "document_type[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "order[invoice_date]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
]
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "order[invoice_number]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
]
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "order[uuid]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
]
},
"style": "form",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
},
"post": {
"operationId": "api_invoices_draft_collection",
"tags": [
"Invoice"
],
"responses": {
"400": {
"description": "Invalid input"
},
"201": {
"description": "Invoice resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput-read"
}
}
},
"links": {}
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Creates a new Invoice resource in draft mode",
"description": "Creates a new invoice in draft mode. The invoice will not be sent to the SDI until it is explicitly requested.",
"parameters": [],
"requestBody": {
"description": "The new Invoice resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceDraftInput-write"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceDraftInput-write"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceDraftInput-write"
}
}
},
"required": true
},
"deprecated": false
}
},
"/invoices/draft/{uuid}": {
"get": {
"operationId": "api_invoices_get_draft_item",
"tags": [
"Invoice"
],
"responses": {
"200": {
"description": "Invoice resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Invoice.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
}
}
},
"404": {
"description": "Resource not found"
}
},
"summary": "Get the single draft invoice with the given id",
"description": "Get the single draft invoices with the given id",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "Invoice identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
},
"put": {
"operationId": "api_invoices_update_draft_item",
"tags": [
"Invoice"
],
"responses": {
"200": {
"description": "OK"
},
"404": {
"description": "Not found"
},
"409": {
"description": "Invoice not in draft state"
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Update the content of a draft invoice",
"description": "Update the content of a draft invoice.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "Invoice identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"requestBody": {
"description": "The updated Invoice resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceDraftInput.jsonld-write"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceDraftInput-write"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceDraftInput-write"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceDraftInput-write"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceDraftInput-write"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceDraftInput-write"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceDraftInput-write"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceDraftInput-write"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceDraftInput-write"
}
}
},
"required": true
},
"deprecated": false
},
"delete": {
"operationId": "api_invoices_delete_draft_item",
"tags": [
"Invoice"
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"description": "Not found"
},
"409": {
"description": "Invoice not in draft state"
}
},
"summary": "Delete a draft invoice",
"description": "Delete a draft invoice. All the contents will be completely removed.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "Invoice identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/invoices/draft/{uuid}/send": {
"post": {
"operationId": "api_invoices_accept_draft_item",
"tags": [
"Invoice"
],
"responses": {
"200": {
"description": "OK"
},
"404": {
"description": "Not found"
},
"409": {
"description": "Invoice not in draft state or cannot be sent to the SDI yet"
},
"201": {
"description": "Invoice resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceOutput-read"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Accept and send a draft invoice to the SDI",
"description": "Send a draft invoice to the SDI. The invoice will be validated and sent to the SDI.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "Invoice identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/invoices/report": {
"get": {
"operationId": "api_invoices_report_collection",
"tags": [
"Invoice"
],
"responses": {
"200": {
"description": "Invoice collection",
"content": {
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice.InvoiceReport-read"
}
}
}
}
}
},
"summary": "Get a Report of Invoices.",
"description": "Retrieves the collection of Invoice resources.",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The collection page number",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 1
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "itemsPerPage",
"in": "query",
"description": "The number of items per page",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 5000,
"minimum": 0,
"maximum": 5000
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[strictly_before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[strictly_after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "invoice_date[before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "invoice_date[strictly_before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "invoice_date[after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "invoice_date[strictly_after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "invoice_number",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "signed",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "boolean"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "downloaded",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "boolean"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "stamp",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "boolean"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "toPa",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "type",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "sender",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "recipient",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "rejectedToFix",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "sender.business_name",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "recipient.business_name",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "recipient.business_vat_number_code",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "recipient.business_vat_number_code[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "recipient.business_fiscal_code",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "recipient.business_fiscal_code[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "sender.business_vat_number_code",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "sender.business_vat_number_code[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "sender.business_fiscal_code",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "sender.business_fiscal_code[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "marking",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "marking[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "document_type",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "document_type[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "order[invoice_date]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
]
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "order[invoice_number]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
]
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "order[uuid]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
]
},
"style": "form",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/invoices/validate": {
"post": {
"operationId": "api_invoices_post_validate_collection",
"tags": [
"Invoice"
],
"responses": {
"400": {
"description": "Invalid input"
},
"200": {
"description": "Invoice resource created",
"content": {
"application/ld+json": {
"schema": {}
},
"application/json": {
"schema": {}
},
"text/html": {
"schema": {}
},
"application/xml": {
"schema": {}
},
"text/xml": {
"schema": {}
},
"application/octet-stream": {
"schema": {}
},
"application/pdf": {
"schema": {}
},
"application/zip": {
"schema": {}
},
"text/csv": {
"schema": {}
}
},
"links": {}
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Validate an invoice",
"description": "Validate an invoice without sending it to the government channel",
"parameters": [],
"requestBody": {
"description": "The new Invoice resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceInput-write"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceInput-write"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice.InvoiceInput-write"
}
}
},
"required": true
},
"deprecated": false
}
},
"/invoices/{uuid}": {
"get": {
"operationId": "api_invoices_get_item",
"tags": [
"Invoice"
],
"responses": {
"200": {
"description": "Invoice resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Invoice.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
}
}
},
"404": {
"description": "Resource not found"
}
},
"summary": "Retrieves a Invoice resource.",
"description": "\nYou can get an invoice in many different formats just specifying a different Accept header:\n\n- **application/json**, default, you get some metadata information together with the json payload that represent the invoice\n- **application/xml**, you get the XML format\n- **text/html**, you get the invoice formatted with the chosen stylesheet (via X-PrintTheme header, see below)\n- **application/pdf**, same as HTML but as a PDF file\n- **application/octet-stream**, get the raw file (P7M or XML format)\n\nIn case of HTML and PDF you can choose the printing theme specifying the X-PrintTheme header:\n\n- **standard**, default printing theme\n- **assosoftware**, AssoSoftware printing theme\n- **acube**, A-Cube printing theme (derived from AssoSoftware theme)\n\nIn case you choose A-Cube printing theme, you can write dynamic text within the output file, at the very beginning or in the file footer:\nyou must provide the URL query paramter `dynamic[head-notes]` or `dynamic[foot-notes]`.\n\nExample: `GET /invoices/{uuid}?dynamic[head-notes]=some text in the header&dynamic[foot-notes]=some text in the footer`",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "Invoice identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/invoices/{uuid}/archive-rejected": {
"put": {
"operationId": "api_invoices_archive_rejected_item",
"tags": [
"Invoice"
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"description": "Not found"
},
"409": {
"description": "Invoice not in rejected state"
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Archive a rejected invoice",
"description": "Mark invoice as archived and remove it from the rejected list to be fixed",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "Invoice identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/invoices/{uuid}/attachments/{index}": {
"get": {
"operationId": "api_invoices_download_attachment",
"tags": [
"Invoice"
],
"responses": {
"200": {
"description": "OK"
},
"404": {
"description": "Not found"
}
},
"summary": "Download an invoice attachment",
"description": "Download the index-th attachment of the invoice with the given uuid",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "Invoice uuid",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "index",
"in": "path",
"description": "Attachment index (0 based) in the invoice",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "integer"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/invoices/{uuid}/notifications/notify": {
"post": {
"operationId": "api_invoices_notify_invoice_notifications_item",
"tags": [
"Invoice"
],
"responses": {
"200": {
"description": "OK"
},
"404": {
"description": "Not found"
},
"201": {
"description": "Invoice resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Invoice.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Notify your configured webhook for an invoice notifications",
"description": "Creates a Invoice resource.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "Invoice identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/invoices/{uuid}/notify": {
"post": {
"operationId": "api_invoices_notify_invoice_item",
"tags": [
"Invoice"
],
"responses": {
"200": {
"description": "OK"
},
"404": {
"description": "Not found"
},
"201": {
"description": "Invoice resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Invoice.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Notify your configured webhook for an invoice",
"description": "Creates a Invoice resource.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "Invoice identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/invoices/{uuid}/preserve": {
"post": {
"operationId": "api_invoice_preserve",
"tags": [
"Invoice"
],
"responses": {
"200": {
"description": "OK"
},
"404": {
"description": "Not found"
},
"400": {
"description": "Invoice not eligible for preservation"
},
"201": {
"description": "Invoice resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Invoice.PreserveInvoiceOutput.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice.PreserveInvoiceOutput-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Invoice.PreserveInvoiceOutput-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice.PreserveInvoiceOutput-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice.PreserveInvoiceOutput-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Invoice.PreserveInvoiceOutput-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Invoice.PreserveInvoiceOutput-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Invoice.PreserveInvoiceOutput-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Invoice.PreserveInvoiceOutput-read"
}
}
},
"links": {}
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Preserve an invoice",
"description": "Send an invoice to the legal storage. The invoice must be eligible for preservation, otherwise a 400 error is returned. If successful, the platform returns a 200 response code. Since conservation submission is asynchronous, check the outcome via webhook notifications.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "Invoice uuid",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "force",
"in": "query",
"description": "Force preservation even if the invoice is not eligible",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "boolean",
"default": false
},
"style": "form",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/invoices/{uuid}/resend": {
"put": {
"operationId": "api_invoices_resend_item",
"tags": [
"Invoice"
],
"responses": {
"201": {
"description": "Created - Returns new invoice UUID"
},
"404": {
"description": "Not found"
},
"200": {
"description": "Invoice resource updated",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Invoice.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Invoice-read"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Resend a rejected invoice",
"description": "Resend a rejected invoice to SDI. Creates a new invoice and returns its UUID",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "Invoice identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/invoices/extra-sdi": {
"post": {
"operationId": "api_invoicesextra-sdi_post",
"tags": [
"InvoiceExtraSDI"
],
"responses": {
"201": {
"description": "InvoiceExtraSDI resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtraSDI.InvoiceExtraSDIOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtraSDI.InvoiceExtraSDIOutput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtraSDI.InvoiceExtraSDIOutput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtraSDI.InvoiceExtraSDIOutput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtraSDI.InvoiceExtraSDIOutput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtraSDI.InvoiceExtraSDIOutput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtraSDI.InvoiceExtraSDIOutput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtraSDI.InvoiceExtraSDIOutput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtraSDI.InvoiceExtraSDIOutput"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Creates a InvoiceExtraSDI resource.",
"description": "Creates a InvoiceExtraSDI resource.",
"parameters": [],
"requestBody": {
"description": "The new InvoiceExtraSDI resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtraSDI.InvoiceExtraSDIInput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtraSDI.InvoiceExtraSDIInput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtraSDI.InvoiceExtraSDIInput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtraSDI.InvoiceExtraSDIInput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtraSDI.InvoiceExtraSDIInput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtraSDI.InvoiceExtraSDIInput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtraSDI.InvoiceExtraSDIInput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtraSDI.InvoiceExtraSDIInput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtraSDI.InvoiceExtraSDIInput"
}
}
},
"required": true
},
"deprecated": false
}
},
"/invoice-extract": {
"get": {
"operationId": "api_invoice-extract_get_collection",
"tags": [
"InvoiceExtract"
],
"responses": {
"200": {
"description": "OK"
}
},
"summary": "Retrieves the collection of InvoiceExtract resources.",
"description": "Retrieves the collection of InvoiceExtract resources.",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The collection page number",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 1
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "itemsPerPage",
"in": "query",
"description": "The number of items per page",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 30,
"minimum": 0,
"maximum": 100
},
"style": "form",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
},
"post": {
"operationId": "invoice_extract_create",
"tags": [
"InvoiceExtract"
],
"responses": {
"202": {
"description": "InvoiceExtract resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtract.InvoiceExtractOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtract.InvoiceExtractOutput"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Extract information from a PDF invoice",
"description": "Upload a PDF invoice and get back the invoice converted to XML.\n\nThe received XML may not contain all the necessary information and the filled data must be validated before sending to the tax authority.",
"parameters": [],
"requestBody": {
"description": "The new InvoiceExtract resource",
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "The PDF invoice to upload"
},
"conversion_configuration": {
"type": "string",
"format": "json",
"description": "The conversion configuration",
"example": {
"default_vat_rate": 22,
"convert_amounts": true
}
}
}
}
}
},
"required": false
},
"deprecated": false
}
},
"/invoice-extract/{id}": {
"get": {
"operationId": "invoice_extract_get",
"tags": [
"InvoiceExtract"
],
"responses": {
"200": {
"description": "InvoiceExtract resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtract.InvoiceExtractOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtract.InvoiceExtractOutput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtract.InvoiceExtractOutput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtract.InvoiceExtractOutput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtract.InvoiceExtractOutput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtract.InvoiceExtractOutput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtract.InvoiceExtractOutput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtract.InvoiceExtractOutput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/InvoiceExtract.InvoiceExtractOutput"
}
}
}
},
"404": {
"description": "Resource not found"
}
},
"summary": "Retrieves a InvoiceExtract resource.",
"description": "Retrieves a InvoiceExtract resource.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "InvoiceExtract identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/invoice-extract/{id}/raw": {
"get": {
"operationId": "invoice_extract_raw",
"tags": [
"InvoiceExtract"
],
"responses": {
"200": {
"description": "Job done"
},
"102": {
"description": "Not ready yet"
},
"500": {
"description": "Elaboration error"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Get the raw extracted information",
"description": "Retrieve the information extracted from the PDF in a raw JSON format",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "InvoiceExtract identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/invoice-extract/{id}/result": {
"get": {
"operationId": "invoice_extract_result",
"tags": [
"InvoiceExtract"
],
"responses": {
"200": {
"description": "Job done"
},
"102": {
"description": "Not ready yet"
},
"500": {
"description": "Elaboration error"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Get the converted invoice",
"description": "Retrieve the converted invoice. If still elaborating you will receive status code 102, otherwise 200 and the XML or JSON Invoice as the response content.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "InvoiceExtract identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/invoices/simplified": {
"post": {
"operationId": "api_invoice_simplifieds_post_collection",
"tags": [
"InvoiceSimplified"
],
"responses": {
"400": {
"description": "Invalid input"
},
"202": {
"description": "InvoiceSimplified resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedOutput.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedOutput-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedOutput-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedOutput-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedOutput-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedOutput-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedOutput-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedOutput-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedOutput-read"
}
}
},
"links": {}
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Creates a new InvoiceSimplified resource",
"description": "Creates a new Simplified Invoice (FatturaElettronicaSemplificata FSM10). As response you will get back the uuid of the created resource. The invoice will be available within the `GET /invoices` collection or via the `GET /invoices/{uuid}` HTTP request.",
"parameters": [],
"requestBody": {
"description": "The new InvoiceSimplified resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedInput-write"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedInput-write"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedInput-write"
}
}
},
"required": true
},
"deprecated": false
}
},
"/invoices/simplified/draft/{uuid}": {
"put": {
"operationId": "api_invoice_simplifieds_update_draft_item",
"tags": [
"InvoiceSimplified"
],
"responses": {
"200": {
"description": "OK"
},
"404": {
"description": "Not found"
},
"409": {
"description": "Invoice not in draft state"
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Update the content of a draft invoice",
"description": "Update the content of a draft invoice.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "InvoiceSimplified identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"requestBody": {
"description": "The updated InvoiceSimplified resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedDraftInput.jsonld-write"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedDraftInput-write"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedDraftInput-write"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedDraftInput-write"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedDraftInput-write"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedDraftInput-write"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedDraftInput-write"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedDraftInput-write"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedDraftInput-write"
}
}
},
"required": true
},
"deprecated": false
},
"delete": {
"operationId": "api_invoice_simplifieds_delete_draft_item",
"tags": [
"InvoiceSimplified"
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"description": "Not found"
},
"409": {
"description": "Invoice not in draft state"
}
},
"summary": "Delete a draft invoice",
"description": "Delete a draft invoice.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "InvoiceSimplified identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/invoices/simplified/draft/{uuid}/send": {
"post": {
"operationId": "api_invoice_simplifieds_accept_draft_item",
"tags": [
"InvoiceSimplified"
],
"responses": {
"200": {
"description": "OK"
},
"404": {
"description": "Not found"
},
"409": {
"description": "Invoice not in draft state or cannot be sent to the SDI yet"
},
"201": {
"description": "InvoiceSimplified resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedOutput.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedOutput-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedOutput-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedOutput-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedOutput-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedOutput-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedOutput-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedOutput-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedOutput-read"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Accept and send a draft invoice to the SDI",
"description": "Send a draft invoice to the SDI. The invoice will be validated and sent to the SDI.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "InvoiceSimplified identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/invoices/simplified/validate": {
"post": {
"operationId": "api_invoice_simplifieds_post_validate_collection",
"tags": [
"InvoiceSimplified"
],
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"description": "Invalid input"
},
"204": {
"description": "InvoiceSimplified resource created",
"content": {
"application/ld+json": {
"schema": {}
},
"application/json": {
"schema": {}
},
"text/html": {
"schema": {}
},
"application/xml": {
"schema": {}
},
"text/xml": {
"schema": {}
},
"application/octet-stream": {
"schema": {}
},
"application/pdf": {
"schema": {}
},
"application/zip": {
"schema": {}
},
"text/csv": {
"schema": {}
}
},
"links": {}
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Creates a InvoiceSimplified resource.",
"description": "Validate an invoice without sending it to the government channel",
"parameters": [],
"requestBody": {
"description": "The new InvoiceSimplified resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceSimplified.InvoiceSimplifiedInput-write"
}
}
},
"required": true
},
"deprecated": false
}
},
"/invoices/stats/{year}": {
"get": {
"operationId": "api_invoicesstats_year_get",
"tags": [
"InvoiceStats"
],
"responses": {
"200": {
"description": "InvoiceStats resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/InvoiceStats.InvoiceStatsOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceStats.InvoiceStatsOutput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/InvoiceStats.InvoiceStatsOutput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/InvoiceStats.InvoiceStatsOutput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/InvoiceStats.InvoiceStatsOutput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/InvoiceStats.InvoiceStatsOutput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/InvoiceStats.InvoiceStatsOutput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/InvoiceStats.InvoiceStatsOutput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/InvoiceStats.InvoiceStatsOutput"
}
}
}
},
"404": {
"description": "Resource not found"
}
},
"summary": "Get the statistic information about your invoices.",
"description": "Get the statistic information about your invoices. You will receive the sum of invoices and notification, sum of the costs. Specifying the query parameters `fiscal_id` you will get the statistics for a specific customer. By default statistics are collected on annual basis but you can ask A-Cube to activate deeper collect operations to get `months`, `days` and even `hour_slots` statistics.",
"parameters": [
{
"name": "fiscal_id",
"in": "query",
"description": "The fiscal identifier you want to extract statistics, optional. if not provided you will receive the total counters.",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "year",
"in": "path",
"description": "The year of which you want to extract statistics.",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/invoice-transfers": {
"get": {
"operationId": "api_invoice-transfers_get_collection",
"tags": [
"InvoiceTransfer"
],
"responses": {
"200": {
"description": "InvoiceTransfer collection",
"content": {
"application/ld+json": {
"schema": {
"type": "object",
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceTransfer.InvoiceTransferOutput.jsonld"
}
},
"hydra:totalItems": {
"type": "integer",
"minimum": 0
},
"hydra:view": {
"type": "object",
"properties": {
"@id": {
"type": "string",
"format": "iri-reference"
},
"@type": {
"type": "string"
},
"hydra:first": {
"type": "string",
"format": "iri-reference"
},
"hydra:last": {
"type": "string",
"format": "iri-reference"
},
"hydra:previous": {
"type": "string",
"format": "iri-reference"
},
"hydra:next": {
"type": "string",
"format": "iri-reference"
}
},
"example": {
"@id": "string",
"type": "string",
"hydra:first": "string",
"hydra:last": "string",
"hydra:previous": "string",
"hydra:next": "string"
}
},
"hydra:search": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"hydra:template": {
"type": "string"
},
"hydra:variableRepresentation": {
"type": "string"
},
"hydra:mapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"variable": {
"type": "string"
},
"property": {
"type": [
"string",
"null"
]
},
"required": {
"type": "boolean"
}
}
}
}
}
}
},
"required": [
"hydra:member"
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceTransfer.InvoiceTransferOutput"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceTransfer.InvoiceTransferOutput"
}
}
}
}
}
},
"summary": "Get a collection of InvoiceTransfer resources.",
"description": "Retrieves the collection of InvoiceTransfer resources.",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The collection page number",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 1
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "itemsPerPage",
"in": "query",
"description": "The number of items per page",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 30,
"minimum": 0,
"maximum": 1000
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[strictly_before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[strictly_after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "fixed",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "boolean"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "exists[violations]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "boolean"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "original_file_name",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/invoice-transfers/{uuid}": {
"get": {
"operationId": "api_invoice-transfers_uuid_get",
"tags": [
"InvoiceTransfer"
],
"responses": {
"200": {
"description": "InvoiceTransfer resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/InvoiceTransfer.InvoiceTransferOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceTransfer.InvoiceTransferOutput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/InvoiceTransfer.InvoiceTransferOutput"
}
}
}
},
"404": {
"description": "Resource not found"
}
},
"summary": "Get a InvoiceTransfer resource by uuid.",
"description": "Retrieves a InvoiceTransfer resource.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "InvoiceTransfer identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/invoice-transfers/{uuid}/download": {
"get": {
"operationId": "api_invoice-transfers_uuiddownload_get",
"tags": [
"InvoiceTransfer"
],
"responses": {
"200": {
"description": "OK"
},
"404": {
"description": "Not found"
}
},
"summary": "Download invoice transfer file",
"description": "Download the source invoice transfer file",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "InvoiceTransfer identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/jobs": {
"get": {
"operationId": "api_jobs_get_collection",
"tags": [
"Job"
],
"responses": {
"200": {
"description": "Job collection",
"content": {
"application/ld+json": {
"schema": {
"type": "object",
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Job.JobOutput.jsonld"
}
},
"hydra:totalItems": {
"type": "integer",
"minimum": 0
},
"hydra:view": {
"type": "object",
"properties": {
"@id": {
"type": "string",
"format": "iri-reference"
},
"@type": {
"type": "string"
},
"hydra:first": {
"type": "string",
"format": "iri-reference"
},
"hydra:last": {
"type": "string",
"format": "iri-reference"
},
"hydra:previous": {
"type": "string",
"format": "iri-reference"
},
"hydra:next": {
"type": "string",
"format": "iri-reference"
}
},
"example": {
"@id": "string",
"type": "string",
"hydra:first": "string",
"hydra:last": "string",
"hydra:previous": "string",
"hydra:next": "string"
}
},
"hydra:search": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"hydra:template": {
"type": "string"
},
"hydra:variableRepresentation": {
"type": "string"
},
"hydra:mapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"variable": {
"type": "string"
},
"property": {
"type": [
"string",
"null"
]
},
"required": {
"type": "boolean"
}
}
}
}
}
}
},
"required": [
"hydra:member"
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Job.JobOutput"
}
}
},
"text/html": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Job.JobOutput"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Job.JobOutput"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Job.JobOutput"
}
}
},
"application/octet-stream": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Job.JobOutput"
}
}
},
"application/pdf": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Job.JobOutput"
}
}
},
"application/zip": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Job.JobOutput"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Job.JobOutput"
}
}
}
}
}
},
"summary": "Retrieves the collection of Job resources.",
"description": "Retrieves the collection of Job resources.",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The collection page number",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 1
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "itemsPerPage",
"in": "query",
"description": "The number of items per page",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 30,
"minimum": 0,
"maximum": 30
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "fiscal_id",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "started_at[before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "started_at[strictly_before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "started_at[after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "started_at[strictly_after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "scheduled_at[before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "scheduled_at[strictly_before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "scheduled_at[after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "scheduled_at[strictly_after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "completed_at[before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "completed_at[strictly_before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "completed_at[after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "completed_at[strictly_after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[strictly_before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[strictly_after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "status",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"enum": [
"ready",
"started",
"completed",
"error"
]
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "job_type",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"enum": [
"invoice-download",
"invoice-report-download",
"invoice-zip-download"
]
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "order[started_at]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
]
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "order[completed_at]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
]
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "order[scheduled_at]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
]
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "order[created_at]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
]
},
"style": "form",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/jobs/invoice-download": {
"post": {
"operationId": "job_create_invoice_download",
"tags": [
"Job"
],
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Validation error"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Create a new invoice download job",
"description": "Creates a Job resource.",
"parameters": [],
"requestBody": {
"description": "The new Job resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceDownloadInput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceDownloadInput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceDownloadInput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceDownloadInput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceDownloadInput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceDownloadInput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceDownloadInput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceDownloadInput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceDownloadInput"
}
}
},
"required": true
},
"deprecated": false
}
},
"/jobs/invoice-report-download": {
"post": {
"operationId": "job_create_invoice_report_download",
"tags": [
"Job"
],
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Validation error"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Create a new invoice report job",
"description": "Creates a Job resource.",
"parameters": [],
"requestBody": {
"description": "The new Job resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceReportDownloadInput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceReportDownloadInput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceReportDownloadInput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceReportDownloadInput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceReportDownloadInput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceReportDownloadInput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceReportDownloadInput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceReportDownloadInput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceReportDownloadInput"
}
}
},
"required": true
},
"deprecated": false
}
},
"/jobs/invoice-zip-download": {
"post": {
"operationId": "job_create_invoice_zip_download",
"tags": [
"Job"
],
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Validation error"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Create a new invoice zip job",
"description": "Creates a Job resource.",
"parameters": [],
"requestBody": {
"description": "The new Job resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceZipDownloadInput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceZipDownloadInput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceZipDownloadInput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceZipDownloadInput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceZipDownloadInput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceZipDownloadInput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceZipDownloadInput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceZipDownloadInput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Job.JobInvoiceZipDownloadInput"
}
}
},
"required": true
},
"deprecated": false
}
},
"/jobs/{uuid}": {
"get": {
"operationId": "api_jobs_uuid_get",
"tags": [
"Job"
],
"responses": {
"200": {
"description": "Job resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Job.JobOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Job.JobOutput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Job.JobOutput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Job.JobOutput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Job.JobOutput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Job.JobOutput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Job.JobOutput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Job.JobOutput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Job.JobOutput"
}
}
}
},
"404": {
"description": "Resource not found"
}
},
"summary": "Retrieves a Job resource.",
"description": "Retrieves a Job resource.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "Job identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/jobs/{uuid}/download": {
"get": {
"operationId": "job_download",
"tags": [
"Job"
],
"responses": {
"204": {
"description": "Job resource",
"content": {
"application/ld+json": {
"schema": {}
},
"application/json": {
"schema": {}
},
"text/html": {
"schema": {}
},
"application/xml": {
"schema": {}
},
"text/xml": {
"schema": {}
},
"application/octet-stream": {
"schema": {}
},
"application/pdf": {
"schema": {}
},
"application/zip": {
"schema": {}
},
"text/csv": {
"schema": {}
}
}
},
"404": {
"description": "Resource not found"
}
},
"summary": "Download the generated file for invoice report, invoice zip jobs (if stored in API storage)",
"description": "Retrieves a Job resource.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "Job identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/invoices/{uuid}/notifications": {
"get": {
"operationId": "api_invoice_get_notifications",
"tags": [
"Notification"
],
"responses": {
"200": {
"description": "Notification collection",
"content": {
"application/ld+json": {
"schema": {
"type": "object",
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Notification.jsonld"
}
},
"hydra:totalItems": {
"type": "integer",
"minimum": 0
},
"hydra:view": {
"type": "object",
"properties": {
"@id": {
"type": "string",
"format": "iri-reference"
},
"@type": {
"type": "string"
},
"hydra:first": {
"type": "string",
"format": "iri-reference"
},
"hydra:last": {
"type": "string",
"format": "iri-reference"
},
"hydra:previous": {
"type": "string",
"format": "iri-reference"
},
"hydra:next": {
"type": "string",
"format": "iri-reference"
}
},
"example": {
"@id": "string",
"type": "string",
"hydra:first": "string",
"hydra:last": "string",
"hydra:previous": "string",
"hydra:next": "string"
}
},
"hydra:search": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"hydra:template": {
"type": "string"
},
"hydra:variableRepresentation": {
"type": "string"
},
"hydra:mapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"variable": {
"type": "string"
},
"property": {
"type": [
"string",
"null"
]
},
"required": {
"type": "boolean"
}
}
}
}
}
}
},
"required": [
"hydra:member"
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Notification"
}
}
},
"text/html": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Notification"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Notification"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Notification"
}
}
},
"application/octet-stream": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Notification"
}
}
},
"application/pdf": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Notification"
}
}
},
"application/zip": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Notification"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Notification"
}
}
}
}
}
},
"summary": "Retrieves the collection of Invoice notifications",
"description": "Retrieve the collection of notifications for a given invoice.\n You can have the notification message in JSON format or the original XML by sending the Accept HTTP header to either `application/json` or `application/xml`.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/notifications/downloaded": {
"post": {
"operationId": "api_notification_batch_downloaded",
"tags": [
"Notification"
],
"responses": {
"200": {
"description": "The downloaded flag has been set"
},
"400": {
"description": "Invalid input"
},
"404": {
"description": "Resource not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Setup the downloaded flag for a collection of notification.",
"description": "Creates a Notification resource.",
"parameters": [],
"requestBody": {
"description": "The new Notification resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Notification.DownloadedEntity"
}
},
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Notification.DownloadedEntity.jsonld"
}
}
},
"required": true
},
"deprecated": false
}
},
"/notifications/{uuid}": {
"get": {
"operationId": "api_get_notification",
"tags": [
"Notification"
],
"responses": {
"200": {
"description": "Notification resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Notification.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Notification"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Notification"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Notification"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Notification"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Notification"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Notification"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Notification"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Notification"
}
}
}
},
"404": {
"description": "Resource not found"
}
},
"summary": "Retrieve a single notification",
"description": "Retrieve a single notification by its uuid.\n You can have the notification message in JSON format or the original XML by sending the Accept HTTP header to either `application/json` or `application/xml`.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/numbering-sequences": {
"get": {
"operationId": "api_numbering-sequences_get_collection",
"tags": [
"NumberingSequence"
],
"responses": {
"200": {
"description": "NumberingSequence collection",
"content": {
"application/ld+json": {
"schema": {
"type": "object",
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NumberingSequence.NumberingSequenceOutput.jsonld"
}
},
"hydra:totalItems": {
"type": "integer",
"minimum": 0
},
"hydra:view": {
"type": "object",
"properties": {
"@id": {
"type": "string",
"format": "iri-reference"
},
"@type": {
"type": "string"
},
"hydra:first": {
"type": "string",
"format": "iri-reference"
},
"hydra:last": {
"type": "string",
"format": "iri-reference"
},
"hydra:previous": {
"type": "string",
"format": "iri-reference"
},
"hydra:next": {
"type": "string",
"format": "iri-reference"
}
},
"example": {
"@id": "string",
"type": "string",
"hydra:first": "string",
"hydra:last": "string",
"hydra:previous": "string",
"hydra:next": "string"
}
},
"hydra:search": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"hydra:template": {
"type": "string"
},
"hydra:variableRepresentation": {
"type": "string"
},
"hydra:mapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"variable": {
"type": "string"
},
"property": {
"type": [
"string",
"null"
]
},
"required": {
"type": "boolean"
}
}
}
}
}
}
},
"required": [
"hydra:member"
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NumberingSequence.NumberingSequenceOutput"
}
}
}
}
}
},
"summary": "Retrieves the collection of NumberingSequence resources.",
"description": "Retrieves the collection of NumberingSequence resources.",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The collection page number",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 1
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "itemsPerPage",
"in": "query",
"description": "The number of items per page",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 30,
"minimum": 0,
"maximum": 100
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "sequence_name",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "sequence_name[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "year",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "integer"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "year[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"style": "form",
"explode": true,
"allowReserved": false
}
],
"deprecated": false
},
"post": {
"operationId": "api_numbering-sequences_post",
"tags": [
"NumberingSequence"
],
"responses": {
"201": {
"description": "NumberingSequence resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/NumberingSequence.NumberingSequenceOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NumberingSequence.NumberingSequenceOutput"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Creates a NumberingSequence resource.",
"description": "Creates a NumberingSequence resource.",
"parameters": [],
"requestBody": {
"description": "The new NumberingSequence resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/NumberingSequence.NumberingSequenceCreateInput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NumberingSequence.NumberingSequenceCreateInput"
}
}
},
"required": true
},
"deprecated": false
}
},
"/numbering-sequences/current/{name}": {
"get": {
"operationId": "api_numbering-sequencescurrent_name_get",
"tags": [
"NumberingSequence"
],
"responses": {
"200": {
"description": "The current numbering sequence."
},
"404": {
"description": "No numbering sequence found."
}
},
"summary": "Get current numbering sequence.",
"description": "Get the numbering sequence that is used now for the given sequence name.",
"parameters": [
{
"name": "name",
"in": "path",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
},
"put": {
"operationId": "api_numbering-sequencescurrent_name_put",
"tags": [
"NumberingSequence"
],
"responses": {
"200": {
"description": "Numbering sequence created or updated."
},
"400": {
"description": "Request is invalid."
},
"422": {
"description": "Unprocessable entity"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Create or update the current numbering sequence.",
"description": "Create or update the numbering sequence that is used now for the given sequence name.",
"parameters": [
{
"name": "name",
"in": "path",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"requestBody": {
"description": "The updated NumberingSequence resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/NumberingSequence.NumberingSequenceUpdateInput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NumberingSequence.NumberingSequenceUpdateInput"
}
}
},
"required": true
},
"deprecated": false
}
},
"/numbering-sequences/{uuid}": {
"get": {
"operationId": "api_numbering-sequences_uuid_get",
"tags": [
"NumberingSequence"
],
"responses": {
"200": {
"description": "NumberingSequence resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/NumberingSequence.NumberingSequenceOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NumberingSequence.NumberingSequenceOutput"
}
}
}
},
"404": {
"description": "Resource not found"
}
},
"summary": "Retrieves a NumberingSequence resource.",
"description": "Retrieves a NumberingSequence resource.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "NumberingSequence identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
},
"put": {
"operationId": "api_numbering-sequences_uuid_put",
"tags": [
"NumberingSequence"
],
"responses": {
"200": {
"description": "NumberingSequence resource updated",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/NumberingSequence.NumberingSequenceOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NumberingSequence.NumberingSequenceOutput"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Replaces the NumberingSequence resource.",
"description": "Replaces the NumberingSequence resource.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "NumberingSequence identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"requestBody": {
"description": "The updated NumberingSequence resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/NumberingSequence.NumberingSequenceUpdateInput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NumberingSequence.NumberingSequenceUpdateInput"
}
}
},
"required": true
},
"deprecated": false
},
"delete": {
"operationId": "api_numbering-sequences_uuid_delete",
"tags": [
"NumberingSequence"
],
"responses": {
"204": {
"description": "NumberingSequence resource deleted"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Removes the NumberingSequence resource.",
"description": "Removes the NumberingSequence resource.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "NumberingSequence identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/invoices/{id}/preserved-document": {
"get": {
"operationId": "api_invoices_idpreserved-document_get",
"tags": [
"PreservedDocument"
],
"responses": {
"200": {
"description": "PreservedDocument resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/PreservedDocument.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PreservedDocument-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/PreservedDocument-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PreservedDocument-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/PreservedDocument-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/PreservedDocument-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/PreservedDocument-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/PreservedDocument-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/PreservedDocument-read"
}
}
}
},
"404": {
"description": "Resource not found"
}
},
"summary": "Retrieves a PreservedDocument resource.",
"description": "Retrieves a PreservedDocument resource.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "PreservedDocument identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/preserved-documents": {
"get": {
"operationId": "api_preserved-documents_get_collection",
"tags": [
"PreservedDocument"
],
"responses": {
"200": {
"description": "PreservedDocument collection",
"content": {
"application/ld+json": {
"schema": {
"type": "object",
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreservedDocument.jsonld-read"
}
},
"hydra:totalItems": {
"type": "integer",
"minimum": 0
},
"hydra:view": {
"type": "object",
"properties": {
"@id": {
"type": "string",
"format": "iri-reference"
},
"@type": {
"type": "string"
},
"hydra:first": {
"type": "string",
"format": "iri-reference"
},
"hydra:last": {
"type": "string",
"format": "iri-reference"
},
"hydra:previous": {
"type": "string",
"format": "iri-reference"
},
"hydra:next": {
"type": "string",
"format": "iri-reference"
}
},
"example": {
"@id": "string",
"type": "string",
"hydra:first": "string",
"hydra:last": "string",
"hydra:previous": "string",
"hydra:next": "string"
}
},
"hydra:search": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"hydra:template": {
"type": "string"
},
"hydra:variableRepresentation": {
"type": "string"
},
"hydra:mapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"variable": {
"type": "string"
},
"property": {
"type": [
"string",
"null"
]
},
"required": {
"type": "boolean"
}
}
}
}
}
}
},
"required": [
"hydra:member"
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreservedDocument-read"
}
}
},
"text/html": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreservedDocument-read"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreservedDocument-read"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreservedDocument-read"
}
}
},
"application/octet-stream": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreservedDocument-read"
}
}
},
"application/pdf": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreservedDocument-read"
}
}
},
"application/zip": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreservedDocument-read"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreservedDocument-read"
}
}
}
}
}
},
"summary": "Retrieves the collection of PreservedDocument resources.",
"description": "Retrieves the collection of PreservedDocument resources.",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The collection page number",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 1
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "itemsPerPage",
"in": "query",
"description": "The number of items per page",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 30,
"minimum": 0,
"maximum": 100
},
"style": "form",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/preserved-documents/{uuid}": {
"get": {
"operationId": "api_preserved-documents_uuid_get",
"tags": [
"PreservedDocument"
],
"responses": {
"200": {
"description": "PreservedDocument resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/PreservedDocument.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PreservedDocument-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/PreservedDocument-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PreservedDocument-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/PreservedDocument-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/PreservedDocument-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/PreservedDocument-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/PreservedDocument-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/PreservedDocument-read"
}
}
}
},
"404": {
"description": "Resource not found"
}
},
"summary": "Retrieves a PreservedDocument resource.",
"description": "Retrieves a PreservedDocument resource.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "PreservedDocument identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/preserved-documents/{uuid}/receipt": {
"get": {
"operationId": "api_preserved_document_get_receipt",
"tags": [
"PreservedDocumentReceipt"
],
"responses": {
"200": {
"description": "PreservedDocumentReceipt resource",
"content": {
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PreservedDocumentReceipt"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/PreservedDocumentReceipt"
}
}
}
},
"404": {
"description": "Resource not found"
}
},
"summary": "Retrieve the XML receipt for a preserved document.",
"description": "You will get the original XML receipt from the legal storage, the Content-Type is application/xml.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/receipts": {
"get": {
"operationId": "api_receipts_get_collection",
"tags": [
"Receipt"
],
"responses": {
"200": {
"description": "Receipt collection",
"content": {
"application/ld+json": {
"schema": {
"type": "object",
"properties": {
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput.jsonld"
}
},
"hydra:totalItems": {
"type": "integer",
"minimum": 0
},
"hydra:view": {
"type": "object",
"properties": {
"@id": {
"type": "string",
"format": "iri-reference"
},
"@type": {
"type": "string"
},
"hydra:first": {
"type": "string",
"format": "iri-reference"
},
"hydra:last": {
"type": "string",
"format": "iri-reference"
},
"hydra:previous": {
"type": "string",
"format": "iri-reference"
},
"hydra:next": {
"type": "string",
"format": "iri-reference"
}
},
"example": {
"@id": "string",
"type": "string",
"hydra:first": "string",
"hydra:last": "string",
"hydra:previous": "string",
"hydra:next": "string"
}
},
"hydra:search": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"hydra:template": {
"type": "string"
},
"hydra:variableRepresentation": {
"type": "string"
},
"hydra:mapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"variable": {
"type": "string"
},
"property": {
"type": [
"string",
"null"
]
},
"required": {
"type": "boolean"
}
}
}
}
}
}
},
"required": [
"hydra:member"
]
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
}
},
"text/html": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
}
},
"application/octet-stream": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
}
},
"application/pdf": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
}
},
"application/zip": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
}
}
}
}
},
"summary": "Get a list of electronic receipts",
"description": "Get a list of electronic receipts. Notes on fields. `return_receipts` can contain a list of receipts that retrurn items from the current one, i.e. this is a 'parent' receipt and `return_receipts` are its 'children' that return items from it. `returned_receipt` could be the 'parent' receipt the current one is returning item from; in this case the type of the current receipt will be `return`. The same holds for `voiding_receipt` that is the receipt that voids the current one and `voided_receipt` that is the receipt voided by the current one; in this case the type of the current receipt will be `void`.",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The collection page number",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 1
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "itemsPerPage",
"in": "query",
"description": "The number of items per page",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 30,
"minimum": 0,
"maximum": 100
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "business_registry_configuration.fiscal_id",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "business_registry_configuration.fiscal_id[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "document_number",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "document_number[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "status",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "status[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "type",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "type[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "created_at[before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[strictly_before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[strictly_after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "document_date[before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "document_date[strictly_before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "document_date[after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "document_date[strictly_after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
},
"post": {
"operationId": "api_receipts_post",
"tags": [
"Receipt"
],
"responses": {
"201": {
"description": "Receipt resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Create a new electronic receipt",
"description": "Create a new electronic receipt",
"parameters": [],
"requestBody": {
"description": "The new Receipt resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptInput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptInput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptInput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptInput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptInput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptInput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptInput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptInput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptInput"
}
}
},
"required": true
},
"deprecated": false
}
},
"/receipts/report": {
"get": {
"operationId": "api_receipts_report_collection",
"tags": [
"Receipt"
],
"responses": {
"200": {
"description": "Receipt collection",
"content": {
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Receipt.ReceiptReport"
}
}
}
}
}
},
"summary": "Get a Report of Receipts",
"description": "Get a list of receipts in a .csv format. Note that the maximum number of receipts that can be retrieved in the document is 5000. ",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The collection page number",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 1
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "itemsPerPage",
"in": "query",
"description": "The number of items per page",
"required": false,
"deprecated": false,
"allowEmptyValue": true,
"schema": {
"type": "integer",
"default": 5000,
"minimum": 0,
"maximum": 5000
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "business_registry_configuration.fiscal_id",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "business_registry_configuration.fiscal_id[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "document_number",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "document_number[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "status",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "status[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "type",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "type[]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"allowReserved": false
},
{
"name": "created_at[before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[strictly_before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "created_at[strictly_after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "document_date[before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "document_date[strictly_before]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "document_date[after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "document_date[strictly_after]",
"in": "query",
"description": "",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "form",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/receipts/{uuid}": {
"get": {
"operationId": "api_receipts_uuid_get",
"tags": [
"Receipt"
],
"responses": {
"200": {
"description": "Receipt resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
}
}
},
"404": {
"description": "Resource not found"
}
},
"summary": "Get an electronic receipt",
"description": "Get an electronic receipt.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The uuid that A-Cube assigned to the receipt",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
},
"delete": {
"operationId": "receipt_void",
"tags": [
"Receipt"
],
"responses": {
"204": {
"description": "Receipt resource deleted"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Void an electronic receipt",
"description": "Void an electronic receipt. Only receipts in `submitted` and `ready` status can be voided.",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The uuid that A-Cube assigned to the receipt",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/receipts/{uuid}/details": {
"get": {
"operationId": "receipt_details",
"tags": [
"Receipt"
],
"responses": {
"200": {
"description": "Receipt details"
},
"404": {
"description": "Resource not found"
},
"409": {
"description": "Document still being processed, please retry later"
}
},
"summary": "Get the details or the PDF of an electronic receipt",
"description": "Get the details of an electronic receipt, or the receipt PDF itself if the `Accept: application/pdf` header is sent",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The uuid that A-Cube assigned to the receipt",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/receipts/{uuid}/return": {
"post": {
"operationId": "receipt_return",
"tags": [
"Receipt"
],
"responses": {
"201": {
"description": "Receipt resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptOutput"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Return items an electronic receipt",
"description": "Return items an electronic receipt",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The uuid that A-Cube assigned to the receipt",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"requestBody": {
"description": "The new Receipt resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptReturnInput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptReturnInput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptReturnInput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptReturnInput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptReturnInput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptReturnInput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptReturnInput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptReturnInput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Receipt.ReceiptReturnInput"
}
}
},
"required": true
},
"deprecated": false
}
},
"/rejected-invoices/{fiscalId}/count": {
"get": {
"operationId": "countRejectedInvoices",
"tags": [
"RejectedInvoice"
],
"responses": {
"400": {
"description": "Invalid input"
},
"404": {
"description": "Invalid fiscal ID"
},
"200": {
"description": "RejectedInvoice resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.CountOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.CountOutput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.CountOutput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.CountOutput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.CountOutput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.CountOutput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.CountOutput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.CountOutput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.CountOutput"
}
}
}
}
},
"summary": "Get the number of rejected invoices for a fiscal ID",
"description": "Get the number of rejected invoices for a fiscal ID",
"parameters": [
{
"name": "fiscalId",
"in": "path",
"description": "The fiscal identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "from_date",
"in": "query",
"description": "The start date",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"format": "date"
},
"style": "form",
"explode": false,
"allowReserved": false
},
{
"name": "to_date",
"in": "query",
"description": "The end date",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"format": "date"
},
"style": "form",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/rejected-invoices/{fiscalId}/recover": {
"post": {
"operationId": "recoverRejectedInvoices",
"tags": [
"RejectedInvoice"
],
"responses": {
"400": {
"description": "Invalid input"
},
"404": {
"description": "No rejected invoices available for recovery"
},
"200": {
"description": "RejectedInvoice resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.RecoverOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.RecoverOutput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.RecoverOutput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.RecoverOutput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.RecoverOutput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.RecoverOutput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.RecoverOutput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.RecoverOutput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.RecoverOutput"
}
}
},
"links": {}
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Recover rejected invoices for a fiscal ID",
"description": "Recover rejected invoices for a fiscal ID",
"parameters": [
{
"name": "fiscalId",
"in": "path",
"description": "The fiscal identifier",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"requestBody": {
"description": "The new RejectedInvoice resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.RecoverInput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.RecoverInput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.RecoverInput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.RecoverInput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.RecoverInput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.RecoverInput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.RecoverInput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.RecoverInput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/RejectedInvoice.RecoverInput"
}
}
},
"required": true
},
"deprecated": false
}
},
"/schedule": {
"post": {
"operationId": "api_schedule_post",
"tags": [
"Schedule"
],
"responses": {
"201": {
"description": "Schedule resource created",
"content": {
"application/ld+json": {
"schema": {}
},
"application/json": {
"schema": {}
},
"text/html": {
"schema": {}
},
"application/xml": {
"schema": {}
},
"text/xml": {
"schema": {}
},
"application/octet-stream": {
"schema": {}
},
"application/pdf": {
"schema": {}
},
"application/zip": {
"schema": {}
},
"text/csv": {
"schema": {}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Creates a Schedule resource.",
"description": "Creates a Schedule resource.",
"parameters": [],
"requestBody": {
"description": "The new Schedule resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Schedule.ScheduleInput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Schedule.ScheduleInput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Schedule.ScheduleInput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Schedule.ScheduleInput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Schedule.ScheduleInput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Schedule.ScheduleInput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Schedule.ScheduleInput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Schedule.ScheduleInput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Schedule.ScheduleInput"
}
}
},
"required": true
},
"deprecated": false
}
},
"/schedule/{job_type}/{fiscal_id}": {
"get": {
"operationId": "api_schedule_job_type_fiscal_id_get",
"tags": [
"Schedule"
],
"responses": {
"200": {
"description": "Schedule resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Schedule.UnifiedScheduleOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Schedule.UnifiedScheduleOutput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Schedule.UnifiedScheduleOutput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Schedule.UnifiedScheduleOutput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Schedule.UnifiedScheduleOutput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Schedule.UnifiedScheduleOutput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Schedule.UnifiedScheduleOutput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Schedule.UnifiedScheduleOutput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Schedule.UnifiedScheduleOutput"
}
}
}
},
"404": {
"description": "Resource not found"
}
},
"summary": "Retrieves a Schedule resource.",
"description": "Retrieves a Schedule resource.",
"parameters": [
{
"name": "job_type",
"in": "path",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"enum": [
"invoice-download",
"invoice-report-download",
"invoice-zip-download"
]
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "fiscal_id",
"in": "path",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
},
"put": {
"operationId": "api_schedule_job_type_fiscal_id_put",
"tags": [
"Schedule"
],
"responses": {
"202": {
"description": "Schedule resource updated",
"content": {
"application/ld+json": {
"schema": {}
},
"application/json": {
"schema": {}
},
"text/html": {
"schema": {}
},
"application/xml": {
"schema": {}
},
"text/xml": {
"schema": {}
},
"application/octet-stream": {
"schema": {}
},
"application/pdf": {
"schema": {}
},
"application/zip": {
"schema": {}
},
"text/csv": {
"schema": {}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Replaces the Schedule resource.",
"description": "Replaces the Schedule resource.",
"parameters": [
{
"name": "job_type",
"in": "path",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"enum": [
"invoice-download",
"invoice-report-download",
"invoice-zip-download"
]
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "fiscal_id",
"in": "path",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
},
"post": {
"operationId": "api_schedule_job_type_fiscal_id_post",
"tags": [
"Schedule"
],
"responses": {
"201": {
"description": "Schedule resource created",
"content": {
"application/ld+json": {
"schema": {}
},
"application/json": {
"schema": {}
},
"text/html": {
"schema": {}
},
"application/xml": {
"schema": {}
},
"text/xml": {
"schema": {}
},
"application/octet-stream": {
"schema": {}
},
"application/pdf": {
"schema": {}
},
"application/zip": {
"schema": {}
},
"text/csv": {
"schema": {}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Creates a Schedule resource.",
"description": "Creates a Schedule resource.",
"parameters": [
{
"name": "job_type",
"in": "path",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"enum": [
"invoice-download",
"invoice-report-download",
"invoice-zip-download"
]
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "fiscal_id",
"in": "path",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"requestBody": {
"description": "The new Schedule resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/Schedule.LegacyScheduleInput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Schedule.LegacyScheduleInput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/Schedule.LegacyScheduleInput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Schedule.LegacyScheduleInput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Schedule.LegacyScheduleInput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Schedule.LegacyScheduleInput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/Schedule.LegacyScheduleInput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/Schedule.LegacyScheduleInput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Schedule.LegacyScheduleInput"
}
}
},
"required": true
},
"deprecated": false
},
"delete": {
"operationId": "api_schedule_job_type_fiscal_id_delete",
"tags": [
"Schedule"
],
"responses": {
"204": {
"description": "Schedule resource deleted"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Removes the Schedule resource.",
"description": "Removes the Schedule resource.",
"parameters": [
{
"name": "job_type",
"in": "path",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"enum": [
"invoice-download",
"invoice-report-download"
]
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "fiscal_id",
"in": "path",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/verify/company/simple/{id}": {
"get": {
"operationId": "api_verifycompanysimple_id_get",
"tags": [
"SimpleCompany"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SimpleCompany-read"
}
},
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/SimpleCompany.jsonld-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SimpleCompany-read"
}
}
}
},
"406": {
"description": "Not acceptable - Fiscal id or vat number not valid"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Retrieve basic information about a company",
"description": "This service allows you to return basic information of a company by VAT number or fiscal id",
"parameters": [
{
"name": "id",
"in": "path",
"description": "VAT number WITHOUT the country prefix, fiscal id",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
},
{
"name": "check-split",
"in": "query",
"description": "Whether to include split payment information. **WARNING**: Setting this parameter to true will also trigger the split payment verification endpoint, resulting in charges for both services",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "boolean"
},
"style": "form",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/verify/split/{id}": {
"get": {
"operationId": "api_verifysplit_id_get",
"tags": [
"SplitpaymentCompany"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SplitpaymentCompany"
}
},
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/SplitpaymentCompany.jsonld"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SplitpaymentCompany"
}
}
}
},
"404": {
"description": "No company found - This company is not subject to split payment"
}
},
"summary": "Check if a company is subject to split-payment",
"description": "Check if a company is subject to split-payment, that are with VAT taxes paid by the public administration",
"parameters": [
{
"name": "id",
"in": "path",
"description": "VAT number WITHOUT the country prefix, fiscal id",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/supplier-invoice-imports": {
"post": {
"operationId": "api_supplier-invoice-imports_post",
"tags": [
"SupplierInvoiceImport"
],
"responses": {
"201": {
"description": "SupplierInvoiceImport resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/SupplierInvoiceImport.SupplierInvoiceImportOutput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SupplierInvoiceImport.SupplierInvoiceImportOutput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/SupplierInvoiceImport.SupplierInvoiceImportOutput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SupplierInvoiceImport.SupplierInvoiceImportOutput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/SupplierInvoiceImport.SupplierInvoiceImportOutput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/SupplierInvoiceImport.SupplierInvoiceImportOutput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/SupplierInvoiceImport.SupplierInvoiceImportOutput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/SupplierInvoiceImport.SupplierInvoiceImportOutput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/SupplierInvoiceImport.SupplierInvoiceImportOutput"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Import supplier invoice",
"description": "Import a supplier invoice that was already received from SDI. The invoice will be sent to the legal storage if necessary",
"parameters": [],
"requestBody": {
"description": "The new SupplierInvoiceImport resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/SupplierInvoiceImport.SupplierInvoiceImportInput.jsonld"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SupplierInvoiceImport.SupplierInvoiceImportInput"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/SupplierInvoiceImport.SupplierInvoiceImportInput"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SupplierInvoiceImport.SupplierInvoiceImportInput"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/SupplierInvoiceImport.SupplierInvoiceImportInput"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/SupplierInvoiceImport.SupplierInvoiceImportInput"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/SupplierInvoiceImport.SupplierInvoiceImportInput"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/SupplierInvoiceImport.SupplierInvoiceImportInput"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/SupplierInvoiceImport.SupplierInvoiceImportInput"
}
}
},
"required": true
},
"deprecated": false
}
},
"/users/{id}/accept-only-verified-invoices": {
"get": {
"operationId": "get_accept_only",
"tags": [
"UserEntity"
],
"responses": {
"200": {
"description": "UserEntity resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/UserEntity.jsonld-read-accept-only"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserEntity-read-accept-only"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/UserEntity-read-accept-only"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/UserEntity-read-accept-only"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/UserEntity-read-accept-only"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/UserEntity-read-accept-only"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/UserEntity-read-accept-only"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/UserEntity-read-accept-only"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/UserEntity-read-accept-only"
}
}
}
},
"404": {
"description": "Resource not found"
}
},
"summary": "Get verified supplier invoices status",
"description": "Get verified supplier invoices status. When this check is enabled, only supplier invoices from registered vat numbers into the BusinessRegistryConfiguration will be accepted.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"enum": [
"me"
]
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
},
"put": {
"operationId": "put_accept_only",
"tags": [
"UserEntity"
],
"responses": {
"200": {
"description": "UserEntity resource updated",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/UserEntity.jsonld-read-accept-only"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserEntity-read-accept-only"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/UserEntity-read-accept-only"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/UserEntity-read-accept-only"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/UserEntity-read-accept-only"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/UserEntity-read-accept-only"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/UserEntity-read-accept-only"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/UserEntity-read-accept-only"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/UserEntity-read-accept-only"
}
}
},
"links": {}
},
"400": {
"description": "Invalid input"
},
"422": {
"description": "Unprocessable entity"
},
"404": {
"description": "Resource not found"
}
},
"summary": "Set verified supplier invoices status",
"description": "Update the verified supplier invoices status. When this check is enabled, only supplier invoices from registered vat numbers into the BusinessRegistryConfiguration will be accepted.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"enum": [
"me"
]
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"requestBody": {
"description": "The updated UserEntity resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/UserEntity.jsonld-write-accept-only"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserEntity-write-accept-only"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/UserEntity-write-accept-only"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/UserEntity-write-accept-only"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/UserEntity-write-accept-only"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/UserEntity-write-accept-only"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/UserEntity-write-accept-only"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/UserEntity-write-accept-only"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/UserEntity-write-accept-only"
}
}
},
"required": true
},
"deprecated": false
}
},
"/users/{id}/recipient-code": {
"get": {
"operationId": "get_recipient_code",
"tags": [
"UserEntity"
],
"responses": {
"200": {
"description": "UserEntity resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/UserEntity.UserRecipientCodeOutput.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserEntity.UserRecipientCodeOutput-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/UserEntity.UserRecipientCodeOutput-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/UserEntity.UserRecipientCodeOutput-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/UserEntity.UserRecipientCodeOutput-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/UserEntity.UserRecipientCodeOutput-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/UserEntity.UserRecipientCodeOutput-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/UserEntity.UserRecipientCodeOutput-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/UserEntity.UserRecipientCodeOutput-read"
}
}
}
},
"404": {
"description": "Resource not found"
}
},
"summary": "Get your 7 chars recipient code.",
"description": "Retrieves a UserEntity resource.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"enum": [
"me"
]
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/users/{id}/settings": {
"get": {
"operationId": "get_user_settings",
"tags": [
"UserEntity"
],
"responses": {
"200": {
"description": "UserEntity resource",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/UserEntity.jsonld-read_setting"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserEntity-read_setting"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/UserEntity-read_setting"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/UserEntity-read_setting"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/UserEntity-read_setting"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/UserEntity-read_setting"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/UserEntity-read_setting"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/UserEntity-read_setting"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/UserEntity-read_setting"
}
}
}
},
"404": {
"description": "Resource not found"
}
},
"summary": "Get user settings details",
"description": "Retrieves a UserEntity resource.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"enum": [
"me"
]
},
"style": "simple",
"explode": false,
"allowReserved": false
}
],
"deprecated": false
}
},
"/invoices/simplified/draft": {
"post": {
"operationId": "api_invoice_simplifieds_draft_collection",
"tags": [
"draft"
],
"responses": {
"400": {
"description": "Invalid input"
},
"201": {
"description": "draft resource created",
"content": {
"application/ld+json": {
"schema": {
"$ref": "#/components/schemas/draft.InvoiceSimplifiedOutput.jsonld-read"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/draft.InvoiceSimplifiedOutput-read"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/draft.InvoiceSimplifiedOutput-read"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/draft.InvoiceSimplifiedOutput-read"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/draft.InvoiceSimplifiedOutput-read"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/draft.InvoiceSimplifiedOutput-read"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/draft.InvoiceSimplifiedOutput-read"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/draft.InvoiceSimplifiedOutput-read"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/draft.InvoiceSimplifiedOutput-read"
}
}
},
"links": {}
},
"422": {
"description": "Unprocessable entity"
}
},
"summary": "Creates a new InvoiceSimplified resource in draft mode",
"description": "Creates a new Simplified Invoice (FatturaElettronicaSemplificata FSM10) in draft mode. The invoice will not be sent to the SDI until it is explicitly requested.",
"parameters": [],
"requestBody": {
"description": "The new draft resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/draft.InvoiceSimplifiedDraftInput-write"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/draft.InvoiceSimplifiedDraftInput-write"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/draft.InvoiceSimplifiedDraftInput-write"
}
}
},
"required": true
},
"deprecated": false
}
}
},
"components": {
"schemas": {
"Address-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"address": {
"description": "Italian Indirizzo",
"type": [
"string",
"null"
],
"example": "VIA ROMA, 1"
},
"toponym": {
"description": "Italian Toponimo",
"type": [
"string",
"null"
],
"example": "VIA"
},
"street": {
"description": "Italian Via",
"type": [
"string",
"null"
],
"example": "ROMA"
},
"house_number": {
"description": "Italian Numero Civico",
"type": [
"string",
"null"
],
"example": "1"
},
"municipality": {
"description": "Italian Comune",
"type": [
"string",
"null"
],
"example": "MILANO"
},
"hamlet": {
"description": "Italian Frazione",
"type": [
"string",
"null"
],
"example": "MILANO"
},
"province": {
"description": "Italian Provincia",
"type": [
"string",
"null"
],
"example": "MI"
},
"postal_code": {
"description": "Italian CAP",
"type": [
"string",
"null"
],
"example": "20100"
}
}
},
"Address.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"address": {
"description": "Italian Indirizzo",
"type": [
"string",
"null"
],
"example": "VIA ROMA, 1"
},
"toponym": {
"description": "Italian Toponimo",
"type": [
"string",
"null"
],
"example": "VIA"
},
"street": {
"description": "Italian Via",
"type": [
"string",
"null"
],
"example": "ROMA"
},
"house_number": {
"description": "Italian Numero Civico",
"type": [
"string",
"null"
],
"example": "1"
},
"municipality": {
"description": "Italian Comune",
"type": [
"string",
"null"
],
"example": "MILANO"
},
"hamlet": {
"description": "Italian Frazione",
"type": [
"string",
"null"
],
"example": "MILANO"
},
"province": {
"description": "Italian Provincia",
"type": [
"string",
"null"
],
"example": "MI"
},
"postal_code": {
"description": "Italian CAP",
"type": [
"string",
"null"
],
"example": "20100"
}
}
},
"AdeAppointee-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id": {
"readOnly": true,
"type": "integer"
},
"name": {
"type": "string"
},
"fiscal_id": {
"type": "string"
},
"email": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"proxy_fiscal_id": {
"type": [
"string",
"null"
]
},
"owner_id": {
"readOnly": true,
"type": [
"string",
"null"
]
}
}
},
"AdeAppointee.AdeAppointeeAssignInput-write": {
"type": "object",
"description": "",
"deprecated": false
},
"AdeAppointee.AdeAppointeeAssignInput.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false
},
"AdeAppointee.AdeAppointeeCredentialsInput-write": {
"type": "object",
"description": "",
"deprecated": false
},
"AdeAppointee.AdeAppointeeCredentialsInput.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false
},
"AdeAppointee.AdeAppointeeInput-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"name",
"fiscal_id",
"email",
"phone_number"
],
"properties": {
"name": {
"type": "string"
},
"fiscal_id": {
"type": "string"
},
"email": {
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": "string"
},
"phone_number": {
"pattern": "^(\\+\\d{8,})$",
"type": [
"string",
"null"
]
},
"owner_id": {
"type": [
"integer",
"null"
]
},
"proxy_fiscal_id": {
"type": [
"string",
"null"
]
}
}
},
"AdeAppointee.AdeAppointeeInput.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"name",
"fiscal_id",
"email",
"phone_number"
],
"properties": {
"name": {
"type": "string"
},
"fiscal_id": {
"type": "string"
},
"email": {
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": "string"
},
"phone_number": {
"pattern": "^(\\+\\d{8,})$",
"type": [
"string",
"null"
]
},
"owner_id": {
"type": [
"integer",
"null"
]
},
"proxy_fiscal_id": {
"type": [
"string",
"null"
]
}
}
},
"AdeAppointee.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"id": {
"readOnly": true,
"type": "integer"
},
"name": {
"type": "string"
},
"fiscal_id": {
"type": "string"
},
"email": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"proxy_fiscal_id": {
"type": [
"string",
"null"
]
},
"owner_id": {
"readOnly": true,
"type": [
"string",
"null"
]
}
}
},
"Allegati-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"nome_attachment",
"attachment"
],
"properties": {
"nome_attachment": {
"minLength": 1,
"maxLength": 60,
"type": "string"
},
"algoritmo_compressione": {
"minLength": 1,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"formato_attachment": {
"minLength": 1,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"descrizione_attachment": {
"minLength": 1,
"maxLength": 100,
"type": [
"string",
"null"
]
},
"attachment": {}
}
},
"AltriDatiGestionali-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"tipo_dato"
],
"properties": {
"tipo_dato": {
"minLength": 1,
"maxLength": 10,
"description": "Code that identifies the type of information",
"type": "string"
},
"riferimento_testo": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"riferimento_numero": {
"minLength": 4,
"maxLength": 21,
"type": [
"string",
"null"
]
},
"riferimento_data": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
},
"AltriDatiIdentificativi-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"denominazione": {
"minLength": 1,
"maxLength": 80,
"description": "Company name, to be filled in case 'nome' and 'cognome' are empty",
"type": [
"string",
"null"
]
},
"nome": {
"minLength": 1,
"maxLength": 60,
"description": "Physical person's name, to be filled with 'cognome' in case 'denominazione' is empty",
"type": [
"string",
"null"
]
},
"cognome": {
"minLength": 1,
"maxLength": 60,
"description": "Physical person's surname, to be filled with 'name' in case 'denominazione' is empty",
"type": [
"string",
"null"
]
},
"sede": {
"$ref": "#/components/schemas/Indirizzo-write"
},
"stabile_organizzazione": {
"anyOf": [
{
"$ref": "#/components/schemas/Indirizzo-write"
},
{
"type": "null"
}
]
},
"rappresentante_fiscale": {
"anyOf": [
{
"$ref": "#/components/schemas/RappresentanteFiscale-write"
},
{
"type": "null"
}
]
}
},
"required": [
"sede"
]
},
"Anagrafica-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"denominazione": {
"minLength": 1,
"maxLength": 80,
"description": "Company name, to be filled in case 'nome' and 'cognome' are empty",
"type": [
"string",
"null"
]
},
"nome": {
"minLength": 1,
"maxLength": 60,
"description": "Physical person's name, to be filled with 'cognome' in case 'denominazione' is empty",
"type": [
"string",
"null"
]
},
"cognome": {
"minLength": 1,
"maxLength": 60,
"description": "Physical person's surname, to be filled with 'name' in case 'denominazione' is empty",
"type": [
"string",
"null"
]
},
"titolo": {
"minLength": 2,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"cod_eori": {
"minLength": 13,
"maxLength": 17,
"description": "Economic Operator Registration and Identification",
"type": [
"string",
"null"
]
}
}
},
"ApiConfiguration-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"uuid": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"event": {
"description": "The event code can be one of `supplier-invoice`, `customer-invoice`, `customer-notification`, `invoice-status-quarantena`, `invoice-status-invoice-error`, `legal-storage-missing-vat`, `legal-storage-receipt`. `receipt`, `receipt-credentials`, `receipt-retry`, `receipt-error`, `appointee`",
"type": "string"
},
"target_url": {
"format": "uri",
"description": "Full URL to your endpoint",
"externalDocs": {
"url": "https://schema.org/url"
},
"type": "string"
},
"authentication_type": {
"enum": [
"query",
"header"
],
"description": "Authentication type can be one of `query`, `header`",
"type": [
"string",
"null"
]
},
"authentication_key": {
"description": "The authentication key ,\n in case of type header used as `Authorization: authentication_key authentication_token `",
"type": [
"string",
"null"
]
},
"authentication_token": {
"description": "The authentication token ,\n in case of type header used as `Authorization: authentication_key authentication_token `",
"type": [
"string",
"null"
]
},
"business_registry_configurations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration-read"
}
}
}
},
"ApiConfiguration-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"event": {
"description": "The event code can be one of `supplier-invoice`, `customer-invoice`, `customer-notification`, `invoice-status-quarantena`, `invoice-status-invoice-error`, `legal-storage-missing-vat`, `legal-storage-receipt`. `receipt`, `receipt-credentials`, `receipt-retry`, `receipt-error`, `appointee`",
"type": "string"
},
"target_url": {
"format": "uri",
"description": "Full URL to your endpoint",
"externalDocs": {
"url": "https://schema.org/url"
},
"type": "string"
},
"authentication_type": {
"enum": [
"query",
"header"
],
"description": "Authentication type can be one of `query`, `header`",
"type": [
"string",
"null"
]
},
"authentication_key": {
"description": "The authentication key ,\n in case of type header used as `Authorization: authentication_key authentication_token `",
"type": [
"string",
"null"
]
},
"authentication_token": {
"description": "The authentication token ,\n in case of type header used as `Authorization: authentication_key authentication_token `",
"type": [
"string",
"null"
]
}
}
},
"ApiConfiguration.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"uuid": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"event": {
"description": "The event code can be one of `supplier-invoice`, `customer-invoice`, `customer-notification`, `invoice-status-quarantena`, `invoice-status-invoice-error`, `legal-storage-missing-vat`, `legal-storage-receipt`. `receipt`, `receipt-credentials`, `receipt-retry`, `receipt-error`, `appointee`",
"type": "string"
},
"target_url": {
"format": "uri",
"description": "Full URL to your endpoint",
"externalDocs": {
"url": "https://schema.org/url"
},
"type": "string"
},
"authentication_type": {
"enum": [
"query",
"header"
],
"description": "Authentication type can be one of `query`, `header`",
"type": [
"string",
"null"
]
},
"authentication_key": {
"description": "The authentication key ,\n in case of type header used as `Authorization: authentication_key authentication_token `",
"type": [
"string",
"null"
]
},
"authentication_token": {
"description": "The authentication token ,\n in case of type header used as `Authorization: authentication_key authentication_token `",
"type": [
"string",
"null"
]
},
"business_registry_configurations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessRegistryConfiguration.jsonld-read"
}
}
}
},
"ApiConfiguration.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"event": {
"description": "The event code can be one of `supplier-invoice`, `customer-invoice`, `customer-notification`, `invoice-status-quarantena`, `invoice-status-invoice-error`, `legal-storage-missing-vat`, `legal-storage-receipt`. `receipt`, `receipt-credentials`, `receipt-retry`, `receipt-error`, `appointee`",
"type": "string"
},
"target_url": {
"format": "uri",
"description": "Full URL to your endpoint",
"externalDocs": {
"url": "https://schema.org/url"
},
"type": "string"
},
"authentication_type": {
"enum": [
"query",
"header"
],
"description": "Authentication type can be one of `query`, `header`",
"type": [
"string",
"null"
]
},
"authentication_key": {
"description": "The authentication key ,\n in case of type header used as `Authorization: authentication_key authentication_token `",
"type": [
"string",
"null"
]
},
"authentication_token": {
"description": "The authentication token ,\n in case of type header used as `Authorization: authentication_key authentication_token `",
"type": [
"string",
"null"
]
}
}
},
"BusinessRegistry-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"uuid": {
"type": "string",
"format": "uuid"
},
"head_office_address_street": {
"type": "string"
},
"head_office_address_street_number": {
"type": [
"string",
"null"
]
},
"head_office_address_zip_code": {
"type": "string"
},
"head_office_address_city": {
"type": "string"
},
"head_office_address_province": {
"type": [
"string",
"null"
]
},
"head_office_address_country": {
"description": "ISO 3166-1 alpha-2 code",
"type": "string"
},
"office_address_street": {
"type": [
"string",
"null"
]
},
"office_address_street_number": {
"type": [
"string",
"null"
]
},
"office_address_zip_code": {
"type": [
"string",
"null"
]
},
"office_address_city": {
"type": [
"string",
"null"
]
},
"office_address_province": {
"type": [
"string",
"null"
]
},
"office_address_country": {
"description": "ISO 3166-1 alpha-2 code",
"type": [
"string",
"null"
]
},
"business_vat_number_country": {
"description": "ISO 3166-1 alpha-2 code",
"type": [
"string",
"null"
]
},
"business_vat_number_code": {
"minLength": 1,
"maxLength": 28,
"type": [
"string",
"null"
]
},
"business_fiscal_code": {
"minLength": 11,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"business_name": {
"type": [
"string",
"null"
]
},
"name": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"surname": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"title": {
"minLength": 2,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"cod_eori": {
"minLength": 13,
"maxLength": 17,
"type": [
"string",
"null"
]
},
"professional_register": {
"type": [
"string",
"null"
]
},
"professional_register_province": {
"type": [
"string",
"null"
]
},
"professional_register_registration_number": {
"type": [
"string",
"null"
]
},
"professional_register_registration_date": {
"description": "ISO 8601:2004 (YYYY-MM-DD)",
"type": [
"string",
"null"
],
"format": "date-time"
},
"tax_regime": {
"type": [
"string",
"null"
]
},
"contact_phone": {
"type": [
"string",
"null"
]
},
"contact_fax": {
"type": [
"string",
"null"
]
},
"contact_email": {
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
},
"rea_registration_office": {
"minLength": 2,
"maxLength": 2,
"description": "2 chars Italian province",
"type": [
"string",
"null"
]
},
"rea_registration_number": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
},
"rea_registration_share_capital": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"rea_registration_sole_shareholder": {
"enum": [
"SU",
"SM"
],
"description": "SU sole shareholder, SM many shareholders",
"type": [
"string",
"null"
]
},
"rea_registration_liquidation_status": {
"enum": [
"LS",
"LN"
],
"description": "LS in liquidation, LN not in liquidation",
"type": [
"string",
"null"
]
},
"reference_administration": {
"type": [
"string",
"null"
]
},
"fiscal_representative_vat_number_country": {
"description": "ISO 3166-1 alpha-2 code",
"type": [
"string",
"null"
]
},
"fiscal_representative_vat_number_code": {
"type": [
"string",
"null"
]
},
"fiscal_representative_fiscal_code": {
"type": [
"string",
"null"
]
},
"fiscal_representative_denomination": {
"type": [
"string",
"null"
]
},
"fiscal_representative_name": {
"type": [
"string",
"null"
]
},
"fiscal_representative_surname": {
"type": [
"string",
"null"
]
},
"fiscal_representative_title": {
"type": [
"string",
"null"
]
},
"fiscal_representative_cod_eori": {
"type": [
"string",
"null"
]
},
"recipient_code": {
"type": [
"string",
"null"
]
},
"pec": {
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
}
},
"required": [
"head_office_address_street",
"head_office_address_zip_code",
"head_office_address_city",
"head_office_address_country"
]
},
"BusinessRegistry-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"head_office_address_street",
"head_office_address_zip_code",
"head_office_address_city",
"head_office_address_country"
],
"properties": {
"head_office_address_street": {
"type": "string"
},
"head_office_address_street_number": {
"type": [
"string",
"null"
]
},
"head_office_address_zip_code": {
"type": "string"
},
"head_office_address_city": {
"type": "string"
},
"head_office_address_province": {
"type": [
"string",
"null"
]
},
"head_office_address_country": {
"description": "ISO 3166-1 alpha-2 code",
"type": "string"
},
"office_address_street": {
"type": [
"string",
"null"
]
},
"office_address_street_number": {
"type": [
"string",
"null"
]
},
"office_address_zip_code": {
"type": [
"string",
"null"
]
},
"office_address_city": {
"type": [
"string",
"null"
]
},
"office_address_province": {
"type": [
"string",
"null"
]
},
"office_address_country": {
"description": "ISO 3166-1 alpha-2 code",
"type": [
"string",
"null"
]
},
"business_vat_number_country": {
"description": "ISO 3166-1 alpha-2 code",
"type": [
"string",
"null"
]
},
"business_vat_number_code": {
"minLength": 1,
"maxLength": 28,
"type": [
"string",
"null"
]
},
"business_fiscal_code": {
"minLength": 11,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"business_name": {
"type": [
"string",
"null"
]
},
"name": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"surname": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"title": {
"minLength": 2,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"cod_eori": {
"minLength": 13,
"maxLength": 17,
"type": [
"string",
"null"
]
},
"professional_register": {
"type": [
"string",
"null"
]
},
"professional_register_province": {
"type": [
"string",
"null"
]
},
"professional_register_registration_number": {
"type": [
"string",
"null"
]
},
"professional_register_registration_date": {
"description": "ISO 8601:2004 (YYYY-MM-DD)",
"type": [
"string",
"null"
],
"format": "date-time"
},
"tax_regime": {
"type": [
"string",
"null"
]
},
"contact_phone": {
"type": [
"string",
"null"
]
},
"contact_fax": {
"type": [
"string",
"null"
]
},
"contact_email": {
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
},
"rea_registration_office": {
"minLength": 2,
"maxLength": 2,
"description": "2 chars Italian province",
"type": [
"string",
"null"
]
},
"rea_registration_number": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
},
"rea_registration_share_capital": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"rea_registration_sole_shareholder": {
"enum": [
"SU",
"SM"
],
"description": "SU sole shareholder, SM many shareholders",
"type": [
"string",
"null"
]
},
"rea_registration_liquidation_status": {
"enum": [
"LS",
"LN"
],
"description": "LS in liquidation, LN not in liquidation",
"type": [
"string",
"null"
]
},
"reference_administration": {
"type": [
"string",
"null"
]
},
"fiscal_representative_vat_number_country": {
"description": "ISO 3166-1 alpha-2 code",
"type": [
"string",
"null"
]
},
"fiscal_representative_vat_number_code": {
"type": [
"string",
"null"
]
},
"fiscal_representative_fiscal_code": {
"type": [
"string",
"null"
]
},
"fiscal_representative_denomination": {
"type": [
"string",
"null"
]
},
"fiscal_representative_name": {
"type": [
"string",
"null"
]
},
"fiscal_representative_surname": {
"type": [
"string",
"null"
]
},
"fiscal_representative_title": {
"type": [
"string",
"null"
]
},
"fiscal_representative_cod_eori": {
"type": [
"string",
"null"
]
},
"recipient_code": {
"type": [
"string",
"null"
]
},
"pec": {
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
}
}
},
"BusinessRegistry.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"uuid": {
"type": "string",
"format": "uuid"
},
"head_office_address_street": {
"type": "string"
},
"head_office_address_street_number": {
"type": [
"string",
"null"
]
},
"head_office_address_zip_code": {
"type": "string"
},
"head_office_address_city": {
"type": "string"
},
"head_office_address_province": {
"type": [
"string",
"null"
]
},
"head_office_address_country": {
"description": "ISO 3166-1 alpha-2 code",
"type": "string"
},
"office_address_street": {
"type": [
"string",
"null"
]
},
"office_address_street_number": {
"type": [
"string",
"null"
]
},
"office_address_zip_code": {
"type": [
"string",
"null"
]
},
"office_address_city": {
"type": [
"string",
"null"
]
},
"office_address_province": {
"type": [
"string",
"null"
]
},
"office_address_country": {
"description": "ISO 3166-1 alpha-2 code",
"type": [
"string",
"null"
]
},
"business_vat_number_country": {
"description": "ISO 3166-1 alpha-2 code",
"type": [
"string",
"null"
]
},
"business_vat_number_code": {
"minLength": 1,
"maxLength": 28,
"type": [
"string",
"null"
]
},
"business_fiscal_code": {
"minLength": 11,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"business_name": {
"type": [
"string",
"null"
]
},
"name": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"surname": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"title": {
"minLength": 2,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"cod_eori": {
"minLength": 13,
"maxLength": 17,
"type": [
"string",
"null"
]
},
"professional_register": {
"type": [
"string",
"null"
]
},
"professional_register_province": {
"type": [
"string",
"null"
]
},
"professional_register_registration_number": {
"type": [
"string",
"null"
]
},
"professional_register_registration_date": {
"description": "ISO 8601:2004 (YYYY-MM-DD)",
"type": [
"string",
"null"
],
"format": "date-time"
},
"tax_regime": {
"type": [
"string",
"null"
]
},
"contact_phone": {
"type": [
"string",
"null"
]
},
"contact_fax": {
"type": [
"string",
"null"
]
},
"contact_email": {
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
},
"rea_registration_office": {
"minLength": 2,
"maxLength": 2,
"description": "2 chars Italian province",
"type": [
"string",
"null"
]
},
"rea_registration_number": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
},
"rea_registration_share_capital": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"rea_registration_sole_shareholder": {
"enum": [
"SU",
"SM"
],
"description": "SU sole shareholder, SM many shareholders",
"type": [
"string",
"null"
]
},
"rea_registration_liquidation_status": {
"enum": [
"LS",
"LN"
],
"description": "LS in liquidation, LN not in liquidation",
"type": [
"string",
"null"
]
},
"reference_administration": {
"type": [
"string",
"null"
]
},
"fiscal_representative_vat_number_country": {
"description": "ISO 3166-1 alpha-2 code",
"type": [
"string",
"null"
]
},
"fiscal_representative_vat_number_code": {
"type": [
"string",
"null"
]
},
"fiscal_representative_fiscal_code": {
"type": [
"string",
"null"
]
},
"fiscal_representative_denomination": {
"type": [
"string",
"null"
]
},
"fiscal_representative_name": {
"type": [
"string",
"null"
]
},
"fiscal_representative_surname": {
"type": [
"string",
"null"
]
},
"fiscal_representative_title": {
"type": [
"string",
"null"
]
},
"fiscal_representative_cod_eori": {
"type": [
"string",
"null"
]
},
"recipient_code": {
"type": [
"string",
"null"
]
},
"pec": {
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
}
},
"required": [
"head_office_address_street",
"head_office_address_zip_code",
"head_office_address_city",
"head_office_address_country"
]
},
"BusinessRegistry.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"head_office_address_street",
"head_office_address_zip_code",
"head_office_address_city",
"head_office_address_country"
],
"properties": {
"head_office_address_street": {
"type": "string"
},
"head_office_address_street_number": {
"type": [
"string",
"null"
]
},
"head_office_address_zip_code": {
"type": "string"
},
"head_office_address_city": {
"type": "string"
},
"head_office_address_province": {
"type": [
"string",
"null"
]
},
"head_office_address_country": {
"description": "ISO 3166-1 alpha-2 code",
"type": "string"
},
"office_address_street": {
"type": [
"string",
"null"
]
},
"office_address_street_number": {
"type": [
"string",
"null"
]
},
"office_address_zip_code": {
"type": [
"string",
"null"
]
},
"office_address_city": {
"type": [
"string",
"null"
]
},
"office_address_province": {
"type": [
"string",
"null"
]
},
"office_address_country": {
"description": "ISO 3166-1 alpha-2 code",
"type": [
"string",
"null"
]
},
"business_vat_number_country": {
"description": "ISO 3166-1 alpha-2 code",
"type": [
"string",
"null"
]
},
"business_vat_number_code": {
"minLength": 1,
"maxLength": 28,
"type": [
"string",
"null"
]
},
"business_fiscal_code": {
"minLength": 11,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"business_name": {
"type": [
"string",
"null"
]
},
"name": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"surname": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"title": {
"minLength": 2,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"cod_eori": {
"minLength": 13,
"maxLength": 17,
"type": [
"string",
"null"
]
},
"professional_register": {
"type": [
"string",
"null"
]
},
"professional_register_province": {
"type": [
"string",
"null"
]
},
"professional_register_registration_number": {
"type": [
"string",
"null"
]
},
"professional_register_registration_date": {
"description": "ISO 8601:2004 (YYYY-MM-DD)",
"type": [
"string",
"null"
],
"format": "date-time"
},
"tax_regime": {
"type": [
"string",
"null"
]
},
"contact_phone": {
"type": [
"string",
"null"
]
},
"contact_fax": {
"type": [
"string",
"null"
]
},
"contact_email": {
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
},
"rea_registration_office": {
"minLength": 2,
"maxLength": 2,
"description": "2 chars Italian province",
"type": [
"string",
"null"
]
},
"rea_registration_number": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
},
"rea_registration_share_capital": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"rea_registration_sole_shareholder": {
"enum": [
"SU",
"SM"
],
"description": "SU sole shareholder, SM many shareholders",
"type": [
"string",
"null"
]
},
"rea_registration_liquidation_status": {
"enum": [
"LS",
"LN"
],
"description": "LS in liquidation, LN not in liquidation",
"type": [
"string",
"null"
]
},
"reference_administration": {
"type": [
"string",
"null"
]
},
"fiscal_representative_vat_number_country": {
"description": "ISO 3166-1 alpha-2 code",
"type": [
"string",
"null"
]
},
"fiscal_representative_vat_number_code": {
"type": [
"string",
"null"
]
},
"fiscal_representative_fiscal_code": {
"type": [
"string",
"null"
]
},
"fiscal_representative_denomination": {
"type": [
"string",
"null"
]
},
"fiscal_representative_name": {
"type": [
"string",
"null"
]
},
"fiscal_representative_surname": {
"type": [
"string",
"null"
]
},
"fiscal_representative_title": {
"type": [
"string",
"null"
]
},
"fiscal_representative_cod_eori": {
"type": [
"string",
"null"
]
},
"recipient_code": {
"type": [
"string",
"null"
]
},
"pec": {
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
}
}
},
"BusinessRegistryCollect.BusinessRegistryCollectOutput-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"uuid": {
"type": "string"
},
"business_registry": {
"anyOf": [
{
"$ref": "#/components/schemas/BusinessRegistry-read"
},
{
"type": "null"
}
]
},
"url": {
"type": "string"
},
"status": {
"type": "string"
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"mode": {
"type": "string",
"enum": [
"async",
"sync"
]
},
"return_url": {
"type": "string"
},
"redirect_url": {
"type": [
"string",
"null"
]
}
}
},
"BusinessRegistryCollect.BusinessRegistryCollectOutput.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"uuid": {
"type": "string"
},
"business_registry": {
"anyOf": [
{
"$ref": "#/components/schemas/BusinessRegistry.jsonld-read"
},
{
"type": "null"
}
]
},
"url": {
"type": "string"
},
"status": {
"type": "string"
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"mode": {
"type": "string",
"enum": [
"async",
"sync"
]
},
"return_url": {
"type": "string"
},
"redirect_url": {
"type": [
"string",
"null"
]
}
}
},
"BusinessRegistryCollect.CreateBusinessRegistryCollectDataInput": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"return_url": {
"format": "uri",
"description": "URL where collected data will be sent via webhook",
"externalDocs": {
"url": "https://schema.org/url"
},
"type": "string"
},
"redirect_url": {
"format": "uri",
"description": "URL to redirect to after the business registry data is collected (required in SYNC mode)",
"externalDocs": {
"url": "https://schema.org/url"
},
"type": [
"string",
"null"
]
},
"mode": {
"enum": [
"async",
"sync"
],
"default": "async",
"example": "async",
"type": "string"
},
"expires_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"allow_skip": {
"description": "Allow to skip the submission of business registry data",
"type": "boolean"
},
"merchant_name": {
"description": "Merchant name to be displayed in the business registry form",
"type": [
"string",
"null"
]
},
"street": {
"type": [
"string",
"null"
]
},
"zip_code": {
"type": [
"string",
"null"
]
},
"city": {
"type": [
"string",
"null"
]
},
"email": {
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"surname": {
"type": [
"string",
"null"
]
},
"business_name": {
"type": [
"string",
"null"
]
},
"vat_number": {
"minLength": 11,
"maxLength": 11,
"type": [
"string",
"null"
]
},
"fiscal_code": {
"minLength": 11,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"country": {
"minLength": 2,
"maxLength": 2,
"type": [
"string",
"null"
]
},
"province": {
"type": [
"string",
"null"
]
},
"pec": {
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
},
"recipient_code": {
"minLength": 6,
"maxLength": 7,
"type": [
"string",
"null"
]
}
}
},
"BusinessRegistryCollect.CreateBusinessRegistryCollectDataInput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"return_url": {
"format": "uri",
"description": "URL where collected data will be sent via webhook",
"externalDocs": {
"url": "https://schema.org/url"
},
"type": "string"
},
"redirect_url": {
"format": "uri",
"description": "URL to redirect to after the business registry data is collected (required in SYNC mode)",
"externalDocs": {
"url": "https://schema.org/url"
},
"type": [
"string",
"null"
]
},
"mode": {
"enum": [
"async",
"sync"
],
"default": "async",
"example": "async",
"type": "string"
},
"expires_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"allow_skip": {
"description": "Allow to skip the submission of business registry data",
"type": "boolean"
},
"merchant_name": {
"description": "Merchant name to be displayed in the business registry form",
"type": [
"string",
"null"
]
},
"street": {
"type": [
"string",
"null"
]
},
"zip_code": {
"type": [
"string",
"null"
]
},
"city": {
"type": [
"string",
"null"
]
},
"email": {
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"surname": {
"type": [
"string",
"null"
]
},
"business_name": {
"type": [
"string",
"null"
]
},
"vat_number": {
"minLength": 11,
"maxLength": 11,
"type": [
"string",
"null"
]
},
"fiscal_code": {
"minLength": 11,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"country": {
"minLength": 2,
"maxLength": 2,
"type": [
"string",
"null"
]
},
"province": {
"type": [
"string",
"null"
]
},
"pec": {
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
},
"recipient_code": {
"minLength": 6,
"maxLength": 7,
"type": [
"string",
"null"
]
}
}
},
"BusinessRegistryCollect.UpdateBusinessRegistryCollectDataInput": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"street"
],
"properties": {
"street": {
"type": [
"string",
"null"
]
},
"zip_code": {
"type": [
"string",
"null"
]
},
"city": {
"type": [
"string",
"null"
]
},
"email": {
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"surname": {
"type": [
"string",
"null"
]
},
"business_name": {
"type": [
"string",
"null"
]
},
"vat_number": {
"minLength": 11,
"maxLength": 11,
"type": [
"string",
"null"
]
},
"fiscal_code": {
"minLength": 11,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"country": {
"minLength": 2,
"maxLength": 2,
"type": [
"string",
"null"
]
},
"province": {
"type": [
"string",
"null"
]
},
"pec": {
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
},
"recipient_code": {
"minLength": 6,
"maxLength": 7,
"type": [
"string",
"null"
]
}
}
},
"BusinessRegistryCollect.UpdateBusinessRegistryCollectDataInput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"street"
],
"properties": {
"street": {
"type": [
"string",
"null"
]
},
"zip_code": {
"type": [
"string",
"null"
]
},
"city": {
"type": [
"string",
"null"
]
},
"email": {
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"surname": {
"type": [
"string",
"null"
]
},
"business_name": {
"type": [
"string",
"null"
]
},
"vat_number": {
"minLength": 11,
"maxLength": 11,
"type": [
"string",
"null"
]
},
"fiscal_code": {
"minLength": 11,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"country": {
"minLength": 2,
"maxLength": 2,
"type": [
"string",
"null"
]
},
"province": {
"type": [
"string",
"null"
]
},
"pec": {
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
},
"recipient_code": {
"minLength": 6,
"maxLength": 7,
"type": [
"string",
"null"
]
}
}
},
"BusinessRegistryConfiguration-read": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"fiscal_id"
],
"properties": {
"fiscal_id": {
"description": "The fiscal code or the vat number WITHOUT the country prefix",
"type": "string"
},
"name": {
"description": "The owner's name for the fiscal id.",
"type": [
"string",
"null"
]
},
"email": {
"description": "The email where the owner of the fiscalId will receive communications from the platform.",
"type": [
"string",
"null"
]
},
"email_for_preservation_requested_at": {
"description": "The legal storage service requested an email address to activate the account.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"customer_invoice_enabled": {
"description": "Enable or disable outgoing invoice sending for this fiscal identifier. Default: true.",
"default": true,
"example": true,
"type": "boolean"
},
"supplier_invoice_enabled": {
"description": "The fiscal id is enabled to received supplier invoices.",
"default": true,
"example": true,
"type": "boolean"
},
"receipts_enabled": {
"description": "Enable receipt service.",
"type": "boolean"
},
"apply_signature": {
"description": "Apply digital signature before sending invoices to SDI.",
"type": [
"boolean",
"null"
]
},
"apply_legal_storage": {
"description": "Apply the legal storage for invoices sent/received by the fiscal id.",
"type": [
"boolean",
"null"
]
},
"legal_storage_active": {
"description": "This is set asynchronously when the email owner has activated the account.",
"type": "boolean"
},
"api_configurations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiConfiguration-read"
}
}
}
},
"BusinessRegistryConfiguration-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"fiscal_id"
],
"properties": {
"fiscal_id": {
"description": "The fiscal code or the vat number WITHOUT the country prefix",
"type": "string"
},
"name": {
"description": "The owner's name for the fiscal id.",
"type": [
"string",
"null"
]
},
"email": {
"description": "The email where the owner of the fiscalId will receive communications from the platform.",
"type": [
"string",
"null"
]
},
"customer_invoice_enabled": {
"description": "Enable or disable outgoing invoice sending for this fiscal identifier. Default: true.",
"default": true,
"example": true,
"type": "boolean"
},
"supplier_invoice_enabled": {
"description": "The fiscal id is enabled to received supplier invoices.",
"default": true,
"example": true,
"type": "boolean"
},
"receipts_enabled": {
"description": "Enable receipt service.",
"type": "boolean"
},
"apply_signature": {
"description": "Apply digital signature before sending invoices to SDI.",
"type": [
"boolean",
"null"
]
},
"apply_legal_storage": {
"description": "Apply the legal storage for invoices sent/received by the fiscal id.",
"type": [
"boolean",
"null"
]
},
"phone_number": {
"description": "\nthis field will be used to receive OTP during the password changing process for Agenzia delle entrate",
"type": [
"string",
"null"
]
},
"api_configurations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiConfiguration-write"
}
}
}
},
"BusinessRegistryConfiguration.AdeCredentials-write": {
"type": "object",
"description": "",
"deprecated": false
},
"BusinessRegistryConfiguration.AdeCredentials.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false
},
"BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointStatusOutput-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"receipt_enabled": {
"type": "boolean"
},
"appointee": {
"description": "The fiscal ID of the appointee.",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the registration.",
"type": [
"string",
"null"
]
},
"url": {
"description": "The url to be used for recovering an ongoing appointing procedure or to get the signed contract for a completed processes.",
"type": [
"string",
"null"
]
}
}
},
"BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointStatusOutput.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"receipt_enabled": {
"type": "boolean"
},
"appointee": {
"description": "The fiscal ID of the appointee.",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the registration.",
"type": [
"string",
"null"
]
},
"url": {
"description": "The url to be used for recovering an ongoing appointing procedure or to get the signed contract for a completed processes.",
"type": [
"string",
"null"
]
}
}
},
"BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeInput-write": {
"type": "object",
"description": "",
"deprecated": false
},
"BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeInput.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false
},
"BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeSpidInput-write": {
"type": "object",
"description": "",
"deprecated": false
},
"BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeSpidInput.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false
},
"BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeSpidOutput-read": {
"type": "object",
"description": "",
"deprecated": false
},
"BusinessRegistryConfiguration.BusinessRegistryConfigurationAppointeeSpidOutput.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
}
}
},
"BusinessRegistryConfiguration.ReceiptSettingsInput-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"receipts_alert_recipients": {
"description": "The list of email recipients for communications related to AdE technical problems. For example `\"receipts_alert_recipients\": [\"foo@bar.com\", \"baz@bar.com\"]`. Enter one of your dummy no-reply addresses if you want the end customer not to receive e-mail notifications.",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"phone_number": {
"pattern": "^(\\+\\d{8,})$",
"description": "The mobile phone number used to reset AdE password (with +xx international prefix). Can be null if you use an appointee.",
"type": [
"string",
"null"
]
}
}
},
"BusinessRegistryConfiguration.ReceiptSettingsOutput-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"receipts_alert_recipients": {
"description": "The list of email recipients for communications related to AdE technical problems.",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"phone_number": {
"description": "The mobile phone number used to reset AdE password (with +xx international prefix). Can be null if you use an appointee.",
"type": [
"string",
"null"
]
}
}
},
"BusinessRegistryConfiguration.ReportingInput-write": {
"type": "object",
"description": "",
"deprecated": false
},
"BusinessRegistryConfiguration.ReportingOutput-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"rejected_invoices_alert_schedule": {
"type": [
"string",
"null"
]
}
}
},
"BusinessRegistryConfiguration.SubAccountInput-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"email"
],
"properties": {
"email": {
"format": "email",
"description": "Email of the sub account",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": "string"
},
"password": {
"pattern": "^((?=.*[A-z])(?=.*\\d)(?=.*[!@#\\$%\\^&\\*])(?=.{8,}).*)$",
"description": "Password of the sub account. If not provided, a random temporary password will be generated and a reset password link will be sent to the email address.",
"type": "string"
}
}
},
"BusinessRegistryConfiguration.SubAccountOutput-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"email": {
"type": "string"
}
}
},
"BusinessRegistryConfiguration.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"fiscal_id"
],
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"fiscal_id": {
"description": "The fiscal code or the vat number WITHOUT the country prefix",
"type": "string"
},
"name": {
"description": "The owner's name for the fiscal id.",
"type": [
"string",
"null"
]
},
"email": {
"description": "The email where the owner of the fiscalId will receive communications from the platform.",
"type": [
"string",
"null"
]
},
"email_for_preservation_requested_at": {
"description": "The legal storage service requested an email address to activate the account.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"customer_invoice_enabled": {
"description": "Enable or disable outgoing invoice sending for this fiscal identifier. Default: true.",
"default": true,
"example": true,
"type": "boolean"
},
"supplier_invoice_enabled": {
"description": "The fiscal id is enabled to received supplier invoices.",
"default": true,
"example": true,
"type": "boolean"
},
"receipts_enabled": {
"description": "Enable receipt service.",
"type": "boolean"
},
"apply_signature": {
"description": "Apply digital signature before sending invoices to SDI.",
"type": [
"boolean",
"null"
]
},
"apply_legal_storage": {
"description": "Apply the legal storage for invoices sent/received by the fiscal id.",
"type": [
"boolean",
"null"
]
},
"legal_storage_active": {
"description": "This is set asynchronously when the email owner has activated the account.",
"type": "boolean"
},
"api_configurations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiConfiguration.jsonld-read"
}
}
}
},
"BusinessRegistryConfiguration.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"fiscal_id"
],
"properties": {
"fiscal_id": {
"description": "The fiscal code or the vat number WITHOUT the country prefix",
"type": "string"
},
"name": {
"description": "The owner's name for the fiscal id.",
"type": [
"string",
"null"
]
},
"email": {
"description": "The email where the owner of the fiscalId will receive communications from the platform.",
"type": [
"string",
"null"
]
},
"customer_invoice_enabled": {
"description": "Enable or disable outgoing invoice sending for this fiscal identifier. Default: true.",
"default": true,
"example": true,
"type": "boolean"
},
"supplier_invoice_enabled": {
"description": "The fiscal id is enabled to received supplier invoices.",
"default": true,
"example": true,
"type": "boolean"
},
"receipts_enabled": {
"description": "Enable receipt service.",
"type": "boolean"
},
"apply_signature": {
"description": "Apply digital signature before sending invoices to SDI.",
"type": [
"boolean",
"null"
]
},
"apply_legal_storage": {
"description": "Apply the legal storage for invoices sent/received by the fiscal id.",
"type": [
"boolean",
"null"
]
},
"phone_number": {
"description": "\nthis field will be used to receive OTP during the password changing process for Agenzia delle entrate",
"type": [
"string",
"null"
]
},
"api_configurations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiConfiguration.jsonld-write"
}
}
}
},
"CedentePrestatore-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"id_fiscale_iva",
"sede",
"regime_fiscale"
],
"properties": {
"id_fiscale_iva": {
"$ref": "#/components/schemas/IdFiscale-write"
},
"codice_fiscale": {
"minLength": 11,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"denominazione": {
"minLength": 1,
"maxLength": 80,
"description": "Company name, to be filled in case 'nome' and 'cognome' are empty",
"type": [
"string",
"null"
]
},
"nome": {
"minLength": 1,
"maxLength": 60,
"description": "Physical person's name, to be filled with 'cognome' in case 'denominazione' is empty",
"type": [
"string",
"null"
]
},
"cognome": {
"minLength": 1,
"maxLength": 60,
"description": "Physical person's surname, to be filled with 'name' in case 'denominazione' is empty",
"type": [
"string",
"null"
]
},
"sede": {
"$ref": "#/components/schemas/Indirizzo-write"
},
"stabile_organizzazione": {
"anyOf": [
{
"$ref": "#/components/schemas/Indirizzo-write"
},
{
"type": "null"
}
]
},
"rappresentante_fiscale": {
"anyOf": [
{
"$ref": "#/components/schemas/RappresentanteFiscale-write"
},
{
"type": "null"
}
]
},
"iscrizione_rea": {
"anyOf": [
{
"$ref": "#/components/schemas/IscrizioneREA-write"
},
{
"type": "null"
}
]
},
"regime_fiscale": {
"enum": [
"RF01",
"RF02",
"RF04",
"RF05",
"RF06",
"RF07",
"RF08",
"RF09",
"RF10",
"RF11",
"RF12",
"RF13",
"RF14",
"RF15",
"RF16",
"RF17",
"RF18",
"RF19",
"RF20"
],
"description": "Can be one of\n RF01 Ordinario\n RF02 Contribuenti minimi ( art .1 , c .96 -117 , L . 244 /07)\n RF04 Agricoltura e attivit\u00e0 connesse e pesca ( artt .34 e 34 -bis, DPR 633 /72)\n RF05 Vendita sali e tabacchi ( art .74 , c .1 , DPR . 633 /72)\n RF06 Commercio fiammiferi ( art .74 , c .1 , DPR 633 /72)\n RF07 Editoria ( art .74 , c .1 , DPR 633 /72)\n RF08 Gestione servizi telefonia pubblica ( art .74 , c .1 , DPR 633 /72)\n RF09 Rivendita documenti di trasporto pubblico e di sosta ( art .74 , c .1 , DPR 633 /72)\n RF10 Intrattenimenti , giochi e altre attivit\u00e0 di cui alla tariffa allegata al DPR 640 /72 ( art .74 , c .6 , DPR 633 /72)\n RF11 Agenzie viaggi e turismo ( art .74 -ter, DPR 633 /72)\n RF12 Agriturismo ( art .5 , c .2 , L . 413 /91)\n RF13 Vendite a domicilio ( art .25 -bis, c .6 , DPR 600 /73)\n RF14 Rivendita beni usati , oggetti d\u2019arte , d\u2019antiquariato o da collezione ( art .36 , DL 41 /95)\n RF15 Agenzie di vendite all\u2019asta di oggetti d\u2019arte , antiquariato o da collezione ( art .40 -bis, DL 41 /95)\n RF16 IVA per cassa P .A. ( art .6 , c .5 , DPR 633 /72)\n RF17 IVA per cassa ( art . 32 -bis, DL 83 /2012)\n RF18 Altro\n RF19 Regime forfettario ( art .1 , c .54 -89 , L . 190 /2014)\n RF20 Regime transfrontaliero di Franchigia IVA (Direttiva UE 2020/285)",
"type": "string"
}
}
},
"CessionarioCommittente-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"identificativi_fiscali"
],
"properties": {
"identificativi_fiscali": {
"$ref": "#/components/schemas/IdentificativiFiscali-write"
},
"altri_dati_identificativi": {
"anyOf": [
{
"$ref": "#/components/schemas/AltriDatiIdentificativi-write"
},
{
"type": "null"
}
]
}
}
},
"CodiceArticolo-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"codice_tipo",
"codice_valore"
],
"properties": {
"codice_tipo": {
"minLength": 1,
"maxLength": 35,
"type": "string"
},
"codice_valore": {
"minLength": 1,
"maxLength": 35,
"type": "string"
}
}
},
"Company-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"detail": {
"anyOf": [
{
"$ref": "#/components/schemas/Detail-read"
},
{
"type": "null"
}
]
},
"id": {
"description": "The company's VAT number or fiscal id",
"example": "10442360961",
"type": [
"string",
"null"
]
},
"fiscal_code": {
"example": "10442360961",
"type": [
"string",
"null"
]
},
"company_name": {
"example": "Company name",
"type": [
"string",
"null"
]
},
"registered_office": {
"anyOf": [
{
"$ref": "#/components/schemas/Address-read"
},
{
"type": "null"
}
]
},
"activity_status": {
"description": "The status of the company according to the Italian Chamber of Commerce",
"example": "ATTIVA",
"type": [
"string",
"null"
],
"enum": [
"ATTIVA",
"REGISTRATA",
"INATTIVA",
"SOSPESA",
"IN_ISCRIZIONE",
"CESSATA"
]
},
"last_update_timestamp": {
"example": 1589395200,
"type": [
"integer",
"null"
]
},
"recipient_code": {
"description": "The company's tax recipient code",
"example": "ABC1234",
"type": [
"string",
"null"
]
},
"gps": {
"description": "The GPS coordinates of the company's location",
"anyOf": [
{
"$ref": "#/components/schemas/Gps-read"
},
{
"type": "null"
}
]
},
"enrollment_date": {
"description": "The date of enrollment to the Italian Chamber of Commerce",
"example": "2018-01-01",
"type": [
"string",
"null"
]
}
}
},
"Company.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"detail": {
"anyOf": [
{
"$ref": "#/components/schemas/Detail.jsonld-read"
},
{
"type": "null"
}
]
},
"id": {
"description": "The company's VAT number or fiscal id",
"example": "10442360961",
"type": [
"string",
"null"
]
},
"fiscal_code": {
"example": "10442360961",
"type": [
"string",
"null"
]
},
"company_name": {
"example": "Company name",
"type": [
"string",
"null"
]
},
"registered_office": {
"anyOf": [
{
"$ref": "#/components/schemas/Address.jsonld-read"
},
{
"type": "null"
}
]
},
"activity_status": {
"description": "The status of the company according to the Italian Chamber of Commerce",
"example": "ATTIVA",
"type": [
"string",
"null"
],
"enum": [
"ATTIVA",
"REGISTRATA",
"INATTIVA",
"SOSPESA",
"IN_ISCRIZIONE",
"CESSATA"
]
},
"last_update_timestamp": {
"example": 1589395200,
"type": [
"integer",
"null"
]
},
"recipient_code": {
"description": "The company's tax recipient code",
"example": "ABC1234",
"type": [
"string",
"null"
]
},
"gps": {
"description": "The GPS coordinates of the company's location",
"anyOf": [
{
"$ref": "#/components/schemas/Gps.jsonld-read"
},
{
"type": "null"
}
]
},
"enrollment_date": {
"description": "The date of enrollment to the Italian Chamber of Commerce",
"example": "2018-01-01",
"type": [
"string",
"null"
]
}
}
},
"Contatti-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"telefono": {
"minLength": 5,
"maxLength": 12,
"type": [
"string",
"null"
]
},
"fax": {
"minLength": 5,
"maxLength": 12,
"type": [
"string",
"null"
]
},
"email": {
"minLength": 7,
"maxLength": 256,
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
}
}
},
"CountDetail": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"cost": {},
"count": {
"type": "integer"
}
}
},
"CountDetail.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"cost": {},
"count": {
"type": "integer"
}
}
},
"CustomerInvoiceImport.CustomerInvoiceImportInput": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"invoice"
],
"properties": {
"invoice": {
"description": "The base64 encoded invoice XML or P7M.",
"type": "string"
},
"notifications": {
"type": "array",
"properties": {
"RC": {},
"MC": {},
"NS": {},
"DT": {},
"NE": {},
"AT": {},
"EC": {}
},
"additionalProperties": false,
"description": "Notification type as key (RC, MC, NS, DT, NE, AT, EC), notification base64 as value. If at least one notification is not provided you must provide invoice_file_name and sdi_id.",
"items": {
"type": "string",
"enum": [
"RC",
"MC",
"NS",
"DT",
"NE",
"AT",
"EC"
]
}
},
"invoice_file_name": {
"description": "The invoice filename, to be provided only when there is not any notification.",
"type": "string"
},
"sdi_id": {
"description": "The invoice SDI ID, to be provided only when there is not any notification.",
"type": "string"
}
}
},
"CustomerInvoiceImport.CustomerInvoiceImportInput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"invoice"
],
"properties": {
"invoice": {
"description": "The base64 encoded invoice XML or P7M.",
"type": "string"
},
"notifications": {
"type": "array",
"properties": {
"RC": {},
"MC": {},
"NS": {},
"DT": {},
"NE": {},
"AT": {},
"EC": {}
},
"additionalProperties": false,
"description": "Notification type as key (RC, MC, NS, DT, NE, AT, EC), notification base64 as value. If at least one notification is not provided you must provide invoice_file_name and sdi_id.",
"items": {
"type": "string",
"enum": [
"RC",
"MC",
"NS",
"DT",
"NE",
"AT",
"EC"
]
}
},
"invoice_file_name": {
"description": "The invoice filename, to be provided only when there is not any notification.",
"type": "string"
},
"sdi_id": {
"description": "The invoice SDI ID, to be provided only when there is not any notification.",
"type": "string"
}
}
},
"CustomerInvoiceImport.CustomerInvoiceImportOutput": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"uuid": {
"description": "The UUID used to identify uniquely the invoice.",
"type": "string"
}
}
},
"CustomerInvoiceImport.CustomerInvoiceImportOutput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"uuid": {
"description": "The UUID used to identify uniquely the invoice.",
"type": "string"
}
}
},
"DatiAnagraficiCedentePrestatore-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"id_fiscale_iva",
"anagrafica",
"regime_fiscale"
],
"properties": {
"id_fiscale_iva": {
"$ref": "#/components/schemas/FatturaPA.IdFiscale-write"
},
"codice_fiscale": {
"minLength": 11,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"anagrafica": {
"$ref": "#/components/schemas/Anagrafica-write"
},
"albo_professionale": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"provincia_albo": {
"minLength": 2,
"maxLength": 2,
"type": [
"string",
"null"
]
},
"numero_iscrizione_albo": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"data_iscrizione_albo": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"regime_fiscale": {
"enum": [
"RF01",
"RF02",
"RF04",
"RF05",
"RF06",
"RF07",
"RF08",
"RF09",
"RF10",
"RF11",
"RF12",
"RF13",
"RF14",
"RF15",
"RF16",
"RF17",
"RF18",
"RF19",
"RF20"
],
"description": "Can be one of\n RF01 Ordinario\n RF02 Contribuenti minimi ( art .1 , c .96 -117 , L . 244 /07)\n RF04 Agricoltura e attivit\u00e0 connesse e pesca ( artt .34 e 34 -bis, DPR 633 /72)\n RF05 Vendita sali e tabacchi ( art .74 , c .1 , DPR . 633 /72)\n RF06 Commercio fiammiferi ( art .74 , c .1 , DPR 633 /72)\n RF07 Editoria ( art .74 , c .1 , DPR 633 /72)\n RF08 Gestione servizi telefonia pubblica ( art .74 , c .1 , DPR 633 /72)\n RF09 Rivendita documenti di trasporto pubblico e di sosta ( art .74 , c .1 , DPR 633 /72)\n RF10 Intrattenimenti , giochi e altre attivit\u00e0 di cui alla tariffa allegata al DPR 640 /72 ( art .74 , c .6 , DPR 633 /72)\n RF11 Agenzie viaggi e turismo ( art .74 -ter, DPR 633 /72)\n RF12 Agriturismo ( art .5 , c .2 , L . 413 /91)\n RF13 Vendite a domicilio ( art .25 -bis, c .6 , DPR 600 /73)\n RF14 Rivendita beni usati , oggetti d\u2019arte , d\u2019antiquariato o da collezione ( art .36 , DL 41 /95)\n RF15 Agenzie di vendite all\u2019asta di oggetti d\u2019arte , antiquariato o da collezione ( art .40 -bis, DL 41 /95)\n RF16 IVA per cassa P .A. ( art .6 , c .5 , DPR 633 /72)\n RF17 IVA per cassa ( art . 32 -bis, DL 83 /2012)\n RF18 Altro\n RF19 Regime forfettario ( art .1 , c .54 -89 , L . 190 /2014)\n RF20 Regime transfrontaliero di Franchigia IVA (Direttiva UE 2020/285)",
"type": "string"
}
}
},
"DatiAnagraficiCessionarioCommittente-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_fiscale_iva": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPA.IdFiscale-write"
},
{
"type": "null"
}
]
},
"codice_fiscale": {
"maxLength": 16,
"type": [
"string",
"null"
]
},
"anagrafica": {
"$ref": "#/components/schemas/Anagrafica-write"
}
},
"required": [
"anagrafica"
]
},
"DatiAnagraficiRappresentanteFiscale-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"id_fiscale_iva",
"anagrafica"
],
"properties": {
"id_fiscale_iva": {
"$ref": "#/components/schemas/FatturaPA.IdFiscale-write"
},
"codice_fiscale": {
"minLength": 11,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"anagrafica": {
"$ref": "#/components/schemas/Anagrafica-write"
}
}
},
"DatiAnagraficiTerzoIntermediario-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_fiscale_iva": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPA.IdFiscale-write"
},
{
"type": "null"
}
]
},
"codice_fiscale": {
"minLength": 11,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"anagrafica": {
"$ref": "#/components/schemas/Anagrafica-write"
}
},
"required": [
"anagrafica"
]
},
"DatiAnagraficiVettore-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_fiscale_iva": {
"$ref": "#/components/schemas/FatturaPA.IdFiscale-write"
},
"codice_fiscale": {
"minLength": 11,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"anagrafica": {
"$ref": "#/components/schemas/Anagrafica-write"
},
"numero_licenza_guida": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
}
},
"required": [
"anagrafica"
]
},
"DatiBeniServizi-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"descrizione",
"importo",
"dati_iva"
],
"properties": {
"descrizione": {
"minLength": 1,
"maxLength": 1000,
"type": "string"
},
"importo": {
"type": "string"
},
"dati_iva": {
"$ref": "#/components/schemas/DatiIVA-write"
},
"natura": {
"enum": [
"N1",
"N2",
"N2.1",
"N2.2",
"N3",
"N3.1",
"N3.2",
"N3.3",
"N3.4",
"N3.5",
"N3.6",
"N4",
"N5"
],
"description": "Can be one of\n N1 escluse ex art . 15\n N2 non soggette\n N2 .1 non soggette ad IVA ai sensi degli artt . da 7 a 7 -septies del DPR 633 /72\n N2 .2 non soggette - altri casi\n N3 non imponibili\n N3 .1 non imponibili - esportazioni\n N3 .2 non imponibili - cessioni intracomunitarie\n N3 .3 non imponibili - cessioni verso San Marino\n N3 .4 non imponibili - operazioni assimilate alle cessioni all 'esportazione\n N3 .5 non imponibili - a seguito di dichiarazioni d 'intento\n N3 .6 non imponibili - altre operazioni che non concorrono alla formazione del plafond\n N4 esenti\n N5 regime del margine / IVA non esposta in fattura )",
"type": [
"string",
"null"
]
},
"riferimento_normativo": {
"minLength": 1,
"maxLength": 100,
"type": [
"string",
"null"
]
}
}
},
"DatiBollo-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"bollo_virtuale"
],
"properties": {
"bollo_virtuale": {
"enum": [
"SI"
],
"type": "string"
},
"importo_bollo": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
}
}
},
"DatiCassaPrevidenziale-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"tipo_cassa",
"al_cassa",
"importo_contributo_cassa",
"aliquota_iva"
],
"properties": {
"tipo_cassa": {
"enum": [
"TC01",
"TC02",
"TC03",
"TC04",
"TC05",
"TC06",
"TC07",
"TC08",
"TC09",
"TC10",
"TC11",
"TC12",
"TC13",
"TC14",
"TC15",
"TC16",
"TC17",
"TC18",
"TC19",
"TC20",
"TC21",
"TC22"
],
"description": "Can be one of\n TC01 Cassa nazionale previdenza e assistenza avvocati e procuratori legali\n TC02 Cassa previdenza dottori commercialisti\n TC03 Cassa previdenza e assistenza geometri\n TC04 Cassa nazionale previdenza e assistenza ingegneri e architetti liberi professionisti\n TC05 Cassa nazionale del notariato\n TC06 Cassa nazionale previdenza e assistenza ragionieri e periti commerciali\n TC07 Ente nazionale assistenza agenti e rappresentanti di commercio ( ENASARCO )\n TC08 Ente nazionale previdenza e assistenza consulenti del lavoro ( ENPACL )\n TC09 Ente nazionale previdenza e assistenza medici ( ENPAM )\n TC10 Ente nazionale previdenza e assistenza farmacisti ( ENPAF )\n TC11 Ente nazionale previdenza e assistenza veterinari ( ENPAV )\n TC12 Ente nazionale previdenza e assistenza impiegati dell 'agricoltura ( ENPAIA )\n TC13 Fondo previdenza impiegati imprese di spedizione e agenzie marittime\n TC14 Istituto nazionale previdenza giornalisti italiani ( INPGI )\n TC15 Opera nazionale assistenza orfani sanitari italiani ( ONAOSI )\n TC16 Cassa autonoma assistenza integrativa giornalisti italiani ( CASAGIT )\n TC17 Ente previdenza periti industriali e periti industriali laureati ( EPPI )\n TC18 Ente previdenza e assistenza pluricategoriale ( EPAP )\n TC19 Ente nazionale previdenza e assistenza biologi ( ENPAB )\n TC20 Ente nazionale previdenza e assistenza professione infermieristica ( ENPAPI )\n TC21 Ente nazionale previdenza e assistenza psicologi ( ENPAP )\n TC22 INPS",
"type": "string"
},
"al_cassa": {
"minLength": 4,
"maxLength": 6,
"type": "string"
},
"importo_contributo_cassa": {
"minLength": 4,
"maxLength": 15,
"type": "string"
},
"imponibile_cassa": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"aliquota_iva": {
"minLength": 4,
"maxLength": 6,
"pattern": "^(\\d+\\.\\d+)$",
"type": "string"
},
"ritenuta": {
"enum": [
"SI"
],
"type": [
"string",
"null"
]
},
"natura": {
"enum": [
"N1",
"N2",
"N2.1",
"N2.2",
"N3",
"N3.1",
"N3.2",
"N3.3",
"N3.4",
"N3.5",
"N3.6",
"N4",
"N5",
"N6",
"N6.1",
"N6.2",
"N6.3",
"N6.4",
"N6.5",
"N6.6",
"N6.7",
"N6.8",
"N6.9",
"N7"
],
"description": "Can be one of\n N1 escluse ex art . 15\n N2 non soggette\n N2 .1 non soggette ad IVA ai sensi degli artt . da 7 a 7 -septies del DPR 633 /72\n N2 .2 non soggette - altri casi\n N3 non imponibili\n N3 .1 non imponibili - esportazioni\n N3 .2 non imponibili - cessioni intracomunitarie\n N3 .3 non imponibili - cessioni verso San Marino\n N3 .4 non imponibili - operazioni assimilate alle cessioni all 'esportazione\n N3 .5 non imponibili - a seguito di dichiarazioni d 'intento\n N3 .6 non imponibili - altre operazioni che non concorrono alla formazione del plafond\n N4 esenti\n N5 regime del margine / IVA non esposta in fattura\n N6 inversione contabile ( per le operazioni in reverse charge ovvero nei casi di autofatturazione per acquisti extra UE di servizi ovvero per importazioni di beni nei soli casi previsti )\n N6 .1 inversione contabile - cessione di rottami e altri materiali di recupero\n N6 .2 inversione contabile - cessione di oro e argento puro\n N6 .3 inversione contabile - subappalto nel settore edile\n N6 .4 inversione contabile - cessione di fabbricati\n N6 .5 inversione contabile - cessione di telefoni cellulari\n N6 .6 inversione contabile - cessione di prodotti elettronici\n N6 .7 inversione contabile - prestazioni comparto edile e settori connessi\n N6 .8 inversione contabile - operazioni settore energetico\n N6 .9 inversione contabile - altri casi\n N7 IVA assolta in altro stato UE ( vendite a distanza ex art . 40 c . 3 e 4 e art . 41 c . 1 lett . b , DL 331 /93; prestazione di servizi di telecomunicazioni , tele-radiodiffusione ed elettronici ex art . 7 -sexies lett . f , g , art . 74 -sexies DPR 633 /72)",
"type": [
"string",
"null"
]
},
"riferimento_amministrazione": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
}
}
},
"DatiDDT-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"numero_ddt"
],
"properties": {
"numero_ddt": {
"minLength": 1,
"maxLength": 20,
"type": "string"
},
"data_ddt": {
"type": "string",
"format": "date-time"
},
"riferimento_numero_linea": {
"type": [
"array",
"null"
],
"items": {
"type": "integer"
}
}
}
},
"DatiDocumentiCorrelati-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"riferimento_numero_linea": {
"allOf": [
{
"type": [
"array",
"null"
],
"items": {
"type": "integer"
}
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"id_documento": {
"minLength": 1,
"maxLength": 20,
"type": "string"
},
"data": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"num_item": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
},
"codice_commessa_convenzione": {
"minLength": 1,
"maxLength": 100,
"type": [
"string",
"null"
]
},
"codice_cup": {
"minLength": 1,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"codice_cig": {
"minLength": 1,
"maxLength": 15,
"type": [
"string",
"null"
]
}
},
"required": [
"id_documento"
]
},
"DatiFatturaRettificata-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"numero_fr",
"data_fr",
"elementi_rettificati"
],
"properties": {
"numero_fr": {
"minLength": 1,
"maxLength": 20,
"type": "string"
},
"data_fr": {
"externalDocs": {
"url": "https://schema.org/Date"
},
"type": "string"
},
"elementi_rettificati": {
"minLength": 1,
"maxLength": 1000,
"type": "string"
}
}
},
"DatiGenerali-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"dati_generali_documento"
],
"properties": {
"dati_generali_documento": {
"$ref": "#/components/schemas/DatiGeneraliDocumento-write"
},
"dati_fattura_rettificata": {
"anyOf": [
{
"$ref": "#/components/schemas/DatiFatturaRettificata-write"
},
{
"type": "null"
}
]
}
}
},
"DatiGeneraliDocumento-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"tipo_documento",
"divisa",
"data",
"numero"
],
"properties": {
"tipo_documento": {
"enum": [
"TD07",
"TD08",
"TD09"
],
"description": "Can be one of\n TD07 fattura semplificata\n TD08 nota di credito semplificata\n TD09 nota di debito semplificata",
"type": "string"
},
"divisa": {
"externalDocs": {
"url": "https://schema.org/priceCurrency"
},
"type": "string"
},
"data": {
"type": "string",
"format": "date-time"
},
"numero": {
"minLength": 1,
"maxLength": 20,
"allOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"bollo_virtuale": {
"enum": [
"SI"
],
"type": [
"string",
"null"
]
}
}
},
"DatiIVA-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"imposta": {
"type": [
"string",
"null"
]
},
"aliquota": {
"type": [
"string",
"null"
]
}
}
},
"DatiPagamento-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"condizioni_pagamento"
],
"properties": {
"condizioni_pagamento": {
"enum": [
"TP01",
"TP02",
"TP03"
],
"type": "string"
},
"dettaglio_pagamento": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/DettaglioPagamento-write"
}
}
}
},
"DatiRiepilogo-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"aliquota_iva",
"imponibile_importo",
"imposta"
],
"properties": {
"aliquota_iva": {
"minLength": 4,
"maxLength": 6,
"pattern": "^(\\d+\\.\\d+)$",
"type": "string"
},
"natura": {
"enum": [
"N1",
"N2",
"N2.1",
"N2.2",
"N3",
"N3.1",
"N3.2",
"N3.3",
"N3.4",
"N3.5",
"N3.6",
"N4",
"N5",
"N6",
"N6.1",
"N6.2",
"N6.3",
"N6.4",
"N6.5",
"N6.6",
"N6.7",
"N6.8",
"N6.9",
"N7"
],
"description": "Can be one of\n N1 escluse ex art . 15\n N2 non soggette\n N2 .1 non soggette ad IVA ai sensi degli artt . da 7 a 7 -septies del DPR 633 /72\n N2 .2 non soggette - altri casi\n N3 non imponibili\n N3 .1 non imponibili - esportazioni\n N3 .2 non imponibili - cessioni intracomunitarie\n N3 .3 non imponibili - cessioni verso San Marino\n N3 .4 non imponibili - operazioni assimilate alle cessioni all 'esportazione\n N3 .5 non imponibili - a seguito di dichiarazioni d 'intento\n N3 .6 non imponibili - altre operazioni che non concorrono alla formazione del plafond\n N4 esenti\n N5 regime del margine / IVA non esposta in fattura\n N6 inversione contabile ( per le operazioni in reverse charge ovvero nei casi di autofatturazione per acquisti extra UE di servizi ovvero per importazioni di beni nei soli casi previsti )\n N6 .1 inversione contabile - cessione di rottami e altri materiali di recupero\n N6 .2 inversione contabile - cessione di oro e argento puro\n N6 .3 inversione contabile - subappalto nel settore edile\n N6 .4 inversione contabile - cessione di fabbricati\n N6 .5 inversione contabile - cessione di telefoni cellulari\n N6 .6 inversione contabile - cessione di prodotti elettronici\n N6 .7 inversione contabile - prestazioni comparto edile e settori connessi\n N6 .8 inversione contabile - operazioni settore energetico\n N6 .9 inversione contabile - altri casi\n N7 IVA assolta in altro stato UE ( vendite a distanza ex art . 40 c . 3 e 4 e art . 41 c . 1 lett . b , DL 331 /93; prestazione di servizi di telecomunicazioni , tele-radiodiffusione ed elettronici ex art . 7 -sexies lett . f , g , art . 74 -sexies DPR 633 /72)",
"type": [
"string",
"null"
]
},
"spese_accessorie": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"arrotondamento": {
"minLength": 4,
"maxLength": 21,
"type": [
"string",
"null"
]
},
"imponibile_importo": {
"allOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"number",
"null"
]
}
]
},
"imposta": {
"minLength": 4,
"maxLength": 15,
"type": "string"
},
"esigibilita_iva": {
"enum": [
"I",
"D",
"S"
],
"description": "Codes that can be used :\n I IVA ad esigibilit\u00e0 immediata\n D IVA ad esigibilit\u00e0 differita\n S scissione dei pagamenti",
"type": [
"string",
"null"
]
},
"riferimento_normativo": {
"minLength": 1,
"maxLength": 100,
"type": [
"string",
"null"
]
}
}
},
"DatiRitenuta-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"tipo_ritenuta",
"importo_ritenuta",
"aliquota_ritenuta",
"causale_pagamento"
],
"properties": {
"tipo_ritenuta": {
"enum": [
"RT01",
"RT02",
"RT03",
"RT04",
"RT05",
"RT06"
],
"description": "Can be one of\n RT01 ritenuta persone fisiche\n RT02 ritenuta persone giuridiche\n RT03 contributo INPS\n RT04 contributo ENASARCO\n RT05 contributo ENPAM\n RT06 altro contributo previdenziale",
"type": "string"
},
"importo_ritenuta": {
"minLength": 4,
"maxLength": 15,
"type": "string"
},
"aliquota_ritenuta": {
"minLength": 4,
"maxLength": 6,
"type": "string"
},
"causale_pagamento": {
"minLength": 1,
"maxLength": 2,
"type": "string"
}
}
},
"DatiSAL-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"riferimento_fase"
],
"properties": {
"riferimento_fase": {
"minLength": 1,
"maxLength": 3,
"allOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
}
}
},
"DatiTrasmissione-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_trasmittente": {
"$ref": "#/components/schemas/IdFiscale-write"
},
"progressivo_invio": {
"allOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"formato_trasmissione": {
"type": [
"string",
"null"
]
},
"codice_destinatario": {
"pattern": "^([A-Za-z0-9]{6,7})$",
"type": "string"
},
"pec_destinatario": {
"minLength": 7,
"maxLength": 256,
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
}
},
"required": [
"codice_destinatario"
]
},
"DatiTrasporto-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"dati_anagrafici_vettore": {
"anyOf": [
{
"$ref": "#/components/schemas/DatiAnagraficiVettore-write"
},
{
"type": "null"
}
]
},
"mezzo_trasporto": {
"minLength": 1,
"maxLength": 80,
"type": [
"string",
"null"
]
},
"causale_trasporto": {
"minLength": 1,
"maxLength": 100,
"type": [
"string",
"null"
]
},
"numero_colli": {
"minLength": 1,
"maxLength": 4,
"allOf": [
{
"type": [
"integer",
"null"
]
},
{
"type": "string"
}
]
},
"descrizione": {
"minLength": 1,
"maxLength": 100,
"type": [
"string",
"null"
]
},
"unita_misura_peso": {
"minLength": 1,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"peso_lordo": {
"minLength": 4,
"maxLength": 7,
"type": [
"string",
"null"
]
},
"peso_netto": {
"minLength": 4,
"maxLength": 7,
"type": [
"string",
"null"
]
},
"data_ora_ritiro": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"data_inizio_trasporto": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"tipo_resa": {
"minLength": 3,
"maxLength": 3,
"type": [
"string",
"null"
]
},
"indirizzo_resa": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPA.Indirizzo-write"
},
{
"type": "null"
}
]
},
"data_ora_consegna": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
},
"DatiVeicoli-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"data",
"totale_percorso"
],
"properties": {
"data": {
"type": "string",
"format": "date-time"
},
"totale_percorso": {
"minLength": 1,
"maxLength": 100,
"type": "string"
}
}
},
"Detail-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"rea": {
"description": "The company's REA (Repertorio Economico Amministrativo) code",
"example": "123456",
"type": [
"string",
"null"
]
},
"cciaa": {
"description": "The company's Chamber of Commerce code",
"example": "RM",
"type": [
"string",
"null"
]
},
"ateco_code": {
"description": "The company's ATECO (Ateco Economic Activities) code",
"example": "1234",
"type": [
"string",
"null"
]
},
"ateco_description": {
"description": "The description of the company's ATECO code",
"example": "Produzione di software",
"type": [
"string",
"null"
]
},
"legal_nature_code": {
"description": "The company's legal nature code",
"example": "SRL",
"type": [
"string",
"null"
]
},
"start_date": {
"description": "The start date of the company's activity",
"example": "2018-01-01",
"type": [
"string",
"null"
]
},
"pec": {
"description": "The company's certified email address (PEC)",
"example": "pec@mail.com",
"type": [
"string",
"null"
]
},
"financial_statements": {
"description": "The company's financial statements of the last three years",
"type": "array",
"example": {
"2017": {
"closingDate": "2017-12-31",
"revenue": 100000,
"profit": 10000,
"employees": 5,
"shareCapital": 10000
},
"2018": {
"closingDate": "2018-12-31",
"revenue": 200000,
"profit": 20000,
"employees": 10,
"shareCapital": 20000
},
"2019": {
"closingDate": "2019-12-31",
"revenue": 300000,
"profit": 30000,
"employees": 15,
"shareCapital": 30000
}
}
},
"vat_group": {
"description": "The company's VAT group",
"anyOf": [
{
"$ref": "#/components/schemas/VatGroup-read"
},
{
"type": "null"
}
]
},
"ceased": {
"description": "Indicates whether the company has ceased or not according to the Tax Office",
"type": [
"boolean",
"null"
]
},
"partners": {
"description": "The company's partners",
"type": "array",
"items": {
"$ref": "#/components/schemas/Partner-read"
}
}
}
},
"Detail.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"rea": {
"description": "The company's REA (Repertorio Economico Amministrativo) code",
"example": "123456",
"type": [
"string",
"null"
]
},
"cciaa": {
"description": "The company's Chamber of Commerce code",
"example": "RM",
"type": [
"string",
"null"
]
},
"ateco_code": {
"description": "The company's ATECO (Ateco Economic Activities) code",
"example": "1234",
"type": [
"string",
"null"
]
},
"ateco_description": {
"description": "The description of the company's ATECO code",
"example": "Produzione di software",
"type": [
"string",
"null"
]
},
"legal_nature_code": {
"description": "The company's legal nature code",
"example": "SRL",
"type": [
"string",
"null"
]
},
"start_date": {
"description": "The start date of the company's activity",
"example": "2018-01-01",
"type": [
"string",
"null"
]
},
"pec": {
"description": "The company's certified email address (PEC)",
"example": "pec@mail.com",
"type": [
"string",
"null"
]
},
"financial_statements": {
"description": "The company's financial statements of the last three years",
"type": "array",
"example": {
"2017": {
"closingDate": "2017-12-31",
"revenue": 100000,
"profit": 10000,
"employees": 5,
"shareCapital": 10000
},
"2018": {
"closingDate": "2018-12-31",
"revenue": 200000,
"profit": 20000,
"employees": 10,
"shareCapital": 20000
},
"2019": {
"closingDate": "2019-12-31",
"revenue": 300000,
"profit": 30000,
"employees": 15,
"shareCapital": 30000
}
}
},
"vat_group": {
"description": "The company's VAT group",
"anyOf": [
{
"$ref": "#/components/schemas/VatGroup.jsonld-read"
},
{
"type": "null"
}
]
},
"ceased": {
"description": "Indicates whether the company has ceased or not according to the Tax Office",
"type": [
"boolean",
"null"
]
},
"partners": {
"description": "The company's partners",
"type": "array",
"items": {
"$ref": "#/components/schemas/Partner.jsonld-read"
}
}
}
},
"DettaglioLinee-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"numero_linea",
"descrizione",
"prezzo_unitario",
"prezzo_totale",
"aliquota_iva"
],
"properties": {
"numero_linea": {
"minLength": 1,
"maxLength": 4,
"allOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"tipo_cessione_prestazione": {
"enum": [
"SC",
"PR",
"AB",
"AC"
],
"type": [
"string",
"null"
]
},
"codice_articolo": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/CodiceArticolo-write"
}
},
"descrizione": {
"minLength": 1,
"maxLength": 1000,
"type": "string"
},
"quantita": {
"minLength": 4,
"maxLength": 21,
"type": [
"string",
"null"
]
},
"unita_misura": {
"minLength": 1,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"data_inizio_periodo": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"data_fine_periodo": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"prezzo_unitario": {
"type": "string"
},
"sconto_maggiorazione": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/ScontoMaggiorazione-write"
}
},
"prezzo_totale": {
"type": "string"
},
"aliquota_iva": {
"pattern": "^(\\d+\\.\\d+)$",
"type": "string"
},
"ritenuta": {
"enum": [
"SI"
],
"type": [
"string",
"null"
]
},
"natura": {
"enum": [
"N1",
"N2",
"N2.1",
"N2.2",
"N3",
"N3.1",
"N3.2",
"N3.3",
"N3.4",
"N3.5",
"N3.6",
"N4",
"N5",
"N6",
"N6.1",
"N6.2",
"N6.3",
"N6.4",
"N6.5",
"N6.6",
"N6.7",
"N6.8",
"N6.9",
"N7"
],
"description": "Can be one of\n N1 escluse ex art . 15\n N2 non soggette\n N2 .1 non soggette ad IVA ai sensi degli artt . da 7 a 7 -septies del DPR 633 /72\n N2 .2 non soggette - altri casi\n N3 non imponibili\n N3 .1 non imponibili - esportazioni\n N3 .2 non imponibili - cessioni intracomunitarie\n N3 .3 non imponibili - cessioni verso San Marino\n N3 .4 non imponibili - operazioni assimilate alle cessioni all 'esportazione\n N3 .5 non imponibili - a seguito di dichiarazioni d 'intento\n N3 .6 non imponibili - altre operazioni che non concorrono alla formazione del plafond\n N4 esenti\n N5 regime del margine / IVA non esposta in fattura\n N6 inversione contabile ( per le operazioni in reverse charge ovvero nei casi di autofatturazione per acquisti extra UE di servizi ovvero per importazioni di beni nei soli casi previsti )\n N6 .1 inversione contabile - cessione di rottami e altri materiali di recupero\n N6 .2 inversione contabile - cessione di oro e argento puro\n N6 .3 inversione contabile - subappalto nel settore edile\n N6 .4 inversione contabile - cessione di fabbricati\n N6 .5 inversione contabile - cessione di telefoni cellulari\n N6 .6 inversione contabile - cessione di prodotti elettronici\n N6 .7 inversione contabile - prestazioni comparto edile e settori connessi\n N6 .8 inversione contabile - operazioni settore energetico\n N6 .9 inversione contabile - altri casi\n N7 IVA assolta in altro stato UE ( vendite a distanza ex art . 40 c . 3 e 4 e art . 41 c . 1 lett . b , DL 331 /93; prestazione di servizi di telecomunicazioni , tele-radiodiffusione ed elettronici ex art . 7 -sexies lett . f , g , art . 74 -sexies DPR 633 /72)",
"type": [
"string",
"null"
]
},
"riferimento_amministrazione": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
},
"altri_dati_gestionali": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/AltriDatiGestionali-write"
}
}
}
},
"DettaglioPagamento-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"beneficiario": {
"minLength": 1,
"maxLength": 200,
"type": [
"string",
"null"
]
},
"modalita_pagamento": {
"enum": [
"MP01",
"MP02",
"MP03",
"MP04",
"MP05",
"MP06",
"MP07",
"MP08",
"MP09",
"MP10",
"MP11",
"MP12",
"MP13",
"MP14",
"MP15",
"MP16",
"MP17",
"MP18",
"MP19",
"MP20",
"MP21",
"MP22",
"MP23"
],
"description": "Can be one of\n MP01 contanti\n MP02 assegno\n MP03 assegno circolare\n MP04 contanti presso Tesoreria\n MP05 bonifico\n MP06 vaglia cambiario\n MP07 bollettino bancario\n MP08 carta di pagamento\n MP09 RID\n MP10 RID utenze\n MP11 RID veloce\n MP12 RIBA\n MP13 MAV\n MP14 quietanza erario\n MP15 giroconto su conti di contabilit\u00e0 speciale\n MP16 domiciliazione bancaria\n MP17 domiciliazione postale\n MP18 bollettino di c /c postale\n MP19 SEPA Direct Debit\n MP20 SEPA Direct Debit CORE\n MP21 SEPA Direct Debit B2B\n MP22 Trattenuta su somme gi\u00e0 riscosse\n MP23 PagoPA",
"type": "string"
},
"data_riferimento_termini_pagamento": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"giorni_termini_pagamento": {
"minLength": 1,
"maxLength": 3,
"type": [
"string",
"null"
]
},
"data_scadenza_pagamento": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"importo_pagamento": {
"minLength": 4,
"maxLength": 15,
"type": "string"
},
"cod_ufficio_postale": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
},
"cognome_quietanzante": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"nome_quietanzante": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"cf_quietanzante": {
"minLength": 16,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"titolo_quietanzante": {
"minLength": 2,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"istituto_finanziario": {
"minLength": 1,
"maxLength": 80,
"type": [
"string",
"null"
]
},
"iban": {
"minLength": 15,
"maxLength": 34,
"externalDocs": {
"url": "https://schema.org/identifier"
},
"type": [
"string",
"null"
]
},
"abi": {
"minLength": 5,
"maxLength": 5,
"type": [
"string",
"null"
]
},
"cab": {
"minLength": 5,
"maxLength": 5,
"type": [
"string",
"null"
]
},
"bic": {
"minLength": 8,
"maxLength": 11,
"externalDocs": {
"url": "https://schema.org/identifier"
},
"type": [
"string",
"null"
]
},
"sconto_pagamento_anticipato": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"data_limite_pagamento_anticipato": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"penalita_pagamenti_ritardati": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"data_decorrenza_penale": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"codice_pagamento": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
}
},
"required": [
"modalita_pagamento",
"importo_pagamento"
]
},
"Expense-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"requests": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SistemaTSRequest-read"
}
},
"codice_fiscale_proprietario": {
"type": "string"
},
"codice_fiscale_cittadino": {
"type": [
"string",
"null"
]
},
"created_at": {
"readOnly": true,
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"amount": {
"type": "string"
}
}
},
"Expense.ExpenseOperationCreditNoteInput": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"dispositivo",
"num_documento"
],
"properties": {
"dispositivo": {
"description": "Sequential number of the device generating the document.",
"type": [
"string",
"null"
]
},
"num_documento": {
"pattern": "^(.*[A-Za-z0-9_./\\\\\\-]{1,20}.*)$",
"description": "Identification number of the document issued.",
"type": "string"
},
"importo": {
"description": "Amount of the expense to refund. The field can be null. In this case it will be used automatically the value from the linked expense.",
"type": [
"number",
"null"
]
}
}
},
"Expense.ExpenseOperationCreditNoteInput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"dispositivo",
"num_documento"
],
"properties": {
"dispositivo": {
"description": "Sequential number of the device generating the document.",
"type": [
"string",
"null"
]
},
"num_documento": {
"pattern": "^(.*[A-Za-z0-9_./\\\\\\-]{1,20}.*)$",
"description": "Identification number of the document issued.",
"type": "string"
},
"importo": {
"description": "Amount of the expense to refund. The field can be null. In this case it will be used automatically the value from the linked expense.",
"type": [
"number",
"null"
]
}
}
},
"Expense.ExpenseOperationInput": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"opzionale1": {
"description": "Field currently used by users who:\n- are attested to the SistemaTS with Client certificate (contains the IDENTIFICATION CODE)\n- use Entratel credentials (tax intermediaries: contains tax code - SEAT code).",
"type": [
"string",
"null"
]
},
"opzionale2": {
"type": [
"string",
"null"
]
},
"opzionale3": {
"type": [
"string",
"null"
]
},
"cf_proprietario": {
"maxLength": 16,
"description": "Tax code of the structure or of the professional.",
"type": [
"string",
"null"
]
},
"codice_regione": {
"description": "The 3 chars region code, see the list https://sistemats1.sanita.finanze.it/portale/documents/20182/34254/allegato%2Btecnico%2BTS-CNS%2Bex%2BDL%2B78-2010_v22-06-12.pdf/2ef2b969-879c-64f5-2b0a-8bce9877c08f (this is not needed for professionals).",
"type": [
"string",
"null"
]
},
"codice_asl": {
"description": "The 3 chars ASL code (this is not needed for professionals).",
"type": [
"string",
"null"
]
},
"codice_ssa": {
"description": "The 5 or 6 chars SSA code (this is not needed for professionals).",
"type": [
"string",
"null"
]
},
"partita_iva": {
"pattern": "^((\\d{11}).*)$",
"description": "VAT number of the pharmacy/facility or doctor issuing the tax document.",
"type": [
"string",
"null"
]
},
"data_emissione": {
"pattern": "^(.*((\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1]))).*)$",
"description": "Date of issue of the \"fiscal document\" relating to the expenditure incurred by the citizen in yyyy-mm-dd format.",
"type": "string"
},
"dispositivo": {
"description": "Sequential number of the device generating the document. A device is defined as the sequence of the cash register used by merchants issuing commercial documents; for the issuance of invoices or tax receipts the field takes the recommended value = 1.",
"type": "string"
},
"numero_documento_fiscale": {
"pattern": "^(.*[A-Za-z0-9_./\\\\\\-]{1,20}.*)$",
"description": "Identification number of the document issued. Unique within of the date. It is unique by day (receipts) or by year (invoice).",
"type": "string"
},
"spesa": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Spesa"
}
},
"data_pagamento": {
"pattern": "^(.*((\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1]))).*)$",
"description": "Date of payment pertaining to the 'tax document' issued in yyyy-mm-dd format. It must be on or after the issue date and it can only be earlier than the issue date if the advance payment flag is set to 1 (and in any case not less than 2015-01-01).",
"type": [
"string",
"null"
]
},
"flag_pagamento_anticipato": {
"enum": [
1
],
"description": "The field must be set to \"1\" to indicate payment of the expenditure incurred by the citizen on a date before the date of issue of the \"tax document'.",
"type": [
"integer",
"null"
]
},
"cf_cittadino": {
"description": "Citizen's tax code taken from the Tessera Sanitaria card.",
"type": [
"string",
"null"
]
},
"pagamento_tracciato": {
"enum": [
"SI",
"NO"
],
"description": "The field describes the payment method and accepts the values SI/NO:\n- SI: in the manner provided for in paragraph 679 of Article 1 of Law 160 of 27 /12/2019 (Budget Law 2020)\n- NO: in cash\".",
"type": [
"string",
"null"
]
},
"tipo_documento": {
"enum": [
"F",
"D"
],
"description": "Type of document certifying payment of the service or of the health care item:\n- F: Invoice\n- D: Commercial Document.",
"type": [
"string",
"null"
]
},
"flag_opposizione": {
"enum": [
0,
1
],
"description": "Indicates the citizen's wish not to allow the expenditure data to be sent to the Revenue Agency for the purpose of preparing the Precompiled declaration:\n- 0: the citizen does NOT oppose\n- 1: the citizen does oppose.",
"type": [
"integer",
"null"
]
}
},
"required": [
"cf_proprietario",
"data_emissione",
"dispositivo",
"numero_documento_fiscale",
"data_pagamento",
"pagamento_tracciato",
"tipo_documento",
"flag_opposizione"
]
},
"Expense.ExpenseOperationInput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"opzionale1": {
"description": "Field currently used by users who:\n- are attested to the SistemaTS with Client certificate (contains the IDENTIFICATION CODE)\n- use Entratel credentials (tax intermediaries: contains tax code - SEAT code).",
"type": [
"string",
"null"
]
},
"opzionale2": {
"type": [
"string",
"null"
]
},
"opzionale3": {
"type": [
"string",
"null"
]
},
"cf_proprietario": {
"maxLength": 16,
"description": "Tax code of the structure or of the professional.",
"type": [
"string",
"null"
]
},
"codice_regione": {
"description": "The 3 chars region code, see the list https://sistemats1.sanita.finanze.it/portale/documents/20182/34254/allegato%2Btecnico%2BTS-CNS%2Bex%2BDL%2B78-2010_v22-06-12.pdf/2ef2b969-879c-64f5-2b0a-8bce9877c08f (this is not needed for professionals).",
"type": [
"string",
"null"
]
},
"codice_asl": {
"description": "The 3 chars ASL code (this is not needed for professionals).",
"type": [
"string",
"null"
]
},
"codice_ssa": {
"description": "The 5 or 6 chars SSA code (this is not needed for professionals).",
"type": [
"string",
"null"
]
},
"partita_iva": {
"pattern": "^((\\d{11}).*)$",
"description": "VAT number of the pharmacy/facility or doctor issuing the tax document.",
"type": [
"string",
"null"
]
},
"data_emissione": {
"pattern": "^(.*((\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1]))).*)$",
"description": "Date of issue of the \"fiscal document\" relating to the expenditure incurred by the citizen in yyyy-mm-dd format.",
"type": "string"
},
"dispositivo": {
"description": "Sequential number of the device generating the document. A device is defined as the sequence of the cash register used by merchants issuing commercial documents; for the issuance of invoices or tax receipts the field takes the recommended value = 1.",
"type": "string"
},
"numero_documento_fiscale": {
"pattern": "^(.*[A-Za-z0-9_./\\\\\\-]{1,20}.*)$",
"description": "Identification number of the document issued. Unique within of the date. It is unique by day (receipts) or by year (invoice).",
"type": "string"
},
"spesa": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Spesa.jsonld"
}
},
"data_pagamento": {
"pattern": "^(.*((\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1]))).*)$",
"description": "Date of payment pertaining to the 'tax document' issued in yyyy-mm-dd format. It must be on or after the issue date and it can only be earlier than the issue date if the advance payment flag is set to 1 (and in any case not less than 2015-01-01).",
"type": [
"string",
"null"
]
},
"flag_pagamento_anticipato": {
"enum": [
1
],
"description": "The field must be set to \"1\" to indicate payment of the expenditure incurred by the citizen on a date before the date of issue of the \"tax document'.",
"type": [
"integer",
"null"
]
},
"cf_cittadino": {
"description": "Citizen's tax code taken from the Tessera Sanitaria card.",
"type": [
"string",
"null"
]
},
"pagamento_tracciato": {
"enum": [
"SI",
"NO"
],
"description": "The field describes the payment method and accepts the values SI/NO:\n- SI: in the manner provided for in paragraph 679 of Article 1 of Law 160 of 27 /12/2019 (Budget Law 2020)\n- NO: in cash\".",
"type": [
"string",
"null"
]
},
"tipo_documento": {
"enum": [
"F",
"D"
],
"description": "Type of document certifying payment of the service or of the health care item:\n- F: Invoice\n- D: Commercial Document.",
"type": [
"string",
"null"
]
},
"flag_opposizione": {
"enum": [
0,
1
],
"description": "Indicates the citizen's wish not to allow the expenditure data to be sent to the Revenue Agency for the purpose of preparing the Precompiled declaration:\n- 0: the citizen does NOT oppose\n- 1: the citizen does oppose.",
"type": [
"integer",
"null"
]
}
},
"required": [
"cf_proprietario",
"data_emissione",
"dispositivo",
"numero_documento_fiscale",
"data_pagamento",
"pagamento_tracciato",
"tipo_documento",
"flag_opposizione"
]
},
"Expense.ExpenseOperationOutput-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"uuid": {
"type": "string",
"format": "uuid"
},
"outcome": {
"description": "Outcome of service request:\n- 0: accepted without warnings\n- 1: blocking error found\n- 2: accepted with warnings.",
"type": [
"string",
"null"
],
"enum": [
"0",
"1",
"2"
]
},
"messages": {
"description": "Message list.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpenseOperationOutputMessages-read"
}
},
"protocol": {
"description": "Protocol number. 17-digit number unique identifier of the operation executed assigned by SistemaTS to this request.",
"type": [
"string",
"null"
]
}
}
},
"Expense.ExpenseOperationOutput.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"uuid": {
"type": "string",
"format": "uuid"
},
"outcome": {
"description": "Outcome of service request:\n- 0: accepted without warnings\n- 1: blocking error found\n- 2: accepted with warnings.",
"type": [
"string",
"null"
],
"enum": [
"0",
"1",
"2"
]
},
"messages": {
"description": "Message list.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpenseOperationOutputMessages.jsonld-read"
}
},
"protocol": {
"description": "Protocol number. 17-digit number unique identifier of the operation executed assigned by SistemaTS to this request.",
"type": [
"string",
"null"
]
}
}
},
"Expense.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"requests": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SistemaTSRequest.jsonld-read"
}
},
"codice_fiscale_proprietario": {
"type": "string"
},
"codice_fiscale_cittadino": {
"type": [
"string",
"null"
]
},
"created_at": {
"readOnly": true,
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"amount": {
"type": "string"
}
}
},
"ExpenseOperationOutputMessages-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"code": {
"description": "The field identifies the code of this message.",
"type": "string"
},
"description": {
"description": "The field identifies the description of this message.",
"type": "string"
},
"type": {
"description": "Message type:\n- E: rejecting error\n- W: warning\n- S: statistics.",
"type": "string",
"enum": [
"E",
"W",
"S"
]
}
}
},
"ExpenseOperationOutputMessages.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"code": {
"description": "The field identifies the code of this message.",
"type": "string"
},
"description": {
"description": "The field identifies the description of this message.",
"type": "string"
},
"type": {
"description": "Message type:\n- E: rejecting error\n- W: warning\n- S: statistics.",
"type": "string",
"enum": [
"E",
"W",
"S"
]
}
}
},
"FatturaElettronicaBody-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"dati_generali",
"dati_beni_servizi"
],
"properties": {
"dati_generali": {
"$ref": "#/components/schemas/DatiGenerali-write"
},
"dati_beni_servizi": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DatiBeniServizi-write"
}
},
"allegati": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/Allegati-write"
}
}
}
},
"FatturaElettronicaHeader-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"dati_trasmissione",
"cedente_prestatore",
"cessionario_committente"
],
"properties": {
"dati_trasmissione": {
"$ref": "#/components/schemas/DatiTrasmissione-write"
},
"cedente_prestatore": {
"$ref": "#/components/schemas/CedentePrestatore-write"
},
"cessionario_committente": {
"$ref": "#/components/schemas/CessionarioCommittente-write"
},
"soggetto_emittente": {
"minLength": 2,
"maxLength": 2,
"enum": [
"CC",
"TZ"
],
"type": [
"string",
"null"
]
}
}
},
"FatturaElettronicaSemplificata.Allegati-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"nome_attachment": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"algoritmo_compressione": {
"minLength": 1,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"formato_attachment": {
"minLength": 1,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"descrizione_attachment": {
"minLength": 1,
"maxLength": 100,
"type": [
"string",
"null"
]
},
"attachment": {}
}
},
"FatturaElettronicaSemplificata.Allegati.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"nome_attachment": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"algoritmo_compressione": {
"minLength": 1,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"formato_attachment": {
"minLength": 1,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"descrizione_attachment": {
"minLength": 1,
"maxLength": 100,
"type": [
"string",
"null"
]
},
"attachment": {}
}
},
"FatturaElettronicaSemplificata.AltriDatiIdentificativi-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"denominazione": {
"minLength": 1,
"maxLength": 80,
"description": "Company name, to be filled in case 'nome' and 'cognome' are empty",
"type": [
"string",
"null"
]
},
"nome": {
"minLength": 1,
"maxLength": 60,
"description": "Physical person's name, to be filled with 'cognome' in case 'denominazione' is empty",
"type": [
"string",
"null"
]
},
"cognome": {
"minLength": 1,
"maxLength": 60,
"description": "Physical person's surname, to be filled with 'name' in case 'denominazione' is empty",
"type": [
"string",
"null"
]
},
"sede": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.Indirizzo-write"
},
{
"type": "null"
}
]
},
"stabile_organizzazione": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.Indirizzo-write"
},
{
"type": "null"
}
]
},
"rappresentante_fiscale": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.RappresentanteFiscale-write"
},
{
"type": "null"
}
]
}
}
},
"FatturaElettronicaSemplificata.AltriDatiIdentificativi.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"denominazione": {
"minLength": 1,
"maxLength": 80,
"description": "Company name, to be filled in case 'nome' and 'cognome' are empty",
"type": [
"string",
"null"
]
},
"nome": {
"minLength": 1,
"maxLength": 60,
"description": "Physical person's name, to be filled with 'cognome' in case 'denominazione' is empty",
"type": [
"string",
"null"
]
},
"cognome": {
"minLength": 1,
"maxLength": 60,
"description": "Physical person's surname, to be filled with 'name' in case 'denominazione' is empty",
"type": [
"string",
"null"
]
},
"sede": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.Indirizzo.jsonld-write"
},
{
"type": "null"
}
]
},
"stabile_organizzazione": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.Indirizzo.jsonld-write"
},
{
"type": "null"
}
]
},
"rappresentante_fiscale": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.RappresentanteFiscale.jsonld-write"
},
{
"type": "null"
}
]
}
}
},
"FatturaElettronicaSemplificata.CedentePrestatore-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_fiscale_iva": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.IdFiscale-write"
},
{
"type": "null"
}
]
},
"codice_fiscale": {
"minLength": 11,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"denominazione": {
"minLength": 1,
"maxLength": 80,
"description": "Company name, to be filled in case 'nome' and 'cognome' are empty",
"type": [
"string",
"null"
]
},
"nome": {
"minLength": 1,
"maxLength": 60,
"description": "Physical person's name, to be filled with 'cognome' in case 'denominazione' is empty",
"type": [
"string",
"null"
]
},
"cognome": {
"minLength": 1,
"maxLength": 60,
"description": "Physical person's surname, to be filled with 'name' in case 'denominazione' is empty",
"type": [
"string",
"null"
]
},
"sede": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.Indirizzo-write"
},
{
"type": "null"
}
]
},
"stabile_organizzazione": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.Indirizzo-write"
},
{
"type": "null"
}
]
},
"rappresentante_fiscale": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.RappresentanteFiscale-write"
},
{
"type": "null"
}
]
},
"iscrizione_rea": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.IscrizioneREA-write"
},
{
"type": "null"
}
]
},
"regime_fiscale": {
"enum": [
"RF01",
"RF02",
"RF04",
"RF05",
"RF06",
"RF07",
"RF08",
"RF09",
"RF10",
"RF11",
"RF12",
"RF13",
"RF14",
"RF15",
"RF16",
"RF17",
"RF18",
"RF19",
"RF20"
],
"description": "Can be one of\n RF01 Ordinario\n RF02 Contribuenti minimi ( art .1 , c .96 -117 , L . 244 /07)\n RF04 Agricoltura e attivit\u00e0 connesse e pesca ( artt .34 e 34 -bis, DPR 633 /72)\n RF05 Vendita sali e tabacchi ( art .74 , c .1 , DPR . 633 /72)\n RF06 Commercio fiammiferi ( art .74 , c .1 , DPR 633 /72)\n RF07 Editoria ( art .74 , c .1 , DPR 633 /72)\n RF08 Gestione servizi telefonia pubblica ( art .74 , c .1 , DPR 633 /72)\n RF09 Rivendita documenti di trasporto pubblico e di sosta ( art .74 , c .1 , DPR 633 /72)\n RF10 Intrattenimenti , giochi e altre attivit\u00e0 di cui alla tariffa allegata al DPR 640 /72 ( art .74 , c .6 , DPR 633 /72)\n RF11 Agenzie viaggi e turismo ( art .74 -ter, DPR 633 /72)\n RF12 Agriturismo ( art .5 , c .2 , L . 413 /91)\n RF13 Vendite a domicilio ( art .25 -bis, c .6 , DPR 600 /73)\n RF14 Rivendita beni usati , oggetti d\u2019arte , d\u2019antiquariato o da collezione ( art .36 , DL 41 /95)\n RF15 Agenzie di vendite all\u2019asta di oggetti d\u2019arte , antiquariato o da collezione ( art .40 -bis, DL 41 /95)\n RF16 IVA per cassa P .A. ( art .6 , c .5 , DPR 633 /72)\n RF17 IVA per cassa ( art . 32 -bis, DL 83 /2012)\n RF18 Altro\n RF19 Regime forfettario ( art .1 , c .54 -89 , L . 190 /2014)\n RF20 Regime transfrontaliero di Franchigia IVA (Direttiva UE 2020/285)",
"type": [
"string",
"null"
]
}
}
},
"FatturaElettronicaSemplificata.CedentePrestatore.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_fiscale_iva": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.IdFiscale.jsonld-write"
},
{
"type": "null"
}
]
},
"codice_fiscale": {
"minLength": 11,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"denominazione": {
"minLength": 1,
"maxLength": 80,
"description": "Company name, to be filled in case 'nome' and 'cognome' are empty",
"type": [
"string",
"null"
]
},
"nome": {
"minLength": 1,
"maxLength": 60,
"description": "Physical person's name, to be filled with 'cognome' in case 'denominazione' is empty",
"type": [
"string",
"null"
]
},
"cognome": {
"minLength": 1,
"maxLength": 60,
"description": "Physical person's surname, to be filled with 'name' in case 'denominazione' is empty",
"type": [
"string",
"null"
]
},
"sede": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.Indirizzo.jsonld-write"
},
{
"type": "null"
}
]
},
"stabile_organizzazione": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.Indirizzo.jsonld-write"
},
{
"type": "null"
}
]
},
"rappresentante_fiscale": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.RappresentanteFiscale.jsonld-write"
},
{
"type": "null"
}
]
},
"iscrizione_rea": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.IscrizioneREA.jsonld-write"
},
{
"type": "null"
}
]
},
"regime_fiscale": {
"enum": [
"RF01",
"RF02",
"RF04",
"RF05",
"RF06",
"RF07",
"RF08",
"RF09",
"RF10",
"RF11",
"RF12",
"RF13",
"RF14",
"RF15",
"RF16",
"RF17",
"RF18",
"RF19",
"RF20"
],
"description": "Can be one of\n RF01 Ordinario\n RF02 Contribuenti minimi ( art .1 , c .96 -117 , L . 244 /07)\n RF04 Agricoltura e attivit\u00e0 connesse e pesca ( artt .34 e 34 -bis, DPR 633 /72)\n RF05 Vendita sali e tabacchi ( art .74 , c .1 , DPR . 633 /72)\n RF06 Commercio fiammiferi ( art .74 , c .1 , DPR 633 /72)\n RF07 Editoria ( art .74 , c .1 , DPR 633 /72)\n RF08 Gestione servizi telefonia pubblica ( art .74 , c .1 , DPR 633 /72)\n RF09 Rivendita documenti di trasporto pubblico e di sosta ( art .74 , c .1 , DPR 633 /72)\n RF10 Intrattenimenti , giochi e altre attivit\u00e0 di cui alla tariffa allegata al DPR 640 /72 ( art .74 , c .6 , DPR 633 /72)\n RF11 Agenzie viaggi e turismo ( art .74 -ter, DPR 633 /72)\n RF12 Agriturismo ( art .5 , c .2 , L . 413 /91)\n RF13 Vendite a domicilio ( art .25 -bis, c .6 , DPR 600 /73)\n RF14 Rivendita beni usati , oggetti d\u2019arte , d\u2019antiquariato o da collezione ( art .36 , DL 41 /95)\n RF15 Agenzie di vendite all\u2019asta di oggetti d\u2019arte , antiquariato o da collezione ( art .40 -bis, DL 41 /95)\n RF16 IVA per cassa P .A. ( art .6 , c .5 , DPR 633 /72)\n RF17 IVA per cassa ( art . 32 -bis, DL 83 /2012)\n RF18 Altro\n RF19 Regime forfettario ( art .1 , c .54 -89 , L . 190 /2014)\n RF20 Regime transfrontaliero di Franchigia IVA (Direttiva UE 2020/285)",
"type": [
"string",
"null"
]
}
}
},
"FatturaElettronicaSemplificata.CessionarioCommittente-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"identificativi_fiscali": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.IdentificativiFiscali-write"
},
{
"type": "null"
}
]
},
"altri_dati_identificativi": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.AltriDatiIdentificativi-write"
},
{
"type": "null"
}
]
}
}
},
"FatturaElettronicaSemplificata.CessionarioCommittente.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"identificativi_fiscali": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.IdentificativiFiscali.jsonld-write"
},
{
"type": "null"
}
]
},
"altri_dati_identificativi": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.AltriDatiIdentificativi.jsonld-write"
},
{
"type": "null"
}
]
}
}
},
"FatturaElettronicaSemplificata.DatiBeniServizi-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"descrizione": {
"minLength": 1,
"maxLength": 1000,
"type": [
"string",
"null"
]
},
"importo": {
"type": [
"string",
"null"
]
},
"dati_iva": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.DatiIVA-write"
},
{
"type": "null"
}
]
},
"natura": {
"enum": [
"N1",
"N2",
"N2.1",
"N2.2",
"N3",
"N3.1",
"N3.2",
"N3.3",
"N3.4",
"N3.5",
"N3.6",
"N4",
"N5"
],
"description": "Can be one of\n N1 escluse ex art . 15\n N2 non soggette\n N2 .1 non soggette ad IVA ai sensi degli artt . da 7 a 7 -septies del DPR 633 /72\n N2 .2 non soggette - altri casi\n N3 non imponibili\n N3 .1 non imponibili - esportazioni\n N3 .2 non imponibili - cessioni intracomunitarie\n N3 .3 non imponibili - cessioni verso San Marino\n N3 .4 non imponibili - operazioni assimilate alle cessioni all 'esportazione\n N3 .5 non imponibili - a seguito di dichiarazioni d 'intento\n N3 .6 non imponibili - altre operazioni che non concorrono alla formazione del plafond\n N4 esenti\n N5 regime del margine / IVA non esposta in fattura )",
"type": [
"string",
"null"
]
},
"riferimento_normativo": {
"minLength": 1,
"maxLength": 100,
"type": [
"string",
"null"
]
}
}
},
"FatturaElettronicaSemplificata.DatiBeniServizi.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"descrizione": {
"minLength": 1,
"maxLength": 1000,
"type": [
"string",
"null"
]
},
"importo": {
"type": [
"string",
"null"
]
},
"dati_iva": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.DatiIVA.jsonld-write"
},
{
"type": "null"
}
]
},
"natura": {
"enum": [
"N1",
"N2",
"N2.1",
"N2.2",
"N3",
"N3.1",
"N3.2",
"N3.3",
"N3.4",
"N3.5",
"N3.6",
"N4",
"N5"
],
"description": "Can be one of\n N1 escluse ex art . 15\n N2 non soggette\n N2 .1 non soggette ad IVA ai sensi degli artt . da 7 a 7 -septies del DPR 633 /72\n N2 .2 non soggette - altri casi\n N3 non imponibili\n N3 .1 non imponibili - esportazioni\n N3 .2 non imponibili - cessioni intracomunitarie\n N3 .3 non imponibili - cessioni verso San Marino\n N3 .4 non imponibili - operazioni assimilate alle cessioni all 'esportazione\n N3 .5 non imponibili - a seguito di dichiarazioni d 'intento\n N3 .6 non imponibili - altre operazioni che non concorrono alla formazione del plafond\n N4 esenti\n N5 regime del margine / IVA non esposta in fattura )",
"type": [
"string",
"null"
]
},
"riferimento_normativo": {
"minLength": 1,
"maxLength": 100,
"type": [
"string",
"null"
]
}
}
},
"FatturaElettronicaSemplificata.DatiFatturaRettificata-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"numero_fr": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
},
"data_fr": {
"externalDocs": {
"url": "https://schema.org/Date"
},
"type": [
"string",
"null"
]
},
"elementi_rettificati": {
"minLength": 1,
"maxLength": 1000,
"type": [
"string",
"null"
]
}
}
},
"FatturaElettronicaSemplificata.DatiFatturaRettificata.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"numero_fr": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
},
"data_fr": {
"externalDocs": {
"url": "https://schema.org/Date"
},
"type": [
"string",
"null"
]
},
"elementi_rettificati": {
"minLength": 1,
"maxLength": 1000,
"type": [
"string",
"null"
]
}
}
},
"FatturaElettronicaSemplificata.DatiGenerali-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"dati_generali_documento": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.DatiGeneraliDocumento-write"
},
{
"type": "null"
}
]
},
"dati_fattura_rettificata": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.DatiFatturaRettificata-write"
},
{
"type": "null"
}
]
}
}
},
"FatturaElettronicaSemplificata.DatiGenerali.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"dati_generali_documento": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.DatiGeneraliDocumento.jsonld-write"
},
{
"type": "null"
}
]
},
"dati_fattura_rettificata": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.DatiFatturaRettificata.jsonld-write"
},
{
"type": "null"
}
]
}
}
},
"FatturaElettronicaSemplificata.DatiGeneraliDocumento-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"tipo_documento": {
"enum": [
"TD07",
"TD08",
"TD09"
],
"description": "Can be one of\n TD07 fattura semplificata\n TD08 nota di credito semplificata\n TD09 nota di debito semplificata",
"type": [
"string",
"null"
]
},
"divisa": {
"externalDocs": {
"url": "https://schema.org/priceCurrency"
},
"type": [
"string",
"null"
]
},
"data": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"numero": {
"minLength": 1,
"maxLength": 20,
"allOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"bollo_virtuale": {
"enum": [
"SI"
],
"type": [
"string",
"null"
]
}
}
},
"FatturaElettronicaSemplificata.DatiGeneraliDocumento.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"tipo_documento": {
"enum": [
"TD07",
"TD08",
"TD09"
],
"description": "Can be one of\n TD07 fattura semplificata\n TD08 nota di credito semplificata\n TD09 nota di debito semplificata",
"type": [
"string",
"null"
]
},
"divisa": {
"externalDocs": {
"url": "https://schema.org/priceCurrency"
},
"type": [
"string",
"null"
]
},
"data": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"numero": {
"minLength": 1,
"maxLength": 20,
"allOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"bollo_virtuale": {
"enum": [
"SI"
],
"type": [
"string",
"null"
]
}
}
},
"FatturaElettronicaSemplificata.DatiIVA-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"imposta": {
"type": [
"string",
"null"
]
},
"aliquota": {
"type": [
"string",
"null"
]
}
}
},
"FatturaElettronicaSemplificata.DatiIVA.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"imposta": {
"type": [
"string",
"null"
]
},
"aliquota": {
"type": [
"string",
"null"
]
}
}
},
"FatturaElettronicaSemplificata.DatiTrasmissione-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_trasmittente": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.IdFiscale-write"
},
{
"type": "null"
}
]
},
"progressivo_invio": {
"allOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"formato_trasmissione": {
"type": [
"string",
"null"
]
},
"codice_destinatario": {
"pattern": "^([A-Za-z0-9]{6,7})$",
"type": [
"string",
"null"
]
},
"pec_destinatario": {
"minLength": 7,
"maxLength": 256,
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
}
}
},
"FatturaElettronicaSemplificata.DatiTrasmissione.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_trasmittente": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.IdFiscale.jsonld-write"
},
{
"type": "null"
}
]
},
"progressivo_invio": {
"allOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"formato_trasmissione": {
"type": [
"string",
"null"
]
},
"codice_destinatario": {
"pattern": "^([A-Za-z0-9]{6,7})$",
"type": [
"string",
"null"
]
},
"pec_destinatario": {
"minLength": 7,
"maxLength": 256,
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
}
}
},
"FatturaElettronicaSemplificata.FatturaElettronicaBody-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"dati_generali": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.DatiGenerali-write"
},
{
"type": "null"
}
]
},
"dati_beni_servizi": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.DatiBeniServizi-write"
}
},
"allegati": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.Allegati-write"
}
}
}
},
"FatturaElettronicaSemplificata.FatturaElettronicaBody.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"dati_generali": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.DatiGenerali.jsonld-write"
},
{
"type": "null"
}
]
},
"dati_beni_servizi": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.DatiBeniServizi.jsonld-write"
}
},
"allegati": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.Allegati.jsonld-write"
}
}
}
},
"FatturaElettronicaSemplificata.FatturaElettronicaHeader-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"dati_trasmissione": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.DatiTrasmissione-write"
},
{
"type": "null"
}
]
},
"cedente_prestatore": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.CedentePrestatore-write"
},
{
"type": "null"
}
]
},
"cessionario_committente": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.CessionarioCommittente-write"
},
{
"type": "null"
}
]
},
"soggetto_emittente": {
"minLength": 2,
"maxLength": 2,
"enum": [
"CC",
"TZ"
],
"type": [
"string",
"null"
]
}
}
},
"FatturaElettronicaSemplificata.FatturaElettronicaHeader.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"dati_trasmissione": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.DatiTrasmissione.jsonld-write"
},
{
"type": "null"
}
]
},
"cedente_prestatore": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.CedentePrestatore.jsonld-write"
},
{
"type": "null"
}
]
},
"cessionario_committente": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.CessionarioCommittente.jsonld-write"
},
{
"type": "null"
}
]
},
"soggetto_emittente": {
"minLength": 2,
"maxLength": 2,
"enum": [
"CC",
"TZ"
],
"type": [
"string",
"null"
]
}
}
},
"FatturaElettronicaSemplificata.IdFiscale-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_paese": {
"minLength": 2,
"maxLength": 2,
"description": "ISO 3166-1 alpha-2 code",
"type": [
"string",
"null"
]
},
"id_codice": {
"minLength": 1,
"maxLength": 28,
"description": "Tax identification code",
"type": [
"string",
"null"
]
}
}
},
"FatturaElettronicaSemplificata.IdFiscale.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_paese": {
"minLength": 2,
"maxLength": 2,
"description": "ISO 3166-1 alpha-2 code",
"type": [
"string",
"null"
]
},
"id_codice": {
"minLength": 1,
"maxLength": 28,
"description": "Tax identification code",
"type": [
"string",
"null"
]
}
}
},
"FatturaElettronicaSemplificata.IdentificativiFiscali-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_fiscale_iva": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.IdFiscale-write"
},
{
"type": "null"
}
]
},
"codice_fiscale": {
"type": [
"string",
"null"
]
}
}
},
"FatturaElettronicaSemplificata.IdentificativiFiscali.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_fiscale_iva": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.IdFiscale.jsonld-write"
},
{
"type": "null"
}
]
},
"codice_fiscale": {
"type": [
"string",
"null"
]
}
}
},
"FatturaElettronicaSemplificata.Indirizzo-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"indirizzo": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"numero_civico": {
"minLength": 1,
"maxLength": 8,
"type": [
"string",
"null"
]
},
"cap": {
"minLength": 5,
"maxLength": 5,
"type": [
"string",
"null"
]
},
"comune": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"provincia": {
"minLength": 2,
"maxLength": 2,
"type": [
"string",
"null"
]
},
"nazione": {
"type": [
"string",
"null"
]
}
}
},
"FatturaElettronicaSemplificata.Indirizzo.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"indirizzo": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"numero_civico": {
"minLength": 1,
"maxLength": 8,
"type": [
"string",
"null"
]
},
"cap": {
"minLength": 5,
"maxLength": 5,
"type": [
"string",
"null"
]
},
"comune": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"provincia": {
"minLength": 2,
"maxLength": 2,
"type": [
"string",
"null"
]
},
"nazione": {
"type": [
"string",
"null"
]
}
}
},
"FatturaElettronicaSemplificata.IscrizioneREA-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"ufficio": {
"minLength": 2,
"maxLength": 2,
"type": [
"string",
"null"
]
},
"numero_rea": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
},
"capitale_sociale": {
"minLength": 4,
"maxLength": 15,
"allOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"socio_unico": {
"enum": [
"SU",
"SM"
],
"type": [
"string",
"null"
]
},
"stato_liquidazione": {
"enum": [
"LS",
"LN"
],
"type": [
"string",
"null"
]
}
}
},
"FatturaElettronicaSemplificata.IscrizioneREA.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"ufficio": {
"minLength": 2,
"maxLength": 2,
"type": [
"string",
"null"
]
},
"numero_rea": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
},
"capitale_sociale": {
"minLength": 4,
"maxLength": 15,
"allOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"socio_unico": {
"enum": [
"SU",
"SM"
],
"type": [
"string",
"null"
]
},
"stato_liquidazione": {
"enum": [
"LS",
"LN"
],
"type": [
"string",
"null"
]
}
}
},
"FatturaElettronicaSemplificata.RappresentanteFiscale-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_fiscale_iva": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.IdFiscale-write"
},
{
"type": "null"
}
]
},
"denominazione": {
"minLength": 1,
"maxLength": 80,
"description": "Company name, to be filled in case 'nome' and 'cognome' are empty",
"type": [
"string",
"null"
]
},
"nome": {
"minLength": 1,
"maxLength": 60,
"description": "Physical person's name, to be filled with 'cognome' in case 'denominazione' is empty",
"type": [
"string",
"null"
]
},
"cognome": {
"minLength": 1,
"maxLength": 60,
"description": "Physical person's surname, to be filled with 'name' in case 'denominazione' is empty",
"type": [
"string",
"null"
]
}
}
},
"FatturaElettronicaSemplificata.RappresentanteFiscale.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_fiscale_iva": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.IdFiscale.jsonld-write"
},
{
"type": "null"
}
]
},
"denominazione": {
"minLength": 1,
"maxLength": 80,
"description": "Company name, to be filled in case 'nome' and 'cognome' are empty",
"type": [
"string",
"null"
]
},
"nome": {
"minLength": 1,
"maxLength": 60,
"description": "Physical person's name, to be filled with 'cognome' in case 'denominazione' is empty",
"type": [
"string",
"null"
]
},
"cognome": {
"minLength": 1,
"maxLength": 60,
"description": "Physical person's surname, to be filled with 'name' in case 'denominazione' is empty",
"type": [
"string",
"null"
]
}
}
},
"FatturaPA.Allegati-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"nome_attachment",
"attachment"
],
"properties": {
"nome_attachment": {
"minLength": 1,
"maxLength": 60,
"type": "string"
},
"algoritmo_compressione": {
"minLength": 1,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"formato_attachment": {
"minLength": 1,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"descrizione_attachment": {
"minLength": 1,
"maxLength": 100,
"type": [
"string",
"null"
]
},
"attachment": {}
}
},
"FatturaPA.CedentePrestatore-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"dati_anagrafici",
"sede"
],
"properties": {
"dati_anagrafici": {
"anyOf": [
{
"$ref": "#/components/schemas/DatiAnagraficiCedentePrestatore-write"
},
{
"type": "null"
}
]
},
"sede": {
"$ref": "#/components/schemas/FatturaPA.Indirizzo-write"
},
"stabile_organizzazione": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPA.Indirizzo-write"
},
{
"type": "null"
}
]
},
"iscrizione_rea": {
"anyOf": [
{
"$ref": "#/components/schemas/IscrizioneREA-write"
},
{
"type": "null"
}
]
},
"contatti": {
"anyOf": [
{
"$ref": "#/components/schemas/Contatti-write"
},
{
"type": "null"
}
]
},
"riferimento_amministrazione": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
}
}
},
"FatturaPA.CessionarioCommittente-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"dati_anagrafici",
"sede"
],
"properties": {
"dati_anagrafici": {
"anyOf": [
{
"$ref": "#/components/schemas/DatiAnagraficiCessionarioCommittente-write"
},
{
"type": "null"
}
]
},
"sede": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPA.Indirizzo-write"
},
{
"type": "null"
}
]
},
"stabile_organizzazione": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPA.Indirizzo-write"
},
{
"type": "null"
}
]
},
"rappresentante_fiscale": {
"anyOf": [
{
"$ref": "#/components/schemas/RappresentanteFiscaleCessionarioCommittente-write"
},
{
"type": "null"
}
]
}
}
},
"FatturaPA.DatiBeniServizi-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"dettaglio_linee",
"dati_riepilogo"
],
"properties": {
"dettaglio_linee": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/DettaglioLinee-write"
}
},
"dati_riepilogo": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/DatiRiepilogo-write"
}
}
}
},
"FatturaPA.DatiGenerali-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"dati_generali_documento"
],
"properties": {
"dati_generali_documento": {
"$ref": "#/components/schemas/FatturaPA.DatiGeneraliDocumento-write"
},
"dati_ordine_acquisto": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/DatiDocumentiCorrelati-write"
}
},
"dati_contratto": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/DatiDocumentiCorrelati-write"
}
},
"dati_convenzione": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/DatiDocumentiCorrelati-write"
}
},
"dati_ricezione": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/DatiDocumentiCorrelati-write"
}
},
"dati_fatture_collegate": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/DatiDocumentiCorrelati-write"
}
},
"dati_sal": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/DatiSAL-write"
}
},
"dati_ddt": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/DatiDDT-write"
}
},
"dati_trasporto": {
"anyOf": [
{
"$ref": "#/components/schemas/DatiTrasporto-write"
},
{
"type": "null"
}
]
},
"fattura_principale": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPrincipale-write"
},
{
"type": "null"
}
]
}
}
},
"FatturaPA.DatiGeneraliDocumento-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"tipo_documento",
"divisa",
"data",
"numero"
],
"properties": {
"tipo_documento": {
"enum": [
"TD01",
"TD02",
"TD03",
"TD04",
"TD05",
"TD06",
"TD16",
"TD17",
"TD18",
"TD19",
"TD20",
"TD21",
"TD22",
"TD23",
"TD24",
"TD25",
"TD26",
"TD27",
"TD28",
"TD29"
],
"description": "Can be one of\n TD01 fattura\n TD02 acconto /anticipo su fattura\n TD03 acconto /anticipo su parcella\n TD04 nota di credito\n TD05 nota di debito\n TD06 parcella\n TD16 integrazione fattura reverse charge interno\n TD17 integrazione /autofattura per acquisto servizi dall 'estero\n TD18 integrazione per acquisto di beni intracomunitari\n TD19 integrazione /autofattura per acquisto di beni ex art .17 c .2 DPR 633 /72\n TD20 autofattura per regolarizzazione e integrazione delle fatture (ex art. 6 c.9-bis d.lgs. 471/97 o art.46 c.5 D.L. 331/93)\n TD21 autofattura per splafonamento\n TD22 estrazione beni da Deposito IVA\n TD23 estrazione beni da Deposito IVA con versamento dell 'IVA\n TD24 fattura differita di cui all 'art. 21 , comma 4 , lett . a )\n TD25 fattura differita di cui all 'art. 21 , comma 4 , terzo periodo lett . b )\n TD26 cessione di beni ammortizzabili e per passaggi interni ( ex art .36 DPR 633 /72)\n TD27 fattura per autoconsumo o per cessioni gratuite senza rivalsa\n TD28 acquisti da San Marino con IVA ( fattura cartacea )\n TD29 comunicazione per omessa o irregolare fatturazione (art. 6, comma 8, D.Lgs. 471/97)",
"type": "string"
},
"divisa": {
"externalDocs": {
"url": "https://schema.org/priceCurrency"
},
"type": "string"
},
"data": {
"type": "string",
"format": "date-time"
},
"numero": {
"allOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"dati_ritenuta": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/DatiRitenuta-write"
}
},
"dati_bollo": {
"anyOf": [
{
"$ref": "#/components/schemas/DatiBollo-write"
},
{
"type": "null"
}
]
},
"dati_cassa_previdenziale": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/DatiCassaPrevidenziale-write"
}
},
"sconto_maggiorazione": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/ScontoMaggiorazione-write"
}
},
"importo_totale_documento": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"arrotondamento": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"causale": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"art73": {
"minLength": 2,
"maxLength": 2,
"enum": [
"SI"
],
"type": [
"string",
"null"
]
}
}
},
"FatturaPA.DatiTrasmissione-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"codice_destinatario"
],
"properties": {
"codice_destinatario": {
"pattern": "^([A-Za-z0-9]{6,7})$",
"type": "string"
},
"pec_destinatario": {
"minLength": 7,
"maxLength": 256,
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
}
}
},
"FatturaPA.FatturaElettronicaBody-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"dati_generali",
"dati_beni_servizi"
],
"properties": {
"dati_generali": {
"$ref": "#/components/schemas/FatturaPA.DatiGenerali-write"
},
"dati_beni_servizi": {
"$ref": "#/components/schemas/FatturaPA.DatiBeniServizi-write"
},
"dati_veicoli": {
"anyOf": [
{
"$ref": "#/components/schemas/DatiVeicoli-write"
},
{
"type": "null"
}
]
},
"dati_pagamento": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/DatiPagamento-write"
}
},
"allegati": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPA.Allegati-write"
}
}
}
},
"FatturaPA.FatturaElettronicaHeader-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"dati_trasmissione",
"cedente_prestatore",
"cessionario_committente"
],
"properties": {
"dati_trasmissione": {
"$ref": "#/components/schemas/FatturaPA.DatiTrasmissione-write"
},
"cedente_prestatore": {
"$ref": "#/components/schemas/FatturaPA.CedentePrestatore-write"
},
"rappresentante_fiscale": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPA.RappresentanteFiscale-write"
},
{
"type": "null"
}
]
},
"cessionario_committente": {
"$ref": "#/components/schemas/FatturaPA.CessionarioCommittente-write"
},
"terzo_intermediario_o_soggetto_emittente": {
"anyOf": [
{
"$ref": "#/components/schemas/TerzoIntermediarioSoggettoEmittente-write"
},
{
"type": "null"
}
]
},
"soggetto_emittente": {
"minLength": 2,
"maxLength": 2,
"enum": [
"CC",
"TZ"
],
"type": [
"string",
"null"
]
}
}
},
"FatturaPA.IdFiscale-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"id_paese",
"id_codice"
],
"properties": {
"id_paese": {
"minLength": 2,
"maxLength": 2,
"description": "ISO 3166-1 alpha-2 code",
"type": [
"string",
"null"
]
},
"id_codice": {
"minLength": 1,
"maxLength": 28,
"description": "Tax identification code",
"type": [
"string",
"null"
]
}
}
},
"FatturaPA.Indirizzo-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"indirizzo",
"cap",
"comune",
"nazione"
],
"properties": {
"indirizzo": {
"minLength": 1,
"maxLength": 60,
"type": "string"
},
"numero_civico": {
"minLength": 1,
"maxLength": 8,
"type": [
"string",
"null"
]
},
"cap": {
"minLength": 5,
"maxLength": 5,
"type": "string"
},
"comune": {
"minLength": 1,
"maxLength": 60,
"type": "string"
},
"provincia": {
"minLength": 2,
"maxLength": 2,
"type": [
"string",
"null"
]
},
"nazione": {
"type": "string"
}
}
},
"FatturaPA.RappresentanteFiscale-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"dati_anagrafici"
],
"properties": {
"dati_anagrafici": {
"anyOf": [
{
"$ref": "#/components/schemas/DatiAnagraficiRappresentanteFiscale-write"
},
{
"type": "null"
}
]
}
}
},
"FatturaPADraft.Allegati-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"nome_attachment": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"algoritmo_compressione": {
"minLength": 1,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"formato_attachment": {
"minLength": 1,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"descrizione_attachment": {
"minLength": 1,
"maxLength": 100,
"type": [
"string",
"null"
]
},
"attachment": {}
}
},
"FatturaPADraft.Allegati.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"nome_attachment": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"algoritmo_compressione": {
"minLength": 1,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"formato_attachment": {
"minLength": 1,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"descrizione_attachment": {
"minLength": 1,
"maxLength": 100,
"type": [
"string",
"null"
]
},
"attachment": {}
}
},
"FatturaPADraft.AltriDatiGestionali-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"tipo_dato": {
"minLength": 1,
"maxLength": 10,
"description": "Code that identifies the type of information",
"type": [
"string",
"null"
]
},
"riferimento_testo": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"riferimento_numero": {
"minLength": 4,
"maxLength": 21,
"type": [
"string",
"null"
]
},
"riferimento_data": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
},
"FatturaPADraft.AltriDatiGestionali.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"tipo_dato": {
"minLength": 1,
"maxLength": 10,
"description": "Code that identifies the type of information",
"type": [
"string",
"null"
]
},
"riferimento_testo": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"riferimento_numero": {
"minLength": 4,
"maxLength": 21,
"type": [
"string",
"null"
]
},
"riferimento_data": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
},
"FatturaPADraft.Anagrafica-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"denominazione": {
"minLength": 1,
"maxLength": 80,
"description": "Company name, to be filled in case 'nome' and 'cognome' are empty",
"type": [
"string",
"null"
]
},
"nome": {
"minLength": 1,
"maxLength": 60,
"description": "Physical person's name, to be filled with 'cognome' in case 'denominazione' is empty",
"type": [
"string",
"null"
]
},
"cognome": {
"minLength": 1,
"maxLength": 60,
"description": "Physical person's surname, to be filled with 'name' in case 'denominazione' is empty",
"type": [
"string",
"null"
]
},
"titolo": {
"minLength": 2,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"cod_eori": {
"minLength": 13,
"maxLength": 17,
"description": "Economic Operator Registration and Identification",
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.Anagrafica.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"denominazione": {
"minLength": 1,
"maxLength": 80,
"description": "Company name, to be filled in case 'nome' and 'cognome' are empty",
"type": [
"string",
"null"
]
},
"nome": {
"minLength": 1,
"maxLength": 60,
"description": "Physical person's name, to be filled with 'cognome' in case 'denominazione' is empty",
"type": [
"string",
"null"
]
},
"cognome": {
"minLength": 1,
"maxLength": 60,
"description": "Physical person's surname, to be filled with 'name' in case 'denominazione' is empty",
"type": [
"string",
"null"
]
},
"titolo": {
"minLength": 2,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"cod_eori": {
"minLength": 13,
"maxLength": 17,
"description": "Economic Operator Registration and Identification",
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.CedentePrestatore-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"dati_anagrafici": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.DatiAnagraficiCedentePrestatore-write"
},
{
"type": "null"
}
]
},
"sede": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.Indirizzo-write"
},
{
"type": "null"
}
]
},
"stabile_organizzazione": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.Indirizzo-write"
},
{
"type": "null"
}
]
},
"iscrizione_rea": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.IscrizioneREA-write"
},
{
"type": "null"
}
]
},
"contatti": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.Contatti-write"
},
{
"type": "null"
}
]
},
"riferimento_amministrazione": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.CedentePrestatore.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"dati_anagrafici": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.DatiAnagraficiCedentePrestatore.jsonld-write"
},
{
"type": "null"
}
]
},
"sede": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.Indirizzo.jsonld-write"
},
{
"type": "null"
}
]
},
"stabile_organizzazione": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.Indirizzo.jsonld-write"
},
{
"type": "null"
}
]
},
"iscrizione_rea": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.IscrizioneREA.jsonld-write"
},
{
"type": "null"
}
]
},
"contatti": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.Contatti.jsonld-write"
},
{
"type": "null"
}
]
},
"riferimento_amministrazione": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.CessionarioCommittente-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"dati_anagrafici": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.DatiAnagraficiCessionarioCommittente-write"
},
{
"type": "null"
}
]
},
"sede": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.Indirizzo-write"
},
{
"type": "null"
}
]
},
"stabile_organizzazione": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.Indirizzo-write"
},
{
"type": "null"
}
]
},
"rappresentante_fiscale": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.RappresentanteFiscaleCessionarioCommittente-write"
},
{
"type": "null"
}
]
}
}
},
"FatturaPADraft.CessionarioCommittente.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"dati_anagrafici": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.DatiAnagraficiCessionarioCommittente.jsonld-write"
},
{
"type": "null"
}
]
},
"sede": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.Indirizzo.jsonld-write"
},
{
"type": "null"
}
]
},
"stabile_organizzazione": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.Indirizzo.jsonld-write"
},
{
"type": "null"
}
]
},
"rappresentante_fiscale": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.RappresentanteFiscaleCessionarioCommittente.jsonld-write"
},
{
"type": "null"
}
]
}
}
},
"FatturaPADraft.CodiceArticolo-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"codice_tipo": {
"minLength": 1,
"maxLength": 35,
"type": [
"string",
"null"
]
},
"codice_valore": {
"minLength": 1,
"maxLength": 35,
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.CodiceArticolo.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"codice_tipo": {
"minLength": 1,
"maxLength": 35,
"type": [
"string",
"null"
]
},
"codice_valore": {
"minLength": 1,
"maxLength": 35,
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.Contatti-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"telefono": {
"minLength": 5,
"maxLength": 12,
"type": [
"string",
"null"
]
},
"fax": {
"minLength": 5,
"maxLength": 12,
"type": [
"string",
"null"
]
},
"email": {
"minLength": 7,
"maxLength": 256,
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.Contatti.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"telefono": {
"minLength": 5,
"maxLength": 12,
"type": [
"string",
"null"
]
},
"fax": {
"minLength": 5,
"maxLength": 12,
"type": [
"string",
"null"
]
},
"email": {
"minLength": 7,
"maxLength": 256,
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.DatiAnagraficiCedentePrestatore-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_fiscale_iva": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.IdFiscale-write"
},
{
"type": "null"
}
]
},
"codice_fiscale": {
"minLength": 11,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"anagrafica": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.Anagrafica-write"
},
{
"type": "null"
}
]
},
"albo_professionale": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"provincia_albo": {
"minLength": 2,
"maxLength": 2,
"type": [
"string",
"null"
]
},
"numero_iscrizione_albo": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"data_iscrizione_albo": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"regime_fiscale": {
"enum": [
"RF01",
"RF02",
"RF04",
"RF05",
"RF06",
"RF07",
"RF08",
"RF09",
"RF10",
"RF11",
"RF12",
"RF13",
"RF14",
"RF15",
"RF16",
"RF17",
"RF18",
"RF19",
"RF20"
],
"description": "Can be one of\n RF01 Ordinario\n RF02 Contribuenti minimi ( art .1 , c .96 -117 , L . 244 /07)\n RF04 Agricoltura e attivit\u00e0 connesse e pesca ( artt .34 e 34 -bis, DPR 633 /72)\n RF05 Vendita sali e tabacchi ( art .74 , c .1 , DPR . 633 /72)\n RF06 Commercio fiammiferi ( art .74 , c .1 , DPR 633 /72)\n RF07 Editoria ( art .74 , c .1 , DPR 633 /72)\n RF08 Gestione servizi telefonia pubblica ( art .74 , c .1 , DPR 633 /72)\n RF09 Rivendita documenti di trasporto pubblico e di sosta ( art .74 , c .1 , DPR 633 /72)\n RF10 Intrattenimenti , giochi e altre attivit\u00e0 di cui alla tariffa allegata al DPR 640 /72 ( art .74 , c .6 , DPR 633 /72)\n RF11 Agenzie viaggi e turismo ( art .74 -ter, DPR 633 /72)\n RF12 Agriturismo ( art .5 , c .2 , L . 413 /91)\n RF13 Vendite a domicilio ( art .25 -bis, c .6 , DPR 600 /73)\n RF14 Rivendita beni usati , oggetti d\u2019arte , d\u2019antiquariato o da collezione ( art .36 , DL 41 /95)\n RF15 Agenzie di vendite all\u2019asta di oggetti d\u2019arte , antiquariato o da collezione ( art .40 -bis, DL 41 /95)\n RF16 IVA per cassa P .A. ( art .6 , c .5 , DPR 633 /72)\n RF17 IVA per cassa ( art . 32 -bis, DL 83 /2012)\n RF18 Altro\n RF19 Regime forfettario ( art .1 , c .54 -89 , L . 190 /2014)\n RF20 Regime transfrontaliero di Franchigia IVA (Direttiva UE 2020/285)",
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.DatiAnagraficiCedentePrestatore.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_fiscale_iva": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.IdFiscale.jsonld-write"
},
{
"type": "null"
}
]
},
"codice_fiscale": {
"minLength": 11,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"anagrafica": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.Anagrafica.jsonld-write"
},
{
"type": "null"
}
]
},
"albo_professionale": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"provincia_albo": {
"minLength": 2,
"maxLength": 2,
"type": [
"string",
"null"
]
},
"numero_iscrizione_albo": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"data_iscrizione_albo": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"regime_fiscale": {
"enum": [
"RF01",
"RF02",
"RF04",
"RF05",
"RF06",
"RF07",
"RF08",
"RF09",
"RF10",
"RF11",
"RF12",
"RF13",
"RF14",
"RF15",
"RF16",
"RF17",
"RF18",
"RF19",
"RF20"
],
"description": "Can be one of\n RF01 Ordinario\n RF02 Contribuenti minimi ( art .1 , c .96 -117 , L . 244 /07)\n RF04 Agricoltura e attivit\u00e0 connesse e pesca ( artt .34 e 34 -bis, DPR 633 /72)\n RF05 Vendita sali e tabacchi ( art .74 , c .1 , DPR . 633 /72)\n RF06 Commercio fiammiferi ( art .74 , c .1 , DPR 633 /72)\n RF07 Editoria ( art .74 , c .1 , DPR 633 /72)\n RF08 Gestione servizi telefonia pubblica ( art .74 , c .1 , DPR 633 /72)\n RF09 Rivendita documenti di trasporto pubblico e di sosta ( art .74 , c .1 , DPR 633 /72)\n RF10 Intrattenimenti , giochi e altre attivit\u00e0 di cui alla tariffa allegata al DPR 640 /72 ( art .74 , c .6 , DPR 633 /72)\n RF11 Agenzie viaggi e turismo ( art .74 -ter, DPR 633 /72)\n RF12 Agriturismo ( art .5 , c .2 , L . 413 /91)\n RF13 Vendite a domicilio ( art .25 -bis, c .6 , DPR 600 /73)\n RF14 Rivendita beni usati , oggetti d\u2019arte , d\u2019antiquariato o da collezione ( art .36 , DL 41 /95)\n RF15 Agenzie di vendite all\u2019asta di oggetti d\u2019arte , antiquariato o da collezione ( art .40 -bis, DL 41 /95)\n RF16 IVA per cassa P .A. ( art .6 , c .5 , DPR 633 /72)\n RF17 IVA per cassa ( art . 32 -bis, DL 83 /2012)\n RF18 Altro\n RF19 Regime forfettario ( art .1 , c .54 -89 , L . 190 /2014)\n RF20 Regime transfrontaliero di Franchigia IVA (Direttiva UE 2020/285)",
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.DatiAnagraficiCessionarioCommittente-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_fiscale_iva": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.IdFiscale-write"
},
{
"type": "null"
}
]
},
"codice_fiscale": {
"maxLength": 16,
"type": [
"string",
"null"
]
},
"anagrafica": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.Anagrafica-write"
},
{
"type": "null"
}
]
}
}
},
"FatturaPADraft.DatiAnagraficiCessionarioCommittente.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_fiscale_iva": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.IdFiscale.jsonld-write"
},
{
"type": "null"
}
]
},
"codice_fiscale": {
"maxLength": 16,
"type": [
"string",
"null"
]
},
"anagrafica": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.Anagrafica.jsonld-write"
},
{
"type": "null"
}
]
}
}
},
"FatturaPADraft.DatiAnagraficiRappresentanteFiscale-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_fiscale_iva": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.IdFiscale-write"
},
{
"type": "null"
}
]
},
"codice_fiscale": {
"minLength": 11,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"anagrafica": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.Anagrafica-write"
},
{
"type": "null"
}
]
}
}
},
"FatturaPADraft.DatiAnagraficiRappresentanteFiscale.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_fiscale_iva": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.IdFiscale.jsonld-write"
},
{
"type": "null"
}
]
},
"codice_fiscale": {
"minLength": 11,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"anagrafica": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.Anagrafica.jsonld-write"
},
{
"type": "null"
}
]
}
}
},
"FatturaPADraft.DatiAnagraficiTerzoIntermediario-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_fiscale_iva": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.IdFiscale-write"
},
{
"type": "null"
}
]
},
"codice_fiscale": {
"minLength": 11,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"anagrafica": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.Anagrafica-write"
},
{
"type": "null"
}
]
}
}
},
"FatturaPADraft.DatiAnagraficiTerzoIntermediario.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_fiscale_iva": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.IdFiscale.jsonld-write"
},
{
"type": "null"
}
]
},
"codice_fiscale": {
"minLength": 11,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"anagrafica": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.Anagrafica.jsonld-write"
},
{
"type": "null"
}
]
}
}
},
"FatturaPADraft.DatiAnagraficiVettore-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_fiscale_iva": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.IdFiscale-write"
},
{
"type": "null"
}
]
},
"codice_fiscale": {
"minLength": 11,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"anagrafica": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.Anagrafica-write"
},
{
"type": "null"
}
]
},
"numero_licenza_guida": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.DatiAnagraficiVettore.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_fiscale_iva": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.IdFiscale.jsonld-write"
},
{
"type": "null"
}
]
},
"codice_fiscale": {
"minLength": 11,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"anagrafica": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.Anagrafica.jsonld-write"
},
{
"type": "null"
}
]
},
"numero_licenza_guida": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.DatiBeniServizi-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"dettaglio_linee": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DettaglioLinee-write"
}
},
"dati_riepilogo": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DatiRiepilogo-write"
}
}
}
},
"FatturaPADraft.DatiBeniServizi.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"dettaglio_linee": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DettaglioLinee.jsonld-write"
}
},
"dati_riepilogo": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DatiRiepilogo.jsonld-write"
}
}
}
},
"FatturaPADraft.DatiBollo-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"bollo_virtuale": {
"enum": [
"SI"
],
"type": [
"string",
"null"
]
},
"importo_bollo": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.DatiBollo.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"bollo_virtuale": {
"enum": [
"SI"
],
"type": [
"string",
"null"
]
},
"importo_bollo": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.DatiCassaPrevidenziale-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"tipo_cassa": {
"enum": [
"TC01",
"TC02",
"TC03",
"TC04",
"TC05",
"TC06",
"TC07",
"TC08",
"TC09",
"TC10",
"TC11",
"TC12",
"TC13",
"TC14",
"TC15",
"TC16",
"TC17",
"TC18",
"TC19",
"TC20",
"TC21",
"TC22"
],
"description": "Can be one of\n TC01 Cassa nazionale previdenza e assistenza avvocati e procuratori legali\n TC02 Cassa previdenza dottori commercialisti\n TC03 Cassa previdenza e assistenza geometri\n TC04 Cassa nazionale previdenza e assistenza ingegneri e architetti liberi professionisti\n TC05 Cassa nazionale del notariato\n TC06 Cassa nazionale previdenza e assistenza ragionieri e periti commerciali\n TC07 Ente nazionale assistenza agenti e rappresentanti di commercio ( ENASARCO )\n TC08 Ente nazionale previdenza e assistenza consulenti del lavoro ( ENPACL )\n TC09 Ente nazionale previdenza e assistenza medici ( ENPAM )\n TC10 Ente nazionale previdenza e assistenza farmacisti ( ENPAF )\n TC11 Ente nazionale previdenza e assistenza veterinari ( ENPAV )\n TC12 Ente nazionale previdenza e assistenza impiegati dell 'agricoltura ( ENPAIA )\n TC13 Fondo previdenza impiegati imprese di spedizione e agenzie marittime\n TC14 Istituto nazionale previdenza giornalisti italiani ( INPGI )\n TC15 Opera nazionale assistenza orfani sanitari italiani ( ONAOSI )\n TC16 Cassa autonoma assistenza integrativa giornalisti italiani ( CASAGIT )\n TC17 Ente previdenza periti industriali e periti industriali laureati ( EPPI )\n TC18 Ente previdenza e assistenza pluricategoriale ( EPAP )\n TC19 Ente nazionale previdenza e assistenza biologi ( ENPAB )\n TC20 Ente nazionale previdenza e assistenza professione infermieristica ( ENPAPI )\n TC21 Ente nazionale previdenza e assistenza psicologi ( ENPAP )\n TC22 INPS",
"type": [
"string",
"null"
]
},
"al_cassa": {
"minLength": 4,
"maxLength": 6,
"type": [
"string",
"null"
]
},
"importo_contributo_cassa": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"imponibile_cassa": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"aliquota_iva": {
"minLength": 4,
"maxLength": 6,
"pattern": "^(\\d+\\.\\d+)$",
"type": [
"string",
"null"
]
},
"ritenuta": {
"enum": [
"SI"
],
"type": [
"string",
"null"
]
},
"natura": {
"enum": [
"N1",
"N2",
"N2.1",
"N2.2",
"N3",
"N3.1",
"N3.2",
"N3.3",
"N3.4",
"N3.5",
"N3.6",
"N4",
"N5",
"N6",
"N6.1",
"N6.2",
"N6.3",
"N6.4",
"N6.5",
"N6.6",
"N6.7",
"N6.8",
"N6.9",
"N7"
],
"description": "Can be one of\n N1 escluse ex art . 15\n N2 non soggette\n N2 .1 non soggette ad IVA ai sensi degli artt . da 7 a 7 -septies del DPR 633 /72\n N2 .2 non soggette - altri casi\n N3 non imponibili\n N3 .1 non imponibili - esportazioni\n N3 .2 non imponibili - cessioni intracomunitarie\n N3 .3 non imponibili - cessioni verso San Marino\n N3 .4 non imponibili - operazioni assimilate alle cessioni all 'esportazione\n N3 .5 non imponibili - a seguito di dichiarazioni d 'intento\n N3 .6 non imponibili - altre operazioni che non concorrono alla formazione del plafond\n N4 esenti\n N5 regime del margine / IVA non esposta in fattura\n N6 inversione contabile ( per le operazioni in reverse charge ovvero nei casi di autofatturazione per acquisti extra UE di servizi ovvero per importazioni di beni nei soli casi previsti )\n N6 .1 inversione contabile - cessione di rottami e altri materiali di recupero\n N6 .2 inversione contabile - cessione di oro e argento puro\n N6 .3 inversione contabile - subappalto nel settore edile\n N6 .4 inversione contabile - cessione di fabbricati\n N6 .5 inversione contabile - cessione di telefoni cellulari\n N6 .6 inversione contabile - cessione di prodotti elettronici\n N6 .7 inversione contabile - prestazioni comparto edile e settori connessi\n N6 .8 inversione contabile - operazioni settore energetico\n N6 .9 inversione contabile - altri casi\n N7 IVA assolta in altro stato UE ( vendite a distanza ex art . 40 c . 3 e 4 e art . 41 c . 1 lett . b , DL 331 /93; prestazione di servizi di telecomunicazioni , tele-radiodiffusione ed elettronici ex art . 7 -sexies lett . f , g , art . 74 -sexies DPR 633 /72)",
"type": [
"string",
"null"
]
},
"riferimento_amministrazione": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.DatiCassaPrevidenziale.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"tipo_cassa": {
"enum": [
"TC01",
"TC02",
"TC03",
"TC04",
"TC05",
"TC06",
"TC07",
"TC08",
"TC09",
"TC10",
"TC11",
"TC12",
"TC13",
"TC14",
"TC15",
"TC16",
"TC17",
"TC18",
"TC19",
"TC20",
"TC21",
"TC22"
],
"description": "Can be one of\n TC01 Cassa nazionale previdenza e assistenza avvocati e procuratori legali\n TC02 Cassa previdenza dottori commercialisti\n TC03 Cassa previdenza e assistenza geometri\n TC04 Cassa nazionale previdenza e assistenza ingegneri e architetti liberi professionisti\n TC05 Cassa nazionale del notariato\n TC06 Cassa nazionale previdenza e assistenza ragionieri e periti commerciali\n TC07 Ente nazionale assistenza agenti e rappresentanti di commercio ( ENASARCO )\n TC08 Ente nazionale previdenza e assistenza consulenti del lavoro ( ENPACL )\n TC09 Ente nazionale previdenza e assistenza medici ( ENPAM )\n TC10 Ente nazionale previdenza e assistenza farmacisti ( ENPAF )\n TC11 Ente nazionale previdenza e assistenza veterinari ( ENPAV )\n TC12 Ente nazionale previdenza e assistenza impiegati dell 'agricoltura ( ENPAIA )\n TC13 Fondo previdenza impiegati imprese di spedizione e agenzie marittime\n TC14 Istituto nazionale previdenza giornalisti italiani ( INPGI )\n TC15 Opera nazionale assistenza orfani sanitari italiani ( ONAOSI )\n TC16 Cassa autonoma assistenza integrativa giornalisti italiani ( CASAGIT )\n TC17 Ente previdenza periti industriali e periti industriali laureati ( EPPI )\n TC18 Ente previdenza e assistenza pluricategoriale ( EPAP )\n TC19 Ente nazionale previdenza e assistenza biologi ( ENPAB )\n TC20 Ente nazionale previdenza e assistenza professione infermieristica ( ENPAPI )\n TC21 Ente nazionale previdenza e assistenza psicologi ( ENPAP )\n TC22 INPS",
"type": [
"string",
"null"
]
},
"al_cassa": {
"minLength": 4,
"maxLength": 6,
"type": [
"string",
"null"
]
},
"importo_contributo_cassa": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"imponibile_cassa": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"aliquota_iva": {
"minLength": 4,
"maxLength": 6,
"pattern": "^(\\d+\\.\\d+)$",
"type": [
"string",
"null"
]
},
"ritenuta": {
"enum": [
"SI"
],
"type": [
"string",
"null"
]
},
"natura": {
"enum": [
"N1",
"N2",
"N2.1",
"N2.2",
"N3",
"N3.1",
"N3.2",
"N3.3",
"N3.4",
"N3.5",
"N3.6",
"N4",
"N5",
"N6",
"N6.1",
"N6.2",
"N6.3",
"N6.4",
"N6.5",
"N6.6",
"N6.7",
"N6.8",
"N6.9",
"N7"
],
"description": "Can be one of\n N1 escluse ex art . 15\n N2 non soggette\n N2 .1 non soggette ad IVA ai sensi degli artt . da 7 a 7 -septies del DPR 633 /72\n N2 .2 non soggette - altri casi\n N3 non imponibili\n N3 .1 non imponibili - esportazioni\n N3 .2 non imponibili - cessioni intracomunitarie\n N3 .3 non imponibili - cessioni verso San Marino\n N3 .4 non imponibili - operazioni assimilate alle cessioni all 'esportazione\n N3 .5 non imponibili - a seguito di dichiarazioni d 'intento\n N3 .6 non imponibili - altre operazioni che non concorrono alla formazione del plafond\n N4 esenti\n N5 regime del margine / IVA non esposta in fattura\n N6 inversione contabile ( per le operazioni in reverse charge ovvero nei casi di autofatturazione per acquisti extra UE di servizi ovvero per importazioni di beni nei soli casi previsti )\n N6 .1 inversione contabile - cessione di rottami e altri materiali di recupero\n N6 .2 inversione contabile - cessione di oro e argento puro\n N6 .3 inversione contabile - subappalto nel settore edile\n N6 .4 inversione contabile - cessione di fabbricati\n N6 .5 inversione contabile - cessione di telefoni cellulari\n N6 .6 inversione contabile - cessione di prodotti elettronici\n N6 .7 inversione contabile - prestazioni comparto edile e settori connessi\n N6 .8 inversione contabile - operazioni settore energetico\n N6 .9 inversione contabile - altri casi\n N7 IVA assolta in altro stato UE ( vendite a distanza ex art . 40 c . 3 e 4 e art . 41 c . 1 lett . b , DL 331 /93; prestazione di servizi di telecomunicazioni , tele-radiodiffusione ed elettronici ex art . 7 -sexies lett . f , g , art . 74 -sexies DPR 633 /72)",
"type": [
"string",
"null"
]
},
"riferimento_amministrazione": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.DatiDDT-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"numero_ddt": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
},
"data_ddt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"riferimento_numero_linea": {
"type": [
"array",
"null"
],
"items": {
"type": "integer"
}
}
}
},
"FatturaPADraft.DatiDDT.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"numero_ddt": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
},
"data_ddt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"riferimento_numero_linea": {
"type": [
"array",
"null"
],
"items": {
"type": "integer"
}
}
}
},
"FatturaPADraft.DatiDocumentiCorrelati-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"riferimento_numero_linea": {
"allOf": [
{
"type": [
"array",
"null"
],
"items": {
"type": "integer"
}
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"id_documento": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
},
"data": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"num_item": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
},
"codice_commessa_convenzione": {
"minLength": 1,
"maxLength": 100,
"type": [
"string",
"null"
]
},
"codice_cup": {
"minLength": 1,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"codice_cig": {
"minLength": 1,
"maxLength": 15,
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.DatiDocumentiCorrelati.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"riferimento_numero_linea": {
"allOf": [
{
"type": [
"array",
"null"
],
"items": {
"type": "integer"
}
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"id_documento": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
},
"data": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"num_item": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
},
"codice_commessa_convenzione": {
"minLength": 1,
"maxLength": 100,
"type": [
"string",
"null"
]
},
"codice_cup": {
"minLength": 1,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"codice_cig": {
"minLength": 1,
"maxLength": 15,
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.DatiGenerali-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"dati_generali_documento": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.DatiGeneraliDocumento-write"
},
{
"type": "null"
}
]
},
"dati_ordine_acquisto": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DatiDocumentiCorrelati-write"
}
},
"dati_contratto": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DatiDocumentiCorrelati-write"
}
},
"dati_convenzione": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DatiDocumentiCorrelati-write"
}
},
"dati_ricezione": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DatiDocumentiCorrelati-write"
}
},
"dati_fatture_collegate": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DatiDocumentiCorrelati-write"
}
},
"dati_sal": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DatiSAL-write"
}
},
"dati_ddt": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DatiDDT-write"
}
},
"dati_trasporto": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.DatiTrasporto-write"
},
{
"type": "null"
}
]
},
"fattura_principale": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.FatturaPrincipale-write"
},
{
"type": "null"
}
]
}
}
},
"FatturaPADraft.DatiGenerali.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"dati_generali_documento": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.DatiGeneraliDocumento.jsonld-write"
},
{
"type": "null"
}
]
},
"dati_ordine_acquisto": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DatiDocumentiCorrelati.jsonld-write"
}
},
"dati_contratto": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DatiDocumentiCorrelati.jsonld-write"
}
},
"dati_convenzione": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DatiDocumentiCorrelati.jsonld-write"
}
},
"dati_ricezione": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DatiDocumentiCorrelati.jsonld-write"
}
},
"dati_fatture_collegate": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DatiDocumentiCorrelati.jsonld-write"
}
},
"dati_sal": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DatiSAL.jsonld-write"
}
},
"dati_ddt": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DatiDDT.jsonld-write"
}
},
"dati_trasporto": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.DatiTrasporto.jsonld-write"
},
{
"type": "null"
}
]
},
"fattura_principale": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.FatturaPrincipale.jsonld-write"
},
{
"type": "null"
}
]
}
}
},
"FatturaPADraft.DatiGeneraliDocumento-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"tipo_documento": {
"enum": [
"TD01",
"TD02",
"TD03",
"TD04",
"TD05",
"TD06",
"TD16",
"TD17",
"TD18",
"TD19",
"TD20",
"TD21",
"TD22",
"TD23",
"TD24",
"TD25",
"TD26",
"TD27",
"TD28",
"TD29"
],
"description": "Can be one of\n TD01 fattura\n TD02 acconto /anticipo su fattura\n TD03 acconto /anticipo su parcella\n TD04 nota di credito\n TD05 nota di debito\n TD06 parcella\n TD16 integrazione fattura reverse charge interno\n TD17 integrazione /autofattura per acquisto servizi dall 'estero\n TD18 integrazione per acquisto di beni intracomunitari\n TD19 integrazione /autofattura per acquisto di beni ex art .17 c .2 DPR 633 /72\n TD20 autofattura per regolarizzazione e integrazione delle fatture (ex art. 6 c.9-bis d.lgs. 471/97 o art.46 c.5 D.L. 331/93)\n TD21 autofattura per splafonamento\n TD22 estrazione beni da Deposito IVA\n TD23 estrazione beni da Deposito IVA con versamento dell 'IVA\n TD24 fattura differita di cui all 'art. 21 , comma 4 , lett . a )\n TD25 fattura differita di cui all 'art. 21 , comma 4 , terzo periodo lett . b )\n TD26 cessione di beni ammortizzabili e per passaggi interni ( ex art .36 DPR 633 /72)\n TD27 fattura per autoconsumo o per cessioni gratuite senza rivalsa\n TD28 acquisti da San Marino con IVA ( fattura cartacea )\n TD29 comunicazione per omessa o irregolare fatturazione (art. 6, comma 8, D.Lgs. 471/97)",
"type": [
"string",
"null"
]
},
"divisa": {
"externalDocs": {
"url": "https://schema.org/priceCurrency"
},
"type": [
"string",
"null"
]
},
"data": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"numero": {
"minLength": 1,
"maxLength": 20,
"allOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"dati_ritenuta": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DatiRitenuta-write"
}
},
"dati_bollo": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.DatiBollo-write"
},
{
"type": "null"
}
]
},
"dati_cassa_previdenziale": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DatiCassaPrevidenziale-write"
}
},
"sconto_maggiorazione": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.ScontoMaggiorazione-write"
}
},
"importo_totale_documento": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"arrotondamento": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"causale": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"art73": {
"minLength": 2,
"maxLength": 2,
"enum": [
"SI"
],
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.DatiGeneraliDocumento.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"tipo_documento": {
"enum": [
"TD01",
"TD02",
"TD03",
"TD04",
"TD05",
"TD06",
"TD16",
"TD17",
"TD18",
"TD19",
"TD20",
"TD21",
"TD22",
"TD23",
"TD24",
"TD25",
"TD26",
"TD27",
"TD28",
"TD29"
],
"description": "Can be one of\n TD01 fattura\n TD02 acconto /anticipo su fattura\n TD03 acconto /anticipo su parcella\n TD04 nota di credito\n TD05 nota di debito\n TD06 parcella\n TD16 integrazione fattura reverse charge interno\n TD17 integrazione /autofattura per acquisto servizi dall 'estero\n TD18 integrazione per acquisto di beni intracomunitari\n TD19 integrazione /autofattura per acquisto di beni ex art .17 c .2 DPR 633 /72\n TD20 autofattura per regolarizzazione e integrazione delle fatture (ex art. 6 c.9-bis d.lgs. 471/97 o art.46 c.5 D.L. 331/93)\n TD21 autofattura per splafonamento\n TD22 estrazione beni da Deposito IVA\n TD23 estrazione beni da Deposito IVA con versamento dell 'IVA\n TD24 fattura differita di cui all 'art. 21 , comma 4 , lett . a )\n TD25 fattura differita di cui all 'art. 21 , comma 4 , terzo periodo lett . b )\n TD26 cessione di beni ammortizzabili e per passaggi interni ( ex art .36 DPR 633 /72)\n TD27 fattura per autoconsumo o per cessioni gratuite senza rivalsa\n TD28 acquisti da San Marino con IVA ( fattura cartacea )\n TD29 comunicazione per omessa o irregolare fatturazione (art. 6, comma 8, D.Lgs. 471/97)",
"type": [
"string",
"null"
]
},
"divisa": {
"externalDocs": {
"url": "https://schema.org/priceCurrency"
},
"type": [
"string",
"null"
]
},
"data": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"numero": {
"minLength": 1,
"maxLength": 20,
"allOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"dati_ritenuta": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DatiRitenuta.jsonld-write"
}
},
"dati_bollo": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.DatiBollo.jsonld-write"
},
{
"type": "null"
}
]
},
"dati_cassa_previdenziale": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DatiCassaPrevidenziale.jsonld-write"
}
},
"sconto_maggiorazione": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.ScontoMaggiorazione.jsonld-write"
}
},
"importo_totale_documento": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"arrotondamento": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"causale": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"art73": {
"minLength": 2,
"maxLength": 2,
"enum": [
"SI"
],
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.DatiPagamento-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"condizioni_pagamento": {
"enum": [
"TP01",
"TP02",
"TP03"
],
"type": [
"string",
"null"
]
},
"dettaglio_pagamento": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DettaglioPagamento-write"
}
}
}
},
"FatturaPADraft.DatiPagamento.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"condizioni_pagamento": {
"enum": [
"TP01",
"TP02",
"TP03"
],
"type": [
"string",
"null"
]
},
"dettaglio_pagamento": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DettaglioPagamento.jsonld-write"
}
}
}
},
"FatturaPADraft.DatiRiepilogo-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"aliquota_iva": {
"minLength": 4,
"maxLength": 6,
"pattern": "^(\\d+\\.\\d+)$",
"type": [
"string",
"null"
]
},
"natura": {
"enum": [
"N1",
"N2",
"N2.1",
"N2.2",
"N3",
"N3.1",
"N3.2",
"N3.3",
"N3.4",
"N3.5",
"N3.6",
"N4",
"N5",
"N6",
"N6.1",
"N6.2",
"N6.3",
"N6.4",
"N6.5",
"N6.6",
"N6.7",
"N6.8",
"N6.9",
"N7"
],
"description": "Can be one of\n N1 escluse ex art . 15\n N2 non soggette\n N2 .1 non soggette ad IVA ai sensi degli artt . da 7 a 7 -septies del DPR 633 /72\n N2 .2 non soggette - altri casi\n N3 non imponibili\n N3 .1 non imponibili - esportazioni\n N3 .2 non imponibili - cessioni intracomunitarie\n N3 .3 non imponibili - cessioni verso San Marino\n N3 .4 non imponibili - operazioni assimilate alle cessioni all 'esportazione\n N3 .5 non imponibili - a seguito di dichiarazioni d 'intento\n N3 .6 non imponibili - altre operazioni che non concorrono alla formazione del plafond\n N4 esenti\n N5 regime del margine / IVA non esposta in fattura\n N6 inversione contabile ( per le operazioni in reverse charge ovvero nei casi di autofatturazione per acquisti extra UE di servizi ovvero per importazioni di beni nei soli casi previsti )\n N6 .1 inversione contabile - cessione di rottami e altri materiali di recupero\n N6 .2 inversione contabile - cessione di oro e argento puro\n N6 .3 inversione contabile - subappalto nel settore edile\n N6 .4 inversione contabile - cessione di fabbricati\n N6 .5 inversione contabile - cessione di telefoni cellulari\n N6 .6 inversione contabile - cessione di prodotti elettronici\n N6 .7 inversione contabile - prestazioni comparto edile e settori connessi\n N6 .8 inversione contabile - operazioni settore energetico\n N6 .9 inversione contabile - altri casi\n N7 IVA assolta in altro stato UE ( vendite a distanza ex art . 40 c . 3 e 4 e art . 41 c . 1 lett . b , DL 331 /93; prestazione di servizi di telecomunicazioni , tele-radiodiffusione ed elettronici ex art . 7 -sexies lett . f , g , art . 74 -sexies DPR 633 /72)",
"type": [
"string",
"null"
]
},
"spese_accessorie": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"arrotondamento": {
"minLength": 4,
"maxLength": 21,
"type": [
"string",
"null"
]
},
"imponibile_importo": {
"allOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"number",
"null"
]
}
]
},
"imposta": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"esigibilita_iva": {
"enum": [
"I",
"D",
"S"
],
"description": "Codes that can be used :\n I IVA ad esigibilit\u00e0 immediata\n D IVA ad esigibilit\u00e0 differita\n S scissione dei pagamenti",
"type": [
"string",
"null"
]
},
"riferimento_normativo": {
"minLength": 1,
"maxLength": 100,
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.DatiRiepilogo.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"aliquota_iva": {
"minLength": 4,
"maxLength": 6,
"pattern": "^(\\d+\\.\\d+)$",
"type": [
"string",
"null"
]
},
"natura": {
"enum": [
"N1",
"N2",
"N2.1",
"N2.2",
"N3",
"N3.1",
"N3.2",
"N3.3",
"N3.4",
"N3.5",
"N3.6",
"N4",
"N5",
"N6",
"N6.1",
"N6.2",
"N6.3",
"N6.4",
"N6.5",
"N6.6",
"N6.7",
"N6.8",
"N6.9",
"N7"
],
"description": "Can be one of\n N1 escluse ex art . 15\n N2 non soggette\n N2 .1 non soggette ad IVA ai sensi degli artt . da 7 a 7 -septies del DPR 633 /72\n N2 .2 non soggette - altri casi\n N3 non imponibili\n N3 .1 non imponibili - esportazioni\n N3 .2 non imponibili - cessioni intracomunitarie\n N3 .3 non imponibili - cessioni verso San Marino\n N3 .4 non imponibili - operazioni assimilate alle cessioni all 'esportazione\n N3 .5 non imponibili - a seguito di dichiarazioni d 'intento\n N3 .6 non imponibili - altre operazioni che non concorrono alla formazione del plafond\n N4 esenti\n N5 regime del margine / IVA non esposta in fattura\n N6 inversione contabile ( per le operazioni in reverse charge ovvero nei casi di autofatturazione per acquisti extra UE di servizi ovvero per importazioni di beni nei soli casi previsti )\n N6 .1 inversione contabile - cessione di rottami e altri materiali di recupero\n N6 .2 inversione contabile - cessione di oro e argento puro\n N6 .3 inversione contabile - subappalto nel settore edile\n N6 .4 inversione contabile - cessione di fabbricati\n N6 .5 inversione contabile - cessione di telefoni cellulari\n N6 .6 inversione contabile - cessione di prodotti elettronici\n N6 .7 inversione contabile - prestazioni comparto edile e settori connessi\n N6 .8 inversione contabile - operazioni settore energetico\n N6 .9 inversione contabile - altri casi\n N7 IVA assolta in altro stato UE ( vendite a distanza ex art . 40 c . 3 e 4 e art . 41 c . 1 lett . b , DL 331 /93; prestazione di servizi di telecomunicazioni , tele-radiodiffusione ed elettronici ex art . 7 -sexies lett . f , g , art . 74 -sexies DPR 633 /72)",
"type": [
"string",
"null"
]
},
"spese_accessorie": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"arrotondamento": {
"minLength": 4,
"maxLength": 21,
"type": [
"string",
"null"
]
},
"imponibile_importo": {
"allOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"number",
"null"
]
}
]
},
"imposta": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"esigibilita_iva": {
"enum": [
"I",
"D",
"S"
],
"description": "Codes that can be used :\n I IVA ad esigibilit\u00e0 immediata\n D IVA ad esigibilit\u00e0 differita\n S scissione dei pagamenti",
"type": [
"string",
"null"
]
},
"riferimento_normativo": {
"minLength": 1,
"maxLength": 100,
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.DatiRitenuta-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"tipo_ritenuta": {
"enum": [
"RT01",
"RT02",
"RT03",
"RT04",
"RT05",
"RT06"
],
"description": "Can be one of\n RT01 ritenuta persone fisiche\n RT02 ritenuta persone giuridiche\n RT03 contributo INPS\n RT04 contributo ENASARCO\n RT05 contributo ENPAM\n RT06 altro contributo previdenziale",
"type": [
"string",
"null"
]
},
"importo_ritenuta": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"aliquota_ritenuta": {
"minLength": 4,
"maxLength": 6,
"type": [
"string",
"null"
]
},
"causale_pagamento": {
"minLength": 1,
"maxLength": 2,
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.DatiRitenuta.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"tipo_ritenuta": {
"enum": [
"RT01",
"RT02",
"RT03",
"RT04",
"RT05",
"RT06"
],
"description": "Can be one of\n RT01 ritenuta persone fisiche\n RT02 ritenuta persone giuridiche\n RT03 contributo INPS\n RT04 contributo ENASARCO\n RT05 contributo ENPAM\n RT06 altro contributo previdenziale",
"type": [
"string",
"null"
]
},
"importo_ritenuta": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"aliquota_ritenuta": {
"minLength": 4,
"maxLength": 6,
"type": [
"string",
"null"
]
},
"causale_pagamento": {
"minLength": 1,
"maxLength": 2,
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.DatiSAL-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"riferimento_fase": {
"minLength": 1,
"maxLength": 3,
"allOf": [
{
"type": [
"integer",
"null"
]
},
{
"type": "string"
}
]
}
}
},
"FatturaPADraft.DatiSAL.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"riferimento_fase": {
"minLength": 1,
"maxLength": 3,
"allOf": [
{
"type": [
"integer",
"null"
]
},
{
"type": "string"
}
]
}
}
},
"FatturaPADraft.DatiTrasmissione-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"codice_destinatario": {
"pattern": "^([A-Za-z0-9]{6,7})$",
"type": [
"string",
"null"
]
},
"pec_destinatario": {
"minLength": 7,
"maxLength": 256,
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.DatiTrasmissione.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"codice_destinatario": {
"pattern": "^([A-Za-z0-9]{6,7})$",
"type": [
"string",
"null"
]
},
"pec_destinatario": {
"minLength": 7,
"maxLength": 256,
"format": "email",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.DatiTrasporto-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"dati_anagrafici_vettore": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.DatiAnagraficiVettore-write"
},
{
"type": "null"
}
]
},
"mezzo_trasporto": {
"minLength": 1,
"maxLength": 80,
"type": [
"string",
"null"
]
},
"causale_trasporto": {
"minLength": 1,
"maxLength": 100,
"type": [
"string",
"null"
]
},
"numero_colli": {
"minLength": 1,
"maxLength": 4,
"allOf": [
{
"type": [
"integer",
"null"
]
},
{
"type": "string"
}
]
},
"descrizione": {
"minLength": 1,
"maxLength": 100,
"type": [
"string",
"null"
]
},
"unita_misura_peso": {
"minLength": 1,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"peso_lordo": {
"minLength": 4,
"maxLength": 7,
"type": [
"string",
"null"
]
},
"peso_netto": {
"minLength": 4,
"maxLength": 7,
"type": [
"string",
"null"
]
},
"data_ora_ritiro": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"data_inizio_trasporto": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"tipo_resa": {
"minLength": 3,
"maxLength": 3,
"type": [
"string",
"null"
]
},
"indirizzo_resa": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.Indirizzo-write"
},
{
"type": "null"
}
]
},
"data_ora_consegna": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
},
"FatturaPADraft.DatiTrasporto.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"dati_anagrafici_vettore": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.DatiAnagraficiVettore.jsonld-write"
},
{
"type": "null"
}
]
},
"mezzo_trasporto": {
"minLength": 1,
"maxLength": 80,
"type": [
"string",
"null"
]
},
"causale_trasporto": {
"minLength": 1,
"maxLength": 100,
"type": [
"string",
"null"
]
},
"numero_colli": {
"minLength": 1,
"maxLength": 4,
"allOf": [
{
"type": [
"integer",
"null"
]
},
{
"type": "string"
}
]
},
"descrizione": {
"minLength": 1,
"maxLength": 100,
"type": [
"string",
"null"
]
},
"unita_misura_peso": {
"minLength": 1,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"peso_lordo": {
"minLength": 4,
"maxLength": 7,
"type": [
"string",
"null"
]
},
"peso_netto": {
"minLength": 4,
"maxLength": 7,
"type": [
"string",
"null"
]
},
"data_ora_ritiro": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"data_inizio_trasporto": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"tipo_resa": {
"minLength": 3,
"maxLength": 3,
"type": [
"string",
"null"
]
},
"indirizzo_resa": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.Indirizzo.jsonld-write"
},
{
"type": "null"
}
]
},
"data_ora_consegna": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
},
"FatturaPADraft.DatiVeicoli-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"data": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"totale_percorso": {
"minLength": 1,
"maxLength": 100,
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.DatiVeicoli.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"data": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"totale_percorso": {
"minLength": 1,
"maxLength": 100,
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.DettaglioLinee-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"numero_linea": {
"minLength": 1,
"maxLength": 4,
"allOf": [
{
"type": [
"integer",
"null"
]
},
{
"type": "string"
}
]
},
"tipo_cessione_prestazione": {
"enum": [
"SC",
"PR",
"AB",
"AC"
],
"type": [
"string",
"null"
]
},
"codice_articolo": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.CodiceArticolo-write"
}
},
"descrizione": {
"minLength": 1,
"maxLength": 1000,
"type": [
"string",
"null"
]
},
"quantita": {
"minLength": 4,
"maxLength": 21,
"type": [
"string",
"null"
]
},
"unita_misura": {
"minLength": 1,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"data_inizio_periodo": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"data_fine_periodo": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"prezzo_unitario": {
"type": [
"string",
"null"
]
},
"sconto_maggiorazione": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.ScontoMaggiorazione-write"
}
},
"prezzo_totale": {
"type": [
"string",
"null"
]
},
"aliquota_iva": {
"pattern": "^(\\d+\\.\\d+)$",
"type": [
"string",
"null"
]
},
"ritenuta": {
"enum": [
"SI"
],
"type": [
"string",
"null"
]
},
"natura": {
"enum": [
"N1",
"N2",
"N2.1",
"N2.2",
"N3",
"N3.1",
"N3.2",
"N3.3",
"N3.4",
"N3.5",
"N3.6",
"N4",
"N5",
"N6",
"N6.1",
"N6.2",
"N6.3",
"N6.4",
"N6.5",
"N6.6",
"N6.7",
"N6.8",
"N6.9",
"N7"
],
"description": "Can be one of\n N1 escluse ex art . 15\n N2 non soggette\n N2 .1 non soggette ad IVA ai sensi degli artt . da 7 a 7 -septies del DPR 633 /72\n N2 .2 non soggette - altri casi\n N3 non imponibili\n N3 .1 non imponibili - esportazioni\n N3 .2 non imponibili - cessioni intracomunitarie\n N3 .3 non imponibili - cessioni verso San Marino\n N3 .4 non imponibili - operazioni assimilate alle cessioni all 'esportazione\n N3 .5 non imponibili - a seguito di dichiarazioni d 'intento\n N3 .6 non imponibili - altre operazioni che non concorrono alla formazione del plafond\n N4 esenti\n N5 regime del margine / IVA non esposta in fattura\n N6 inversione contabile ( per le operazioni in reverse charge ovvero nei casi di autofatturazione per acquisti extra UE di servizi ovvero per importazioni di beni nei soli casi previsti )\n N6 .1 inversione contabile - cessione di rottami e altri materiali di recupero\n N6 .2 inversione contabile - cessione di oro e argento puro\n N6 .3 inversione contabile - subappalto nel settore edile\n N6 .4 inversione contabile - cessione di fabbricati\n N6 .5 inversione contabile - cessione di telefoni cellulari\n N6 .6 inversione contabile - cessione di prodotti elettronici\n N6 .7 inversione contabile - prestazioni comparto edile e settori connessi\n N6 .8 inversione contabile - operazioni settore energetico\n N6 .9 inversione contabile - altri casi\n N7 IVA assolta in altro stato UE ( vendite a distanza ex art . 40 c . 3 e 4 e art . 41 c . 1 lett . b , DL 331 /93; prestazione di servizi di telecomunicazioni , tele-radiodiffusione ed elettronici ex art . 7 -sexies lett . f , g , art . 74 -sexies DPR 633 /72)",
"type": [
"string",
"null"
]
},
"riferimento_amministrazione": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
},
"altri_dati_gestionali": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.AltriDatiGestionali-write"
}
}
}
},
"FatturaPADraft.DettaglioLinee.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"numero_linea": {
"minLength": 1,
"maxLength": 4,
"allOf": [
{
"type": [
"integer",
"null"
]
},
{
"type": "string"
}
]
},
"tipo_cessione_prestazione": {
"enum": [
"SC",
"PR",
"AB",
"AC"
],
"type": [
"string",
"null"
]
},
"codice_articolo": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.CodiceArticolo.jsonld-write"
}
},
"descrizione": {
"minLength": 1,
"maxLength": 1000,
"type": [
"string",
"null"
]
},
"quantita": {
"minLength": 4,
"maxLength": 21,
"type": [
"string",
"null"
]
},
"unita_misura": {
"minLength": 1,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"data_inizio_periodo": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"data_fine_periodo": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"prezzo_unitario": {
"type": [
"string",
"null"
]
},
"sconto_maggiorazione": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.ScontoMaggiorazione.jsonld-write"
}
},
"prezzo_totale": {
"type": [
"string",
"null"
]
},
"aliquota_iva": {
"pattern": "^(\\d+\\.\\d+)$",
"type": [
"string",
"null"
]
},
"ritenuta": {
"enum": [
"SI"
],
"type": [
"string",
"null"
]
},
"natura": {
"enum": [
"N1",
"N2",
"N2.1",
"N2.2",
"N3",
"N3.1",
"N3.2",
"N3.3",
"N3.4",
"N3.5",
"N3.6",
"N4",
"N5",
"N6",
"N6.1",
"N6.2",
"N6.3",
"N6.4",
"N6.5",
"N6.6",
"N6.7",
"N6.8",
"N6.9",
"N7"
],
"description": "Can be one of\n N1 escluse ex art . 15\n N2 non soggette\n N2 .1 non soggette ad IVA ai sensi degli artt . da 7 a 7 -septies del DPR 633 /72\n N2 .2 non soggette - altri casi\n N3 non imponibili\n N3 .1 non imponibili - esportazioni\n N3 .2 non imponibili - cessioni intracomunitarie\n N3 .3 non imponibili - cessioni verso San Marino\n N3 .4 non imponibili - operazioni assimilate alle cessioni all 'esportazione\n N3 .5 non imponibili - a seguito di dichiarazioni d 'intento\n N3 .6 non imponibili - altre operazioni che non concorrono alla formazione del plafond\n N4 esenti\n N5 regime del margine / IVA non esposta in fattura\n N6 inversione contabile ( per le operazioni in reverse charge ovvero nei casi di autofatturazione per acquisti extra UE di servizi ovvero per importazioni di beni nei soli casi previsti )\n N6 .1 inversione contabile - cessione di rottami e altri materiali di recupero\n N6 .2 inversione contabile - cessione di oro e argento puro\n N6 .3 inversione contabile - subappalto nel settore edile\n N6 .4 inversione contabile - cessione di fabbricati\n N6 .5 inversione contabile - cessione di telefoni cellulari\n N6 .6 inversione contabile - cessione di prodotti elettronici\n N6 .7 inversione contabile - prestazioni comparto edile e settori connessi\n N6 .8 inversione contabile - operazioni settore energetico\n N6 .9 inversione contabile - altri casi\n N7 IVA assolta in altro stato UE ( vendite a distanza ex art . 40 c . 3 e 4 e art . 41 c . 1 lett . b , DL 331 /93; prestazione di servizi di telecomunicazioni , tele-radiodiffusione ed elettronici ex art . 7 -sexies lett . f , g , art . 74 -sexies DPR 633 /72)",
"type": [
"string",
"null"
]
},
"riferimento_amministrazione": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
},
"altri_dati_gestionali": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.AltriDatiGestionali.jsonld-write"
}
}
}
},
"FatturaPADraft.DettaglioPagamento-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"beneficiario": {
"minLength": 1,
"maxLength": 200,
"type": [
"string",
"null"
]
},
"modalita_pagamento": {
"enum": [
"MP01",
"MP02",
"MP03",
"MP04",
"MP05",
"MP06",
"MP07",
"MP08",
"MP09",
"MP10",
"MP11",
"MP12",
"MP13",
"MP14",
"MP15",
"MP16",
"MP17",
"MP18",
"MP19",
"MP20",
"MP21",
"MP22",
"MP23"
],
"description": "Can be one of\n MP01 contanti\n MP02 assegno\n MP03 assegno circolare\n MP04 contanti presso Tesoreria\n MP05 bonifico\n MP06 vaglia cambiario\n MP07 bollettino bancario\n MP08 carta di pagamento\n MP09 RID\n MP10 RID utenze\n MP11 RID veloce\n MP12 RIBA\n MP13 MAV\n MP14 quietanza erario\n MP15 giroconto su conti di contabilit\u00e0 speciale\n MP16 domiciliazione bancaria\n MP17 domiciliazione postale\n MP18 bollettino di c /c postale\n MP19 SEPA Direct Debit\n MP20 SEPA Direct Debit CORE\n MP21 SEPA Direct Debit B2B\n MP22 Trattenuta su somme gi\u00e0 riscosse\n MP23 PagoPA",
"type": [
"string",
"null"
]
},
"data_riferimento_termini_pagamento": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"giorni_termini_pagamento": {
"minLength": 1,
"maxLength": 3,
"allOf": [
{
"type": [
"integer",
"null"
]
},
{
"type": "string"
}
]
},
"data_scadenza_pagamento": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"importo_pagamento": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"cod_ufficio_postale": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
},
"cognome_quietanzante": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"nome_quietanzante": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"cf_quietanzante": {
"minLength": 16,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"titolo_quietanzante": {
"minLength": 2,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"istituto_finanziario": {
"minLength": 1,
"maxLength": 80,
"type": [
"string",
"null"
]
},
"iban": {
"minLength": 15,
"maxLength": 34,
"externalDocs": {
"url": "https://schema.org/identifier"
},
"type": [
"string",
"null"
]
},
"abi": {
"minLength": 5,
"maxLength": 5,
"type": [
"string",
"null"
]
},
"cab": {
"minLength": 5,
"maxLength": 5,
"type": [
"string",
"null"
]
},
"bic": {
"minLength": 8,
"maxLength": 11,
"externalDocs": {
"url": "https://schema.org/identifier"
},
"type": [
"string",
"null"
]
},
"sconto_pagamento_anticipato": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"data_limite_pagamento_anticipato": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"penalita_pagamenti_ritardati": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"data_decorrenza_penale": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"codice_pagamento": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.DettaglioPagamento.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"beneficiario": {
"minLength": 1,
"maxLength": 200,
"type": [
"string",
"null"
]
},
"modalita_pagamento": {
"enum": [
"MP01",
"MP02",
"MP03",
"MP04",
"MP05",
"MP06",
"MP07",
"MP08",
"MP09",
"MP10",
"MP11",
"MP12",
"MP13",
"MP14",
"MP15",
"MP16",
"MP17",
"MP18",
"MP19",
"MP20",
"MP21",
"MP22",
"MP23"
],
"description": "Can be one of\n MP01 contanti\n MP02 assegno\n MP03 assegno circolare\n MP04 contanti presso Tesoreria\n MP05 bonifico\n MP06 vaglia cambiario\n MP07 bollettino bancario\n MP08 carta di pagamento\n MP09 RID\n MP10 RID utenze\n MP11 RID veloce\n MP12 RIBA\n MP13 MAV\n MP14 quietanza erario\n MP15 giroconto su conti di contabilit\u00e0 speciale\n MP16 domiciliazione bancaria\n MP17 domiciliazione postale\n MP18 bollettino di c /c postale\n MP19 SEPA Direct Debit\n MP20 SEPA Direct Debit CORE\n MP21 SEPA Direct Debit B2B\n MP22 Trattenuta su somme gi\u00e0 riscosse\n MP23 PagoPA",
"type": [
"string",
"null"
]
},
"data_riferimento_termini_pagamento": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"giorni_termini_pagamento": {
"minLength": 1,
"maxLength": 3,
"allOf": [
{
"type": [
"integer",
"null"
]
},
{
"type": "string"
}
]
},
"data_scadenza_pagamento": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"importo_pagamento": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"cod_ufficio_postale": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
},
"cognome_quietanzante": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"nome_quietanzante": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"cf_quietanzante": {
"minLength": 16,
"maxLength": 16,
"type": [
"string",
"null"
]
},
"titolo_quietanzante": {
"minLength": 2,
"maxLength": 10,
"type": [
"string",
"null"
]
},
"istituto_finanziario": {
"minLength": 1,
"maxLength": 80,
"type": [
"string",
"null"
]
},
"iban": {
"minLength": 15,
"maxLength": 34,
"externalDocs": {
"url": "https://schema.org/identifier"
},
"type": [
"string",
"null"
]
},
"abi": {
"minLength": 5,
"maxLength": 5,
"type": [
"string",
"null"
]
},
"cab": {
"minLength": 5,
"maxLength": 5,
"type": [
"string",
"null"
]
},
"bic": {
"minLength": 8,
"maxLength": 11,
"externalDocs": {
"url": "https://schema.org/identifier"
},
"type": [
"string",
"null"
]
},
"sconto_pagamento_anticipato": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"data_limite_pagamento_anticipato": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"penalita_pagamenti_ritardati": {
"minLength": 4,
"maxLength": 15,
"type": [
"string",
"null"
]
},
"data_decorrenza_penale": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"codice_pagamento": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.FatturaElettronicaBody-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"dati_generali": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.DatiGenerali-write"
},
{
"type": "null"
}
]
},
"dati_beni_servizi": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.DatiBeniServizi-write"
},
{
"type": "null"
}
]
},
"dati_veicoli": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.DatiVeicoli-write"
},
{
"type": "null"
}
]
},
"dati_pagamento": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DatiPagamento-write"
}
},
"allegati": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.Allegati-write"
}
}
}
},
"FatturaPADraft.FatturaElettronicaBody.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"dati_generali": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.DatiGenerali.jsonld-write"
},
{
"type": "null"
}
]
},
"dati_beni_servizi": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.DatiBeniServizi.jsonld-write"
},
{
"type": "null"
}
]
},
"dati_veicoli": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.DatiVeicoli.jsonld-write"
},
{
"type": "null"
}
]
},
"dati_pagamento": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.DatiPagamento.jsonld-write"
}
},
"allegati": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/FatturaPADraft.Allegati.jsonld-write"
}
}
}
},
"FatturaPADraft.FatturaElettronicaHeader-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"dati_trasmissione": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.DatiTrasmissione-write"
},
{
"type": "null"
}
]
},
"cedente_prestatore": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.CedentePrestatore-write"
},
{
"type": "null"
}
]
},
"rappresentante_fiscale": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.RappresentanteFiscale-write"
},
{
"type": "null"
}
]
},
"cessionario_committente": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.CessionarioCommittente-write"
},
{
"type": "null"
}
]
},
"terzo_intermediario_o_soggetto_emittente": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.TerzoIntermediarioSoggettoEmittente-write"
},
{
"type": "null"
}
]
},
"soggetto_emittente": {
"minLength": 2,
"maxLength": 2,
"enum": [
"CC",
"TZ"
],
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.FatturaElettronicaHeader.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"dati_trasmissione": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.DatiTrasmissione.jsonld-write"
},
{
"type": "null"
}
]
},
"cedente_prestatore": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.CedentePrestatore.jsonld-write"
},
{
"type": "null"
}
]
},
"rappresentante_fiscale": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.RappresentanteFiscale.jsonld-write"
},
{
"type": "null"
}
]
},
"cessionario_committente": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.CessionarioCommittente.jsonld-write"
},
{
"type": "null"
}
]
},
"terzo_intermediario_o_soggetto_emittente": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.TerzoIntermediarioSoggettoEmittente.jsonld-write"
},
{
"type": "null"
}
]
},
"soggetto_emittente": {
"minLength": 2,
"maxLength": 2,
"enum": [
"CC",
"TZ"
],
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.FatturaPrincipale-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"numero_fattura_principale": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
},
"data_fattura_principale": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
},
"FatturaPADraft.FatturaPrincipale.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"numero_fattura_principale": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
},
"data_fattura_principale": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
},
"FatturaPADraft.IdFiscale-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_paese": {
"minLength": 2,
"maxLength": 2,
"description": "ISO 3166-1 alpha-2 code",
"type": [
"string",
"null"
]
},
"id_codice": {
"minLength": 1,
"maxLength": 28,
"description": "Tax identification code",
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.IdFiscale.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_paese": {
"minLength": 2,
"maxLength": 2,
"description": "ISO 3166-1 alpha-2 code",
"type": [
"string",
"null"
]
},
"id_codice": {
"minLength": 1,
"maxLength": 28,
"description": "Tax identification code",
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.Indirizzo-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"indirizzo": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"numero_civico": {
"minLength": 1,
"maxLength": 8,
"type": [
"string",
"null"
]
},
"cap": {
"minLength": 5,
"maxLength": 5,
"type": [
"string",
"null"
]
},
"comune": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"provincia": {
"minLength": 2,
"maxLength": 2,
"type": [
"string",
"null"
]
},
"nazione": {
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.Indirizzo.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"indirizzo": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"numero_civico": {
"minLength": 1,
"maxLength": 8,
"type": [
"string",
"null"
]
},
"cap": {
"minLength": 5,
"maxLength": 5,
"type": [
"string",
"null"
]
},
"comune": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"provincia": {
"minLength": 2,
"maxLength": 2,
"type": [
"string",
"null"
]
},
"nazione": {
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.IscrizioneREA-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"ufficio": {
"minLength": 2,
"maxLength": 2,
"type": [
"string",
"null"
]
},
"numero_rea": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
},
"capitale_sociale": {
"minLength": 4,
"maxLength": 15,
"allOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"socio_unico": {
"enum": [
"SU",
"SM"
],
"type": [
"string",
"null"
]
},
"stato_liquidazione": {
"enum": [
"LS",
"LN"
],
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.IscrizioneREA.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"ufficio": {
"minLength": 2,
"maxLength": 2,
"type": [
"string",
"null"
]
},
"numero_rea": {
"minLength": 1,
"maxLength": 20,
"type": [
"string",
"null"
]
},
"capitale_sociale": {
"minLength": 4,
"maxLength": 15,
"allOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"socio_unico": {
"enum": [
"SU",
"SM"
],
"type": [
"string",
"null"
]
},
"stato_liquidazione": {
"enum": [
"LS",
"LN"
],
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.RappresentanteFiscale-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"dati_anagrafici": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.DatiAnagraficiRappresentanteFiscale-write"
},
{
"type": "null"
}
]
}
}
},
"FatturaPADraft.RappresentanteFiscale.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"dati_anagrafici": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.DatiAnagraficiRappresentanteFiscale.jsonld-write"
},
{
"type": "null"
}
]
}
}
},
"FatturaPADraft.RappresentanteFiscaleCessionarioCommittente-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_fiscale_iva": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.IdFiscale-write"
},
{
"type": "null"
}
]
},
"denominazione": {
"minLength": 1,
"maxLength": 80,
"type": [
"string",
"null"
]
},
"nome": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"cognome": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.RappresentanteFiscaleCessionarioCommittente.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_fiscale_iva": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.IdFiscale.jsonld-write"
},
{
"type": "null"
}
]
},
"denominazione": {
"minLength": 1,
"maxLength": 80,
"type": [
"string",
"null"
]
},
"nome": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"cognome": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.ScontoMaggiorazione-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"tipo": {
"enum": [
"SC",
"MG"
],
"type": [
"string",
"null"
]
},
"percentuale": {
"minLength": 4,
"maxLength": 6,
"type": [
"string",
"null"
]
},
"importo": {
"minLength": 4,
"maxLength": 21,
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.ScontoMaggiorazione.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"tipo": {
"enum": [
"SC",
"MG"
],
"type": [
"string",
"null"
]
},
"percentuale": {
"minLength": 4,
"maxLength": 6,
"type": [
"string",
"null"
]
},
"importo": {
"minLength": 4,
"maxLength": 21,
"type": [
"string",
"null"
]
}
}
},
"FatturaPADraft.TerzoIntermediarioSoggettoEmittente-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"dati_anagrafici": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.DatiAnagraficiTerzoIntermediario-write"
},
{
"type": "null"
}
]
}
}
},
"FatturaPADraft.TerzoIntermediarioSoggettoEmittente.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"dati_anagrafici": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.DatiAnagraficiTerzoIntermediario.jsonld-write"
},
{
"type": "null"
}
]
}
}
},
"FatturaPrincipale-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"numero_fattura_principale"
],
"properties": {
"numero_fattura_principale": {
"minLength": 1,
"maxLength": 20,
"type": "string"
},
"data_fattura_principale": {
"type": "string",
"format": "date-time"
}
}
},
"FiscalIdValidity": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id": {
"description": "The fiscal id",
"type": "string",
"example": "BNCMRA70A20H501B"
},
"valid": {
"type": "boolean",
"example": true
}
}
},
"FiscalIdValidity.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"id": {
"description": "The fiscal id",
"type": "string",
"example": "BNCMRA70A20H501B"
},
"valid": {
"type": "boolean",
"example": true
}
}
},
"Gps-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"coordinates": {
"type": [
"array",
"null"
],
"items": {
"type": "number"
},
"example": [
45.464211,
9.191383
]
}
}
},
"Gps.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"coordinates": {
"type": [
"array",
"null"
],
"items": {
"type": "number"
},
"example": [
45.464211,
9.191383
]
}
}
},
"IdFiscale-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"id_paese",
"id_codice"
],
"properties": {
"id_paese": {
"minLength": 2,
"maxLength": 2,
"description": "ISO 3166-1 alpha-2 code",
"type": [
"string",
"null"
]
},
"id_codice": {
"minLength": 1,
"maxLength": 28,
"description": "Tax identification code",
"type": [
"string",
"null"
]
}
}
},
"IdentificativiFiscali-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_fiscale_iva": {
"anyOf": [
{
"$ref": "#/components/schemas/IdFiscale-write"
},
{
"type": "null"
}
]
},
"codice_fiscale": {
"type": [
"string",
"null"
]
}
}
},
"Indirizzo-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"indirizzo",
"cap",
"comune",
"nazione"
],
"properties": {
"indirizzo": {
"minLength": 1,
"maxLength": 60,
"type": "string"
},
"numero_civico": {
"minLength": 1,
"maxLength": 8,
"type": [
"string",
"null"
]
},
"cap": {
"minLength": 5,
"maxLength": 5,
"type": "string"
},
"comune": {
"minLength": 1,
"maxLength": 60,
"type": "string"
},
"provincia": {
"minLength": 2,
"maxLength": 2,
"type": [
"string",
"null"
]
},
"nazione": {
"type": "string"
}
}
},
"Invoice-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"uuid": {
"readOnly": true,
"allOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "string"
}
]
},
"type": {
"type": "integer"
},
"payload": {
"type": [
"string",
"null"
]
},
"sender": {
"$ref": "#/components/schemas/BusinessRegistry-read"
},
"recipient": {
"$ref": "#/components/schemas/BusinessRegistry-read"
},
"notifications": {
"type": "array",
"items": {
"type": "string"
}
},
"sdi_file_name": {
"readOnly": true,
"type": "string"
},
"sdi_file_id": {
"readOnly": true,
"type": "string"
},
"signed": {
"type": "boolean"
},
"legally_stored": {
"readOnly": true,
"type": "boolean"
},
"preserved_document": {
"anyOf": [
{
"$ref": "#/components/schemas/PreservedDocument-read"
},
{
"type": "null"
}
]
},
"downloaded": {
"description": "The invoice was downloaded (automatically when received by webhook or manually for polling integrations).",
"type": "boolean"
},
"downloaded_at": {
"readOnly": true,
"type": [
"string",
"null"
],
"format": "date-time"
},
"marking": {
"description": "The marking represent the current status of the invoice.",
"type": [
"string",
"null"
]
},
"notice": {
"type": [
"string",
"null"
]
},
"retry_information": {
"readOnly": true,
"type": "array",
"items": {
"type": "string"
}
},
"transmission_format": {
"description": "Transmission format specified into the invoice.",
"default": "FPR12",
"example": "FPR12",
"type": "string"
},
"document_type": {
"type": [
"string",
"null"
]
},
"to_pa": {
"readOnly": true,
"type": "boolean"
}
}
},
"Invoice.DownloadedEntity-write": {
"type": "object",
"description": "Setup the downloaded flag for a collection of invoices.
Note: the downloaded flag is automatically set when an invoice is successfully received with the webhook",
"deprecated": false,
"properties": {
"uuids": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
},
"downloaded": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
}
]
}
},
"required": [
"downloaded"
]
},
"Invoice.DownloadedEntity.jsonld-write": {
"type": "object",
"description": "Setup the downloaded flag for a collection of invoices.
Note: the downloaded flag is automatically set when an invoice is successfully received with the webhook",
"deprecated": false,
"properties": {
"uuids": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
},
"downloaded": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
}
]
}
},
"required": [
"downloaded"
]
},
"Invoice.InvoiceDraftInput-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"fattura_elettronica_header": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.FatturaElettronicaHeader-write"
},
{
"type": "null"
}
]
},
"fattura_elettronica_body": {
"minItems": 0,
"maxItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/FatturaPADraft.FatturaElettronicaBody-write"
}
}
}
},
"Invoice.InvoiceDraftInput.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"fattura_elettronica_header": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaPADraft.FatturaElettronicaHeader.jsonld-write"
},
{
"type": "null"
}
]
},
"fattura_elettronica_body": {
"minItems": 0,
"maxItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/FatturaPADraft.FatturaElettronicaBody.jsonld-write"
}
}
}
},
"Invoice.InvoiceInput-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"fattura_elettronica_header",
"fattura_elettronica_body"
],
"properties": {
"fattura_elettronica_header": {
"$ref": "#/components/schemas/FatturaPA.FatturaElettronicaHeader-write"
},
"fattura_elettronica_body": {
"minItems": 1,
"maxItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/FatturaPA.FatturaElettronicaBody-write"
}
}
}
},
"Invoice.InvoiceOutput-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"uuid": {
"type": "string"
}
}
},
"Invoice.InvoiceOutput.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"uuid": {
"type": "string"
}
}
},
"Invoice.InvoiceReport-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"type": {
"type": "string"
},
"sender_name": {
"type": [
"string",
"null"
]
},
"sender_fiscal_id": {
"type": [
"string",
"null"
]
},
"recipient_name": {
"type": [
"string",
"null"
]
},
"recipient_fiscal_id": {
"type": [
"string",
"null"
]
},
"invoice_number": {
"type": "string"
},
"invoice_date": {
"type": "string"
},
"filename": {
"type": "string"
},
"document_type": {
"type": "string"
},
"signed": {
"type": [
"string",
"null"
]
},
"downloaded": {
"type": [
"string",
"null"
]
},
"marking": {
"type": [
"string",
"null"
]
},
"to_pa": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string"
},
"total_amount": {
"type": [
"string",
"null"
]
},
"vat_amount": {
"type": [
"string",
"null"
]
},
"notice": {
"type": [
"string",
"null"
]
},
"stamp": {
"type": [
"string",
"null"
]
},
"payment_due_date": {
"type": [
"string",
"null"
]
}
}
},
"Invoice.PreserveInvoiceOutput-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"uuid": {
"type": "string"
}
}
},
"Invoice.PreserveInvoiceOutput.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"uuid": {
"type": "string"
}
}
},
"Invoice.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"uuid": {
"readOnly": true,
"allOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "string"
}
]
},
"type": {
"type": "integer"
},
"payload": {
"type": [
"string",
"null"
]
},
"sender": {
"$ref": "#/components/schemas/BusinessRegistry.jsonld-read"
},
"recipient": {
"$ref": "#/components/schemas/BusinessRegistry.jsonld-read"
},
"notifications": {
"type": "array",
"items": {
"type": "string"
}
},
"sdi_file_name": {
"readOnly": true,
"type": "string"
},
"sdi_file_id": {
"readOnly": true,
"type": "string"
},
"signed": {
"type": "boolean"
},
"legally_stored": {
"readOnly": true,
"type": "boolean"
},
"preserved_document": {
"anyOf": [
{
"$ref": "#/components/schemas/PreservedDocument.jsonld-read"
},
{
"type": "null"
}
]
},
"downloaded": {
"description": "The invoice was downloaded (automatically when received by webhook or manually for polling integrations).",
"type": "boolean"
},
"downloaded_at": {
"readOnly": true,
"type": [
"string",
"null"
],
"format": "date-time"
},
"marking": {
"description": "The marking represent the current status of the invoice.",
"type": [
"string",
"null"
]
},
"notice": {
"type": [
"string",
"null"
]
},
"retry_information": {
"readOnly": true,
"type": "array",
"items": {
"type": "string"
}
},
"transmission_format": {
"description": "Transmission format specified into the invoice.",
"default": "FPR12",
"example": "FPR12",
"type": "string"
},
"document_type": {
"type": [
"string",
"null"
]
},
"to_pa": {
"readOnly": true,
"type": "boolean"
}
}
},
"InvoiceExtraSDI.InvoiceExtraSDIInput": {
"type": "object",
"description": "Create a new Extra SDI Invoice. As response you will get back the uuid of the created resource. The invoice will be available within the `GET /invoices?type=3` collection or using the usual `GET /invoices/{uuid}` HTTP request.",
"deprecated": false,
"required": [
"payload",
"type",
"recipient",
"sender",
"date",
"number"
],
"properties": {
"payload": {
"description": "The base64 encoded file content. Max size of the payload is 10 Megabytes.",
"type": "string"
},
"type": {
"description": "The type must be set to 3 for supplier extra invoices.",
"type": "integer",
"enum": [
3
],
"example": 3
},
"recipient": {
"$ref": "#/components/schemas/InvoiceExtraSDIInputBusinessRegistry"
},
"sender": {
"description": "The sender business registry.",
"$ref": "#/components/schemas/InvoiceExtraSDIInputBusinessRegistry"
},
"date": {
"description": "The recipient business registry\nInvoice date format yyyy-mm-dd.",
"type": "string",
"format": "date-time"
},
"number": {
"description": "Invoice number.",
"type": "string"
},
"filename": {
"description": "Invoice filename, if not provided it will be set as the invoice uuid.pdf.",
"type": [
"string",
"null"
]
},
"metadata": {
"description": "Some optional information about the invoice.",
"$ref": "#/components/schemas/InvoiceExtraSDIInputMetadata"
}
}
},
"InvoiceExtraSDI.InvoiceExtraSDIInput.jsonld": {
"type": "object",
"description": "Create a new Extra SDI Invoice. As response you will get back the uuid of the created resource. The invoice will be available within the `GET /invoices?type=3` collection or using the usual `GET /invoices/{uuid}` HTTP request.",
"deprecated": false,
"required": [
"payload",
"type",
"recipient",
"sender",
"date",
"number"
],
"properties": {
"payload": {
"description": "The base64 encoded file content. Max size of the payload is 10 Megabytes.",
"type": "string"
},
"type": {
"description": "The type must be set to 3 for supplier extra invoices.",
"type": "integer",
"enum": [
3
],
"example": 3
},
"recipient": {
"$ref": "#/components/schemas/InvoiceExtraSDIInputBusinessRegistry.jsonld"
},
"sender": {
"description": "The sender business registry.",
"$ref": "#/components/schemas/InvoiceExtraSDIInputBusinessRegistry.jsonld"
},
"date": {
"description": "The recipient business registry\nInvoice date format yyyy-mm-dd.",
"type": "string",
"format": "date-time"
},
"number": {
"description": "Invoice number.",
"type": "string"
},
"filename": {
"description": "Invoice filename, if not provided it will be set as the invoice uuid.pdf.",
"type": [
"string",
"null"
]
},
"metadata": {
"description": "Some optional information about the invoice.",
"$ref": "#/components/schemas/InvoiceExtraSDIInputMetadata.jsonld"
}
}
},
"InvoiceExtraSDI.InvoiceExtraSDIOutput": {
"type": "object",
"description": "Create a new Extra SDI Invoice. As response you will get back the uuid of the created resource. The invoice will be available within the `GET /invoices?type=3` collection or using the usual `GET /invoices/{uuid}` HTTP request.",
"deprecated": false,
"properties": {
"uuid": {
"type": "string"
}
}
},
"InvoiceExtraSDI.InvoiceExtraSDIOutput.jsonld": {
"type": "object",
"description": "Create a new Extra SDI Invoice. As response you will get back the uuid of the created resource. The invoice will be available within the `GET /invoices?type=3` collection or using the usual `GET /invoices/{uuid}` HTTP request.",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"uuid": {
"type": "string"
}
}
},
"InvoiceExtraSDIInputBusinessRegistry": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"fiscal_code": {
"type": [
"string",
"null"
]
},
"vat": {
"type": [
"string",
"null"
]
},
"country": {
"description": "ISO 3166-1 alpha-2 code",
"type": [
"string",
"null"
]
},
"business_name": {
"type": [
"string",
"null"
]
}
},
"required": [
"business_name"
]
},
"InvoiceExtraSDIInputBusinessRegistry.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"fiscal_code": {
"type": [
"string",
"null"
]
},
"vat": {
"type": [
"string",
"null"
]
},
"country": {
"description": "ISO 3166-1 alpha-2 code",
"type": [
"string",
"null"
]
},
"business_name": {
"type": [
"string",
"null"
]
}
},
"required": [
"business_name"
]
},
"InvoiceExtraSDIInputMetadata": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"registration_protocol": {
"description": "Protocol number given by the recipient management software.",
"type": "string"
},
"registration_date": {
"description": "Date when the invoice has been registered into your own registry.",
"type": "string"
},
"sectional": {
"description": "Registry sectional.",
"type": "string"
},
"reference": {
"description": "Field to be used to specify a DDT of reference or an order number or any other referral document.",
"type": "string"
},
"year": {
"description": "The referral year of the document.",
"type": "string"
},
"filename": {
"description": "Invoice filename, can be very long.",
"type": [
"string",
"null"
]
}
}
},
"InvoiceExtraSDIInputMetadata.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"registration_protocol": {
"description": "Protocol number given by the recipient management software.",
"type": "string"
},
"registration_date": {
"description": "Date when the invoice has been registered into your own registry.",
"type": "string"
},
"sectional": {
"description": "Registry sectional.",
"type": "string"
},
"reference": {
"description": "Field to be used to specify a DDT of reference or an order number or any other referral document.",
"type": "string"
},
"year": {
"description": "The referral year of the document.",
"type": "string"
},
"filename": {
"description": "Invoice filename, can be very long.",
"type": [
"string",
"null"
]
}
}
},
"InvoiceExtract": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"uuid": {
"readOnly": true,
"allOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "string"
}
]
},
"file_path": {
"type": "string"
},
"result_path": {
"type": [
"string",
"null"
]
},
"file_name": {
"type": "string"
},
"job_status": {
"default": "waiting",
"example": "waiting",
"type": "string"
},
"owner": {
"type": "string",
"format": "iri-reference",
"example": "https://example.com/"
},
"conversion_configuration": {
"type": [
"string",
"null"
]
},
"pages": {
"type": [
"integer",
"null"
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
},
"InvoiceExtract.InvoiceExtractOutput": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"uuid": {
"description": "The job unique identifier.",
"type": "string"
},
"acquisition_date": {
"description": "The date time when the job was created.",
"type": "string"
},
"filename": {
"description": "The original filename.",
"type": "string"
},
"job_status": {
"description": "The job status (waiting, success, error).",
"type": "string",
"enum": [
"waiting",
"success",
"error"
]
},
"pages": {
"description": "Number of scanned pages on the PDF. If the job is not finished, this field is null.",
"type": [
"integer",
"null"
]
}
}
},
"InvoiceExtract.InvoiceExtractOutput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"uuid": {
"description": "The job unique identifier.",
"type": "string"
},
"acquisition_date": {
"description": "The date time when the job was created.",
"type": "string"
},
"filename": {
"description": "The original filename.",
"type": "string"
},
"job_status": {
"description": "The job status (waiting, success, error).",
"type": "string",
"enum": [
"waiting",
"success",
"error"
]
},
"pages": {
"description": "Number of scanned pages on the PDF. If the job is not finished, this field is null.",
"type": [
"integer",
"null"
]
}
}
},
"InvoiceExtract.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"uuid": {
"readOnly": true,
"allOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "string"
}
]
},
"file_path": {
"type": "string"
},
"result_path": {
"type": [
"string",
"null"
]
},
"file_name": {
"type": "string"
},
"job_status": {
"default": "waiting",
"example": "waiting",
"type": "string"
},
"owner": {
"type": "string",
"format": "iri-reference",
"example": "https://example.com/"
},
"conversion_configuration": {
"type": [
"string",
"null"
]
},
"pages": {
"type": [
"integer",
"null"
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
},
"InvoiceSimplified.InvoiceSimplifiedDraftInput-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"fattura_elettronica_header": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.FatturaElettronicaHeader-write"
},
{
"type": "null"
}
]
},
"fattura_elettronica_body": {
"minItems": 0,
"maxItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.FatturaElettronicaBody-write"
}
}
}
},
"InvoiceSimplified.InvoiceSimplifiedDraftInput.jsonld-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"fattura_elettronica_header": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.FatturaElettronicaHeader.jsonld-write"
},
{
"type": "null"
}
]
},
"fattura_elettronica_body": {
"minItems": 0,
"maxItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.FatturaElettronicaBody.jsonld-write"
}
}
}
},
"InvoiceSimplified.InvoiceSimplifiedInput-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"fattura_elettronica_header",
"fattura_elettronica_body"
],
"properties": {
"fattura_elettronica_header": {
"$ref": "#/components/schemas/FatturaElettronicaHeader-write"
},
"fattura_elettronica_body": {
"minItems": 1,
"maxItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/FatturaElettronicaBody-write"
}
}
}
},
"InvoiceSimplified.InvoiceSimplifiedOutput-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"uuid": {
"type": "string"
}
}
},
"InvoiceSimplified.InvoiceSimplifiedOutput.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"uuid": {
"type": "string"
}
}
},
"InvoiceStats": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"year": {
"type": "integer"
},
"month": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"day": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"hour_slot": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"customer_invoices": {
"$ref": "#/components/schemas/CountDetail"
},
"supplier_extra_sdi_invoices": {
"$ref": "#/components/schemas/CountDetail"
},
"supplier_invoice": {
"$ref": "#/components/schemas/CountDetail"
},
"total": {
"$ref": "#/components/schemas/CountDetail"
},
"notifications": {
"$ref": "#/components/schemas/NotificationStats"
},
"months": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/InvoiceStats"
}
},
"days": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/InvoiceStats"
}
},
"hour_slots": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/InvoiceStats"
}
}
}
},
"InvoiceStats.InvoiceStatsOutput": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"fiscal_id": {
"type": "string"
},
"stats": {
"$ref": "#/components/schemas/InvoiceStats"
}
}
},
"InvoiceStats.InvoiceStatsOutput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"fiscal_id": {
"type": "string"
},
"stats": {
"$ref": "#/components/schemas/InvoiceStats.jsonld"
}
}
},
"InvoiceStats.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"year": {
"type": "integer"
},
"month": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"day": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"hour_slot": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"customer_invoices": {
"$ref": "#/components/schemas/CountDetail.jsonld"
},
"supplier_extra_sdi_invoices": {
"$ref": "#/components/schemas/CountDetail.jsonld"
},
"supplier_invoice": {
"$ref": "#/components/schemas/CountDetail.jsonld"
},
"total": {
"$ref": "#/components/schemas/CountDetail.jsonld"
},
"notifications": {
"$ref": "#/components/schemas/NotificationStats.jsonld"
},
"months": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/InvoiceStats.jsonld"
}
},
"days": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/InvoiceStats.jsonld"
}
},
"hour_slots": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/InvoiceStats.jsonld"
}
}
}
},
"InvoiceTransfer.InvoiceTransferOutput": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"uuid": {
"type": "string"
},
"supplier_name": {
"type": [
"string",
"null"
]
},
"supplier_fiscal_id": {
"type": [
"string",
"null"
]
},
"customer_name": {
"type": [
"string",
"null"
]
},
"customer_fiscal_id": {
"type": [
"string",
"null"
]
},
"invoice_number": {
"type": [
"string",
"null"
]
},
"invoice_date": {
"type": [
"string",
"null"
]
},
"invoice_type": {
"type": [
"string",
"null"
]
},
"invoice_net_amount": {
"type": [
"number",
"null"
]
},
"invoice_vat_amount": {
"type": [
"number",
"null"
]
},
"invoice_tot_amount": {
"type": [
"number",
"null"
]
},
"original_file_name": {
"type": [
"string",
"null"
]
},
"reference": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": [
"string",
"null"
]
},
"violations": {
"type": [
"string",
"null"
]
},
"sent_at": {
"type": [
"string",
"null"
]
},
"sdi_id": {
"type": [
"string",
"null"
]
},
"sdi_file_name": {
"type": [
"string",
"null"
]
},
"invoice_uuid": {
"type": [
"string",
"null"
]
},
"marking": {
"type": [
"string",
"null"
]
},
"notice": {
"type": [
"string",
"null"
]
}
}
},
"InvoiceTransfer.InvoiceTransferOutput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"uuid": {
"type": "string"
},
"supplier_name": {
"type": [
"string",
"null"
]
},
"supplier_fiscal_id": {
"type": [
"string",
"null"
]
},
"customer_name": {
"type": [
"string",
"null"
]
},
"customer_fiscal_id": {
"type": [
"string",
"null"
]
},
"invoice_number": {
"type": [
"string",
"null"
]
},
"invoice_date": {
"type": [
"string",
"null"
]
},
"invoice_type": {
"type": [
"string",
"null"
]
},
"invoice_net_amount": {
"type": [
"number",
"null"
]
},
"invoice_vat_amount": {
"type": [
"number",
"null"
]
},
"invoice_tot_amount": {
"type": [
"number",
"null"
]
},
"original_file_name": {
"type": [
"string",
"null"
]
},
"reference": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": [
"string",
"null"
]
},
"violations": {
"type": [
"string",
"null"
]
},
"sent_at": {
"type": [
"string",
"null"
]
},
"sdi_id": {
"type": [
"string",
"null"
]
},
"sdi_file_name": {
"type": [
"string",
"null"
]
},
"invoice_uuid": {
"type": [
"string",
"null"
]
},
"marking": {
"type": [
"string",
"null"
]
},
"notice": {
"type": [
"string",
"null"
]
}
}
},
"IscrizioneREA-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"ufficio",
"numero_rea",
"stato_liquidazione"
],
"properties": {
"ufficio": {
"minLength": 2,
"maxLength": 2,
"type": "string"
},
"numero_rea": {
"minLength": 1,
"maxLength": 20,
"type": "string"
},
"capitale_sociale": {
"minLength": 4,
"maxLength": 15,
"allOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"socio_unico": {
"enum": [
"SU",
"SM"
],
"type": [
"string",
"null"
]
},
"stato_liquidazione": {
"enum": [
"LS",
"LN"
],
"type": "string"
}
}
},
"Job.JobInvoiceDownloadInput": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"from_date",
"to_date"
],
"properties": {
"from_date": {
"description": "Start date for the invoice download job. Note that The electronic invoice files issued |\n and received through the SdI are made available in the consultation area until December 31 of the year following |\n the one in which the invoices were received by the Sistema di Interscambio.",
"externalDocs": {
"url": "https://schema.org/Date"
},
"type": "string"
},
"to_date": {
"description": "End date for the invoice download job.",
"externalDocs": {
"url": "https://schema.org/Date"
},
"type": "string"
},
"fiscal_id": {
"description": "Fiscal ID of the business registry configuration to download invoices for.",
"type": "string"
},
"scheduled_at": {
"description": "When to schedule the job. If not provided, the job will be scheduled immediately.",
"externalDocs": {
"url": "https://schema.org/DateTime"
},
"type": [
"string",
"null"
]
}
}
},
"Job.JobInvoiceDownloadInput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"from_date",
"to_date"
],
"properties": {
"from_date": {
"description": "Start date for the invoice download job. Note that The electronic invoice files issued |\n and received through the SdI are made available in the consultation area until December 31 of the year following |\n the one in which the invoices were received by the Sistema di Interscambio.",
"externalDocs": {
"url": "https://schema.org/Date"
},
"type": "string"
},
"to_date": {
"description": "End date for the invoice download job.",
"externalDocs": {
"url": "https://schema.org/Date"
},
"type": "string"
},
"fiscal_id": {
"description": "Fiscal ID of the business registry configuration to download invoices for.",
"type": "string"
},
"scheduled_at": {
"description": "When to schedule the job. If not provided, the job will be scheduled immediately.",
"externalDocs": {
"url": "https://schema.org/DateTime"
},
"type": [
"string",
"null"
]
}
}
},
"Job.JobInvoiceReportDownloadInput": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"from_date",
"to_date"
],
"properties": {
"from_date": {
"description": "Start date for the invoice report job.",
"externalDocs": {
"url": "https://schema.org/Date"
},
"type": "string"
},
"to_date": {
"description": "End date for the invoice report job.",
"externalDocs": {
"url": "https://schema.org/Date"
},
"type": "string"
},
"scheduled_at": {
"description": "When to schedule the job. If not provided, the job will be scheduled immediately.",
"externalDocs": {
"url": "https://schema.org/DateTime"
},
"type": [
"string",
"null"
]
},
"destination": {
"enum": [
"sftp",
"api"
],
"description": "Destination of the report. Possible values: \"sftp\", \"api\".",
"type": [
"string",
"null"
]
},
"filters": {
"description": "Optional filters to apply, same semantics as /invoices/report (e.g. {\"type\": 0,\"marking\":\"delivered\"}).",
"type": [
"object",
"null"
],
"additionalProperties": {
"type": "string"
}
}
}
},
"Job.JobInvoiceReportDownloadInput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"from_date",
"to_date"
],
"properties": {
"from_date": {
"description": "Start date for the invoice report job.",
"externalDocs": {
"url": "https://schema.org/Date"
},
"type": "string"
},
"to_date": {
"description": "End date for the invoice report job.",
"externalDocs": {
"url": "https://schema.org/Date"
},
"type": "string"
},
"scheduled_at": {
"description": "When to schedule the job. If not provided, the job will be scheduled immediately.",
"externalDocs": {
"url": "https://schema.org/DateTime"
},
"type": [
"string",
"null"
]
},
"destination": {
"enum": [
"sftp",
"api"
],
"description": "Destination of the report. Possible values: \"sftp\", \"api\".",
"type": [
"string",
"null"
]
},
"filters": {
"description": "Optional filters to apply, same semantics as /invoices/report (e.g. {\"type\": 0,\"marking\":\"delivered\"}).",
"type": [
"object",
"null"
],
"additionalProperties": {
"type": "string"
}
}
}
},
"Job.JobInvoiceZipDownloadInput": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"from_date",
"to_date"
],
"properties": {
"from_date": {
"description": "Start date for invoices to include in the ZIP.",
"externalDocs": {
"url": "https://schema.org/Date"
},
"type": "string"
},
"to_date": {
"description": "End date for invoices to include in the ZIP.",
"externalDocs": {
"url": "https://schema.org/Date"
},
"type": "string"
},
"scheduled_at": {
"description": "When to schedule the job. If not provided, the job will be scheduled immediately.",
"externalDocs": {
"url": "https://schema.org/DateTime"
},
"type": [
"string",
"null"
]
},
"filters": {
"description": "Optional filters to apply, same semantics as /invoices/report (e.g. {\"type\":0,\"marking\":\"delivered\"}).",
"type": [
"object",
"null"
],
"additionalProperties": {
"type": "string"
}
},
"print_pdf": {
"description": "If true, generate PDFs instead of including XML + notifications/metadata.",
"type": [
"boolean",
"null"
]
},
"pdf_theme": {
"description": "Optional PDF theme when printPdf=true.",
"type": [
"string",
"null"
]
},
"destination": {
"enum": [
"sftp",
"api"
],
"description": "Destination storage: api (S3) or sftp for external storage.",
"type": [
"string",
"null"
]
},
"emails": {
"description": "Optional emails to use as a recipient for a notification when destination=\"api\".",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"add_notifications": {
"description": "Whether to include invoice notifications in the ZIP.",
"type": [
"boolean",
"null"
]
},
"add_metadata": {
"description": "Whether to include invoice metadata in the ZIP.",
"type": [
"boolean",
"null"
]
}
}
},
"Job.JobInvoiceZipDownloadInput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"from_date",
"to_date"
],
"properties": {
"from_date": {
"description": "Start date for invoices to include in the ZIP.",
"externalDocs": {
"url": "https://schema.org/Date"
},
"type": "string"
},
"to_date": {
"description": "End date for invoices to include in the ZIP.",
"externalDocs": {
"url": "https://schema.org/Date"
},
"type": "string"
},
"scheduled_at": {
"description": "When to schedule the job. If not provided, the job will be scheduled immediately.",
"externalDocs": {
"url": "https://schema.org/DateTime"
},
"type": [
"string",
"null"
]
},
"filters": {
"description": "Optional filters to apply, same semantics as /invoices/report (e.g. {\"type\":0,\"marking\":\"delivered\"}).",
"type": [
"object",
"null"
],
"additionalProperties": {
"type": "string"
}
},
"print_pdf": {
"description": "If true, generate PDFs instead of including XML + notifications/metadata.",
"type": [
"boolean",
"null"
]
},
"pdf_theme": {
"description": "Optional PDF theme when printPdf=true.",
"type": [
"string",
"null"
]
},
"destination": {
"enum": [
"sftp",
"api"
],
"description": "Destination storage: api (S3) or sftp for external storage.",
"type": [
"string",
"null"
]
},
"emails": {
"description": "Optional emails to use as a recipient for a notification when destination=\"api\".",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"add_notifications": {
"description": "Whether to include invoice notifications in the ZIP.",
"type": [
"boolean",
"null"
]
},
"add_metadata": {
"description": "Whether to include invoice metadata in the ZIP.",
"type": [
"boolean",
"null"
]
}
}
},
"Job.JobOutput": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"uuid": {
"type": "string"
},
"type": {
"type": "string"
},
"status": {
"type": "string"
},
"parameters": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"fiscal_id": {
"type": [
"string",
"null"
]
},
"downloadable": {
"type": "boolean"
},
"scheduled_at": {
"type": [
"string",
"null"
]
},
"started_at": {
"type": [
"string",
"null"
]
},
"completed_at": {
"type": [
"string",
"null"
]
},
"output": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": [
"string",
"null"
]
}
}
},
"Job.JobOutput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"uuid": {
"type": "string"
},
"type": {
"type": "string"
},
"status": {
"type": "string"
},
"parameters": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"fiscal_id": {
"type": [
"string",
"null"
]
},
"downloadable": {
"type": "boolean"
},
"scheduled_at": {
"type": [
"string",
"null"
]
},
"started_at": {
"type": [
"string",
"null"
]
},
"completed_at": {
"type": [
"string",
"null"
]
},
"output": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": [
"string",
"null"
]
}
}
},
"Notification": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"uuid": {
"type": "string"
},
"invoice_uuid": {
"type": "string"
},
"created_at": {
"description": "The date the notification was received.",
"type": "string"
},
"type": {
"description": "The notification type (2 letters code).",
"type": "string"
},
"file_name": {
"type": "string"
},
"message": {
"description": "The notification message model.",
"$ref": "#/components/schemas/NotificationModelInterface"
},
"downloaded": {
"description": "The notification was downloaded (automatically when received by webhook or manually for polling integrations).",
"type": "boolean"
},
"downloaded_at": {
"description": "Notification download date.",
"type": [
"string",
"null"
],
"format": "date-time"
}
}
},
"Notification.DownloadedEntity": {
"type": "object",
"description": "Setup the downloaded flag for a collection of notification.
Note: the downloaded flag is automatically set when a notification is successfully received with the webhook",
"deprecated": false,
"properties": {
"uuids": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
},
"downloaded": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
}
]
}
},
"required": [
"downloaded"
]
},
"Notification.DownloadedEntity.jsonld": {
"type": "object",
"description": "Setup the downloaded flag for a collection of notification.
Note: the downloaded flag is automatically set when a notification is successfully received with the webhook",
"deprecated": false,
"properties": {
"uuids": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
},
"downloaded": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
}
]
}
},
"required": [
"downloaded"
]
},
"Notification.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"uuid": {
"type": "string"
},
"invoice_uuid": {
"type": "string"
},
"created_at": {
"description": "The date the notification was received.",
"type": "string"
},
"type": {
"description": "The notification type (2 letters code).",
"type": "string"
},
"file_name": {
"type": "string"
},
"message": {
"description": "The notification message model.",
"$ref": "#/components/schemas/NotificationModelInterface.jsonld"
},
"downloaded": {
"description": "The notification was downloaded (automatically when received by webhook or manually for polling integrations).",
"type": "boolean"
},
"downloaded_at": {
"description": "Notification download date.",
"type": [
"string",
"null"
],
"format": "date-time"
}
}
},
"NotificationModelInterface": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"identificativo_sdi": {
"readOnly": true,
"anyOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
}
},
"NotificationModelInterface.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"identificativo_sdi": {
"readOnly": true,
"anyOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
}
},
"NotificationStats": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"at": {
"type": "integer"
},
"dt": {
"type": "integer"
},
"mc": {
"type": "integer"
},
"ne": {
"type": "integer"
},
"ns": {
"type": "integer"
},
"rc": {
"type": "integer"
}
}
},
"NotificationStats.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"at": {
"type": "integer"
},
"dt": {
"type": "integer"
},
"mc": {
"type": "integer"
},
"ne": {
"type": "integer"
},
"ns": {
"type": "integer"
},
"rc": {
"type": "integer"
}
}
},
"NumberingSequence.NumberingSequenceCreateInput": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"name",
"format"
],
"properties": {
"name": {
"type": "string"
},
"format": {
"type": "string"
},
"number": {
"minimum": 0,
"type": [
"integer",
"null"
]
}
}
},
"NumberingSequence.NumberingSequenceCreateInput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"name",
"format"
],
"properties": {
"name": {
"type": "string"
},
"format": {
"type": "string"
},
"number": {
"minimum": 0,
"type": [
"integer",
"null"
]
}
}
},
"NumberingSequence.NumberingSequenceOutput": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"uuid": {
"type": "string"
},
"name": {
"type": "string"
},
"year": {
"type": "integer"
},
"format": {
"type": "string"
},
"number": {
"type": "integer"
},
"last_date": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
},
"NumberingSequence.NumberingSequenceOutput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"uuid": {
"type": "string"
},
"name": {
"type": "string"
},
"year": {
"type": "integer"
},
"format": {
"type": "string"
},
"number": {
"type": "integer"
},
"last_date": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
},
"NumberingSequence.NumberingSequenceUpdateInput": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"format"
],
"properties": {
"format": {
"type": "string"
},
"number": {
"minimum": 0,
"type": [
"integer",
"null"
]
}
}
},
"NumberingSequence.NumberingSequenceUpdateInput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"format"
],
"properties": {
"format": {
"type": "string"
},
"number": {
"minimum": 0,
"type": [
"integer",
"null"
]
}
}
},
"Partner-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"company_name": {
"description": "The partner's company name",
"type": [
"string",
"null"
],
"example": "Company name"
},
"name": {
"description": "The partner's first name",
"type": [
"string",
"null"
],
"example": null
},
"surname": {
"description": "The partner's last name",
"type": [
"string",
"null"
],
"example": null
},
"partner_fiscal_code": {
"description": "The partner's fiscal id",
"type": [
"string",
"null"
],
"example": "12345678901"
},
"dues": {
"description": "The partner's dues in the company in percentage if superior to 10%",
"type": [
"number",
"null"
],
"example": 100
}
}
},
"Partner.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"company_name": {
"description": "The partner's company name",
"type": [
"string",
"null"
],
"example": "Company name"
},
"name": {
"description": "The partner's first name",
"type": [
"string",
"null"
],
"example": null
},
"surname": {
"description": "The partner's last name",
"type": [
"string",
"null"
],
"example": null
},
"partner_fiscal_code": {
"description": "The partner's fiscal id",
"type": [
"string",
"null"
],
"example": "12345678901"
},
"dues": {
"description": "The partner's dues in the company in percentage if superior to 10%",
"type": [
"number",
"null"
],
"example": 100
}
}
},
"PreservedDocument-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"uuid": {
"readOnly": true,
"allOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "string"
}
]
},
"status": {
"description": "Can be on of \"to_be_stored\", \"sent\", \"stored\", \"error\".",
"default": "to_be_stored",
"example": "to_be_stored",
"type": "string"
},
"receipt_received_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"object_type": {
"description": "Can be one of \"customer invoice\", \"supplier invoice\", \"extra sdi supplier invoice\".",
"type": "string"
},
"object_id": {
"readOnly": true,
"description": "The id of the object that went into the legal storage (e.g. Invoice).",
"type": [
"string",
"null"
]
},
"message": {
"description": "The messages received from the legal storage.",
"type": [
"string",
"null"
]
},
"preserved_object_id": {
"description": "The legal storage object id.",
"type": [
"string",
"null"
]
},
"weight": {
"description": "The weight in bytes of the preserved document.",
"type": [
"integer",
"null"
]
}
}
},
"PreservedDocument.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"uuid": {
"readOnly": true,
"allOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "string"
}
]
},
"status": {
"description": "Can be on of \"to_be_stored\", \"sent\", \"stored\", \"error\".",
"default": "to_be_stored",
"example": "to_be_stored",
"type": "string"
},
"receipt_received_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"object_type": {
"description": "Can be one of \"customer invoice\", \"supplier invoice\", \"extra sdi supplier invoice\".",
"type": "string"
},
"object_id": {
"readOnly": true,
"description": "The id of the object that went into the legal storage (e.g. Invoice).",
"type": [
"string",
"null"
]
},
"message": {
"description": "The messages received from the legal storage.",
"type": [
"string",
"null"
]
},
"preserved_object_id": {
"description": "The legal storage object id.",
"type": [
"string",
"null"
]
},
"weight": {
"description": "The weight in bytes of the preserved document.",
"type": [
"integer",
"null"
]
}
}
},
"PreservedDocumentReceipt": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"xml": {
"type": "string"
}
}
},
"RappresentanteFiscale-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_fiscale_iva": {
"anyOf": [
{
"$ref": "#/components/schemas/IdFiscale-write"
},
{
"type": "null"
}
]
},
"denominazione": {
"minLength": 1,
"maxLength": 80,
"description": "Company name, to be filled in case 'nome' and 'cognome' are empty",
"type": [
"string",
"null"
]
},
"nome": {
"minLength": 1,
"maxLength": 60,
"description": "Physical person's name, to be filled with 'cognome' in case 'denominazione' is empty",
"type": [
"string",
"null"
]
},
"cognome": {
"minLength": 1,
"maxLength": 60,
"description": "Physical person's surname, to be filled with 'name' in case 'denominazione' is empty",
"type": [
"string",
"null"
]
}
}
},
"RappresentanteFiscaleCessionarioCommittente-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id_fiscale_iva": {
"$ref": "#/components/schemas/FatturaPA.IdFiscale-write"
},
"denominazione": {
"minLength": 1,
"maxLength": 80,
"type": [
"string",
"null"
]
},
"nome": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
},
"cognome": {
"minLength": 1,
"maxLength": 60,
"type": [
"string",
"null"
]
}
}
},
"Receipt": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"uuid": {
"type": "string",
"format": "uuid"
},
"type": {
"default": "sale",
"example": "sale",
"type": "string"
},
"status": {
"default": "new",
"example": "new",
"type": "string"
},
"transaction_id": {
"type": [
"string",
"null"
]
},
"document_number": {
"type": [
"string",
"null"
]
},
"document_date": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"total_amount": {
"type": [
"string",
"null"
]
},
"items": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": "number"
}
},
"input_path": {
"type": [
"string",
"null"
]
},
"request_path": {
"type": [
"string",
"null"
]
},
"response_path": {
"type": [
"string",
"null"
]
},
"details_path": {
"type": [
"string",
"null"
]
},
"pdf_path": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"last_error_code": {
"type": [
"string",
"null"
]
},
"last_error_message": {
"type": [
"string",
"null"
]
},
"business_registry_configuration": {
"type": "string",
"format": "iri-reference",
"example": "https://example.com/"
},
"parent_receipt": {
"type": [
"string",
"null"
],
"format": "iri-reference",
"example": "https://example.com/"
},
"linked_receipts": {
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"format": "iri-reference",
"example": "https://example.com/"
}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"last_error_message_redacted": {
"readOnly": true,
"type": [
"string",
"null"
]
},
"owner": {
"readOnly": true,
"type": [
"string",
"null"
],
"format": "iri-reference",
"example": "https://example.com/"
}
}
},
"Receipt.ReceiptDetailsOutput": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"total_taxable_amount": {
"type": [
"number",
"null"
],
"example": 7.23
},
"total_uncollected_amount": {
"type": [
"number",
"null"
],
"example": 7.23
},
"deductible_amount": {
"type": [
"number",
"null"
],
"example": 7.23
},
"total_vat_amount": {
"type": [
"number",
"null"
],
"example": 7.23
},
"total_discount": {
"type": [
"number",
"null"
],
"example": 7.23
},
"total_gross_discount": {
"type": [
"number",
"null"
],
"example": 7.23
},
"discount": {
"type": [
"number",
"null"
],
"example": 7.23
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReceiptDetailsItem"
}
},
"uuid": {
"description": "The uuid assigned to document by A-Cube.",
"type": "string"
},
"type": {
"type": "string",
"enum": [
"sale",
"return",
"void"
]
},
"status": {
"type": "string",
"enum": [
"new",
"retry",
"submitted",
"ready",
"failed",
"voided"
]
},
"fiscal_id": {
"type": "string"
},
"created_at": {
"type": "string",
"example": "2024-10-08 16:19:42"
},
"total_amount": {
"type": [
"number",
"null"
],
"example": 11.42
},
"transaction_id": {
"description": "The identifier assigned to document by the Tax Authority.",
"type": [
"string",
"null"
]
},
"document_number": {
"description": "The document number assigned to document by the Tax Authority.",
"type": [
"string",
"null"
]
},
"document_date": {
"type": [
"string",
"null"
],
"example": "2024-10-08 16:19:42"
}
}
},
"Receipt.ReceiptDetailsOutput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"total_taxable_amount": {
"type": [
"number",
"null"
],
"example": 7.23
},
"total_uncollected_amount": {
"type": [
"number",
"null"
],
"example": 7.23
},
"deductible_amount": {
"type": [
"number",
"null"
],
"example": 7.23
},
"total_vat_amount": {
"type": [
"number",
"null"
],
"example": 7.23
},
"total_discount": {
"type": [
"number",
"null"
],
"example": 7.23
},
"total_gross_discount": {
"type": [
"number",
"null"
],
"example": 7.23
},
"discount": {
"type": [
"number",
"null"
],
"example": 7.23
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReceiptDetailsItem.jsonld"
}
},
"uuid": {
"description": "The uuid assigned to document by A-Cube.",
"type": "string"
},
"type": {
"type": "string",
"enum": [
"sale",
"return",
"void"
]
},
"status": {
"type": "string",
"enum": [
"new",
"retry",
"submitted",
"ready",
"failed",
"voided"
]
},
"fiscal_id": {
"type": "string"
},
"created_at": {
"type": "string",
"example": "2024-10-08 16:19:42"
},
"total_amount": {
"type": [
"number",
"null"
],
"example": 11.42
},
"transaction_id": {
"description": "The identifier assigned to document by the Tax Authority.",
"type": [
"string",
"null"
]
},
"document_number": {
"description": "The document number assigned to document by the Tax Authority.",
"type": [
"string",
"null"
]
},
"document_date": {
"type": [
"string",
"null"
],
"example": "2024-10-08 16:19:42"
}
}
},
"Receipt.ReceiptInput": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"fiscal_id",
"items"
],
"properties": {
"fiscal_id": {
"description": "The VAT number of the company that issued the receipt without the country prefix.",
"type": "string"
},
"lottery_code": {
"description": "\"Codice Lotteria del cliente\".",
"type": [
"string",
"null"
]
},
"items": {
"description": "\"Elementi contabili\". Receipt items.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ReceiptItem"
}
},
"invoice_issuing": {
"description": "\"Flag Emissione Fattura\".",
"type": "boolean"
},
"services_uncollected_amount": {
"minimum": 0,
"description": "\"Credito Non Riscosso - Prestazioni Servizi\".",
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"goods_uncollected_amount": {
"minimum": 0,
"description": "\"Credito Non Riscosso - Bene Consegnato\".",
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"cash_payment_amount": {
"minimum": 0,
"description": "\"Pagamento In Contanti\".",
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"electronic_payment_amount": {
"minimum": 0,
"description": "\"Pagamento Elettronico\".",
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"ticket_restaurant_payment_amount": {
"minimum": 0,
"description": "\"Pagamento Ticket Restaurant\".",
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"ticket_restaurant_quantity": {
"minimum": 0,
"description": "\"Numero Ticket Restaurant\".",
"type": "integer"
},
"discount": {
"minimum": 0,
"description": "\"Sconto A Pagare\".",
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"linked_receipt": {
"maxLength": 20,
"description": "\"Documento Commerciale Collegato\".",
"type": [
"string",
"null"
]
},
"email": {
"format": "email",
"description": "This optional will receive the final PDF of the receipt.",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
},
"total_amount_from_items": {
"readOnly": true,
"type": "string"
},
"total_paid_and_uncollected_amount": {
"readOnly": true,
"type": "string"
}
}
},
"Receipt.ReceiptInput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"fiscal_id",
"items"
],
"properties": {
"fiscal_id": {
"description": "The VAT number of the company that issued the receipt without the country prefix.",
"type": "string"
},
"lottery_code": {
"description": "\"Codice Lotteria del cliente\".",
"type": [
"string",
"null"
]
},
"items": {
"description": "\"Elementi contabili\". Receipt items.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ReceiptItem.jsonld"
}
},
"invoice_issuing": {
"description": "\"Flag Emissione Fattura\".",
"type": "boolean"
},
"services_uncollected_amount": {
"minimum": 0,
"description": "\"Credito Non Riscosso - Prestazioni Servizi\".",
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"goods_uncollected_amount": {
"minimum": 0,
"description": "\"Credito Non Riscosso - Bene Consegnato\".",
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"cash_payment_amount": {
"minimum": 0,
"description": "\"Pagamento In Contanti\".",
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"electronic_payment_amount": {
"minimum": 0,
"description": "\"Pagamento Elettronico\".",
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"ticket_restaurant_payment_amount": {
"minimum": 0,
"description": "\"Pagamento Ticket Restaurant\".",
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"ticket_restaurant_quantity": {
"minimum": 0,
"description": "\"Numero Ticket Restaurant\".",
"type": "integer"
},
"discount": {
"minimum": 0,
"description": "\"Sconto A Pagare\".",
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"linked_receipt": {
"maxLength": 20,
"description": "\"Documento Commerciale Collegato\".",
"type": [
"string",
"null"
]
},
"email": {
"format": "email",
"description": "This optional will receive the final PDF of the receipt.",
"externalDocs": {
"url": "https://schema.org/email"
},
"type": [
"string",
"null"
]
},
"total_amount_from_items": {
"readOnly": true,
"type": "string"
},
"total_paid_and_uncollected_amount": {
"readOnly": true,
"type": "string"
}
}
},
"Receipt.ReceiptOutput": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"return_receipts": {
"description": "The list of receipts for returns linked to the current `sale` receipt.",
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/ReceiptBasicOutput"
}
},
"voiding_receipt": {
"description": "The `void` receipt that voided the current `sale` receipt.",
"anyOf": [
{
"$ref": "#/components/schemas/ReceiptBasicOutput"
},
{
"type": "null"
}
]
},
"returned_receipt": {
"description": "The `sale` receipt the current `return` receipt is linked to.",
"anyOf": [
{
"$ref": "#/components/schemas/ReceiptBasicOutput"
},
{
"type": "null"
}
]
},
"voided_receipt": {
"description": "The `sale` receipt that has been voided by the current `void` receipt.",
"anyOf": [
{
"$ref": "#/components/schemas/ReceiptBasicOutput"
},
{
"type": "null"
}
]
},
"error_message": {
"description": "The error message in case the communication with the Tax Authority failed.",
"type": [
"string",
"null"
]
},
"error_code": {
"description": "The error code in case the communication with the Tax Authority failed.",
"type": [
"string",
"null"
]
},
"uuid": {
"description": "The uuid assigned to document by A-Cube.",
"type": "string"
},
"type": {
"type": "string",
"enum": [
"sale",
"return",
"void"
]
},
"status": {
"type": "string",
"enum": [
"new",
"retry",
"submitted",
"ready",
"failed",
"voided"
]
},
"fiscal_id": {
"type": "string"
},
"created_at": {
"type": "string",
"example": "2024-10-08 16:19:42"
},
"total_amount": {
"type": [
"number",
"null"
],
"example": 11.42
},
"transaction_id": {
"description": "The identifier assigned to document by the Tax Authority.",
"type": [
"string",
"null"
]
},
"document_number": {
"description": "The document number assigned to document by the Tax Authority.",
"type": [
"string",
"null"
]
},
"document_date": {
"type": [
"string",
"null"
],
"example": "2024-10-08 16:19:42"
}
}
},
"Receipt.ReceiptOutput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"return_receipts": {
"description": "The list of receipts for returns linked to the current `sale` receipt.",
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/ReceiptBasicOutput.jsonld"
}
},
"voiding_receipt": {
"description": "The `void` receipt that voided the current `sale` receipt.",
"anyOf": [
{
"$ref": "#/components/schemas/ReceiptBasicOutput.jsonld"
},
{
"type": "null"
}
]
},
"returned_receipt": {
"description": "The `sale` receipt the current `return` receipt is linked to.",
"anyOf": [
{
"$ref": "#/components/schemas/ReceiptBasicOutput.jsonld"
},
{
"type": "null"
}
]
},
"voided_receipt": {
"description": "The `sale` receipt that has been voided by the current `void` receipt.",
"anyOf": [
{
"$ref": "#/components/schemas/ReceiptBasicOutput.jsonld"
},
{
"type": "null"
}
]
},
"error_message": {
"description": "The error message in case the communication with the Tax Authority failed.",
"type": [
"string",
"null"
]
},
"error_code": {
"description": "The error code in case the communication with the Tax Authority failed.",
"type": [
"string",
"null"
]
},
"uuid": {
"description": "The uuid assigned to document by A-Cube.",
"type": "string"
},
"type": {
"type": "string",
"enum": [
"sale",
"return",
"void"
]
},
"status": {
"type": "string",
"enum": [
"new",
"retry",
"submitted",
"ready",
"failed",
"voided"
]
},
"fiscal_id": {
"type": "string"
},
"created_at": {
"type": "string",
"example": "2024-10-08 16:19:42"
},
"total_amount": {
"type": [
"number",
"null"
],
"example": 11.42
},
"transaction_id": {
"description": "The identifier assigned to document by the Tax Authority.",
"type": [
"string",
"null"
]
},
"document_number": {
"description": "The document number assigned to document by the Tax Authority.",
"type": [
"string",
"null"
]
},
"document_date": {
"type": [
"string",
"null"
],
"example": "2024-10-08 16:19:42"
}
}
},
"Receipt.ReceiptReport": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"uuid": {
"type": "string"
},
"type": {
"type": "string"
},
"status": {
"type": "string"
},
"document_number": {
"type": "string"
},
"document_date": {
"type": "string"
},
"total_amount": {
"type": "string"
},
"created_at": {
"type": "string"
},
"fiscal_id": {
"type": "string"
},
"transaction_id": {
"type": "string"
}
}
},
"Receipt.ReceiptReturnInput": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"items"
],
"properties": {
"items": {
"description": "\"Elementi contabili\".",
"type": "array",
"items": {
"$ref": "#/components/schemas/ReceiptReturnItem"
}
}
}
},
"Receipt.ReceiptReturnInput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"items"
],
"properties": {
"items": {
"description": "\"Elementi contabili\".",
"type": "array",
"items": {
"$ref": "#/components/schemas/ReceiptReturnItem.jsonld"
}
}
}
},
"Receipt.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"uuid": {
"type": "string",
"format": "uuid"
},
"type": {
"default": "sale",
"example": "sale",
"type": "string"
},
"status": {
"default": "new",
"example": "new",
"type": "string"
},
"transaction_id": {
"type": [
"string",
"null"
]
},
"document_number": {
"type": [
"string",
"null"
]
},
"document_date": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"total_amount": {
"type": [
"string",
"null"
]
},
"items": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": "number"
}
},
"input_path": {
"type": [
"string",
"null"
]
},
"request_path": {
"type": [
"string",
"null"
]
},
"response_path": {
"type": [
"string",
"null"
]
},
"details_path": {
"type": [
"string",
"null"
]
},
"pdf_path": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"last_error_code": {
"type": [
"string",
"null"
]
},
"last_error_message": {
"type": [
"string",
"null"
]
},
"business_registry_configuration": {
"type": "string",
"format": "iri-reference",
"example": "https://example.com/"
},
"parent_receipt": {
"type": [
"string",
"null"
],
"format": "iri-reference",
"example": "https://example.com/"
},
"linked_receipts": {
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"format": "iri-reference",
"example": "https://example.com/"
}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"last_error_message_redacted": {
"readOnly": true,
"type": [
"string",
"null"
]
},
"owner": {
"readOnly": true,
"type": [
"string",
"null"
],
"format": "iri-reference",
"example": "https://example.com/"
}
}
},
"ReceiptBasicOutput": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"uuid": {
"description": "The uuid assigned to document by A-Cube.",
"type": "string"
},
"type": {
"type": "string",
"enum": [
"sale",
"return",
"void"
]
},
"status": {
"type": "string",
"enum": [
"new",
"retry",
"submitted",
"ready",
"failed",
"voided"
]
},
"fiscal_id": {
"type": "string"
},
"created_at": {
"type": "string",
"example": "2024-10-08 16:19:42"
},
"total_amount": {
"type": [
"number",
"null"
],
"example": 11.42
},
"transaction_id": {
"description": "The identifier assigned to document by the Tax Authority.",
"type": [
"string",
"null"
]
},
"document_number": {
"description": "The document number assigned to document by the Tax Authority.",
"type": [
"string",
"null"
]
},
"document_date": {
"type": [
"string",
"null"
],
"example": "2024-10-08 16:19:42"
}
}
},
"ReceiptBasicOutput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"uuid": {
"description": "The uuid assigned to document by A-Cube.",
"type": "string"
},
"type": {
"type": "string",
"enum": [
"sale",
"return",
"void"
]
},
"status": {
"type": "string",
"enum": [
"new",
"retry",
"submitted",
"ready",
"failed",
"voided"
]
},
"fiscal_id": {
"type": "string"
},
"created_at": {
"type": "string",
"example": "2024-10-08 16:19:42"
},
"total_amount": {
"type": [
"number",
"null"
],
"example": 11.42
},
"transaction_id": {
"description": "The identifier assigned to document by the Tax Authority.",
"type": [
"string",
"null"
]
},
"document_number": {
"description": "The document number assigned to document by the Tax Authority.",
"type": [
"string",
"null"
]
},
"document_date": {
"type": [
"string",
"null"
],
"example": "2024-10-08 16:19:42"
}
}
},
"ReceiptDetailsItem": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id": {
"type": "string"
},
"quantity": {
"type": "number",
"example": 7.23
},
"description": {
"type": "string"
},
"gross_price": {
"type": "number",
"example": 7.23
},
"vat_rate": {
"type": "string",
"example": "22"
},
"gross_discount": {
"type": "number",
"example": 7.23
},
"complimentary": {
"type": "boolean"
},
"unit_price": {
"type": "number",
"example": 7.23
},
"return": {
"type": "number",
"example": 7.23
},
"taxable_amount": {
"type": [
"number",
"null"
],
"example": 7.23
},
"net_taxable_amount": {
"type": [
"number",
"null"
],
"example": 7.23
},
"vat_amount": {
"type": [
"number",
"null"
],
"example": 7.23
},
"total_amount": {
"type": [
"number",
"null"
],
"example": 7.23
},
"unit_discount": {
"type": [
"number",
"null"
],
"example": 7.23
}
}
},
"ReceiptDetailsItem.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"id": {
"type": "string"
},
"quantity": {
"type": "number",
"example": 7.23
},
"description": {
"type": "string"
},
"gross_price": {
"type": "number",
"example": 7.23
},
"vat_rate": {
"type": "string",
"example": "22"
},
"gross_discount": {
"type": "number",
"example": 7.23
},
"complimentary": {
"type": "boolean"
},
"unit_price": {
"type": "number",
"example": 7.23
},
"return": {
"type": "number",
"example": 7.23
},
"taxable_amount": {
"type": [
"number",
"null"
],
"example": 7.23
},
"net_taxable_amount": {
"type": [
"number",
"null"
],
"example": 7.23
},
"vat_amount": {
"type": [
"number",
"null"
],
"example": 7.23
},
"total_amount": {
"type": [
"number",
"null"
],
"example": 7.23
},
"unit_discount": {
"type": [
"number",
"null"
],
"example": 7.23
}
}
},
"ReceiptItem": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"quantity",
"description",
"unit_price",
"vat_rate_code"
],
"properties": {
"quantity": {
"exclusiveMinimum": 0,
"description": "Quantity expressed with 2 decimal digits.",
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"description": {
"maxLength": 1000,
"description": "Description of the item (max 1000 chars).",
"type": "string"
},
"unit_price": {
"exclusiveMinimum": 0,
"description": "Unit price expressed with up to 8 decimal digits. It is a gross price, i.e. it includes VAT amount.",
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"vat_rate_code": {
"enum": [
"4",
"5",
"10",
"22",
"2",
"6.4",
"7",
"7.3",
"7.5",
"7.65",
"7.95",
"8.3",
"8.5",
"8.8",
"9.5",
"12.3",
"N1",
"N2",
"N3",
"N4",
"N5",
"N6"
],
"description": "Vat rate code as a string.",
"default": "22",
"example": "22",
"type": "string"
},
"discount": {
"minimum": 0,
"description": "Discount amount in EUR with up to 8 decimal digits. It is a gross price, i.e. it includes VAT amount.",
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"complimentary": {
"description": "Set to true if it is a complimentary (free) item.",
"type": "boolean"
},
"total_amount": {
"readOnly": true,
"type": "string"
}
}
},
"ReceiptItem.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"quantity",
"description",
"unit_price",
"vat_rate_code"
],
"properties": {
"quantity": {
"exclusiveMinimum": 0,
"description": "Quantity expressed with 2 decimal digits.",
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"description": {
"maxLength": 1000,
"description": "Description of the item (max 1000 chars).",
"type": "string"
},
"unit_price": {
"exclusiveMinimum": 0,
"description": "Unit price expressed with up to 8 decimal digits. It is a gross price, i.e. it includes VAT amount.",
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"vat_rate_code": {
"enum": [
"4",
"5",
"10",
"22",
"2",
"6.4",
"7",
"7.3",
"7.5",
"7.65",
"7.95",
"8.3",
"8.5",
"8.8",
"9.5",
"12.3",
"N1",
"N2",
"N3",
"N4",
"N5",
"N6"
],
"description": "Vat rate code as a string.",
"default": "22",
"example": "22",
"type": "string"
},
"discount": {
"minimum": 0,
"description": "Discount amount in EUR with up to 8 decimal digits. It is a gross price, i.e. it includes VAT amount.",
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"complimentary": {
"description": "Set to true if it is a complimentary (free) item.",
"type": "boolean"
},
"total_amount": {
"readOnly": true,
"type": "string"
}
}
},
"ReceiptReturnItem": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"id",
"quantity"
],
"properties": {
"id": {
"type": [
"string",
"null"
]
},
"quantity": {
"minimum": 0,
"type": [
"number",
"null"
]
}
}
},
"ReceiptReturnItem.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"id",
"quantity"
],
"properties": {
"id": {
"type": [
"string",
"null"
]
},
"quantity": {
"minimum": 0,
"type": [
"number",
"null"
]
}
}
},
"RejectedInvoice.CountOutput": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"count": {
"type": "integer"
},
"pending": {
"type": "integer"
}
}
},
"RejectedInvoice.CountOutput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"count": {
"type": "integer"
},
"pending": {
"type": "integer"
}
}
},
"RejectedInvoice.RecoverInput": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"from_date",
"to_date"
],
"properties": {
"from_date": {
"externalDocs": {
"url": "https://schema.org/Date"
},
"type": "string"
},
"to_date": {
"externalDocs": {
"url": "https://schema.org/Date"
},
"type": "string"
},
"from_date_immutable": {
"readOnly": true,
"type": "string",
"format": "date-time"
},
"to_date_immutable": {
"readOnly": true,
"type": "string",
"format": "date-time"
}
}
},
"RejectedInvoice.RecoverInput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"from_date",
"to_date"
],
"properties": {
"from_date": {
"externalDocs": {
"url": "https://schema.org/Date"
},
"type": "string"
},
"to_date": {
"externalDocs": {
"url": "https://schema.org/Date"
},
"type": "string"
},
"from_date_immutable": {
"readOnly": true,
"type": "string",
"format": "date-time"
},
"to_date_immutable": {
"readOnly": true,
"type": "string",
"format": "date-time"
}
}
},
"RejectedInvoice.RecoverOutput": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"uuid": {
"type": "string",
"format": "uuid"
},
"count": {
"type": "integer"
}
}
},
"RejectedInvoice.RecoverOutput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"uuid": {
"type": "string",
"format": "uuid"
},
"count": {
"type": "integer"
}
}
},
"Schedule.LegacyScheduleInput": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"download_archive": {
"description": "If true, create an immediate job according to defaults for the job type",
"type": [
"boolean",
"null"
]
},
"auto_renew": {
"description": "Auto-renew flag (only applicable for INVOICE_DOWNLOAD)",
"type": [
"boolean",
"null"
]
},
"parameters": {
"description": "Additional parameters for the schedule which will be inherited by created jobs",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"Schedule.LegacyScheduleInput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"download_archive": {
"description": "If true, create an immediate job according to defaults for the job type",
"type": [
"boolean",
"null"
]
},
"auto_renew": {
"description": "Auto-renew flag (only applicable for INVOICE_DOWNLOAD)",
"type": [
"boolean",
"null"
]
},
"parameters": {
"description": "Additional parameters for the schedule which will be inherited by created jobs",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"Schedule.ScheduleInput": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"job_type": {
"description": "The type of job to schedule.",
"type": "string",
"enum": [
"invoice-download",
"invoice-report-download",
"invoice-zip-download"
]
},
"fiscal_id": {
"description": "The fiscal identifier associated with the job.",
"type": "string"
},
"parameters": {
"description": "The parameters specific to the job type."
}
}
},
"Schedule.ScheduleInput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"job_type": {
"description": "The type of job to schedule.",
"type": "string",
"enum": [
"invoice-download",
"invoice-report-download",
"invoice-zip-download"
]
},
"fiscal_id": {
"description": "The fiscal identifier associated with the job.",
"type": "string"
},
"parameters": {
"description": "The parameters specific to the job type."
}
}
},
"Schedule.UnifiedScheduleOutput": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"enabled": {
"description": "Whether a schedule exists for the given job type and fiscal id",
"type": "boolean"
},
"valid_until": {
"description": "Only for INVOICE_DOWNLOAD: subscription validity end date (if any)",
"type": [
"string",
"null"
]
},
"auto_renew": {
"description": "Only for INVOICE_DOWNLOAD: subscription auto-renew flag",
"type": [
"boolean",
"null"
]
}
}
},
"Schedule.UnifiedScheduleOutput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"enabled": {
"description": "Whether a schedule exists for the given job type and fiscal id",
"type": "boolean"
},
"valid_until": {
"description": "Only for INVOICE_DOWNLOAD: subscription validity end date (if any)",
"type": [
"string",
"null"
]
},
"auto_renew": {
"description": "Only for INVOICE_DOWNLOAD: subscription auto-renew flag",
"type": [
"boolean",
"null"
]
}
}
},
"ScontoMaggiorazione-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"tipo"
],
"properties": {
"tipo": {
"enum": [
"SC",
"MG"
],
"type": "string"
},
"percentuale": {
"minLength": 4,
"maxLength": 6,
"type": [
"string",
"null"
]
},
"importo": {
"minLength": 4,
"maxLength": 21,
"type": [
"string",
"null"
]
}
}
},
"SimpleCompany-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id": {
"description": "The company's VAT number or fiscal id",
"example": "10442360961",
"type": [
"string",
"null"
]
},
"fiscal_code": {
"example": "10442360961",
"type": [
"string",
"null"
]
},
"company_name": {
"example": "Company name",
"type": [
"string",
"null"
]
},
"registered_office": {
"anyOf": [
{
"$ref": "#/components/schemas/Address-read"
},
{
"type": "null"
}
]
},
"activity_status": {
"description": "The status of the company according to the Italian Chamber of Commerce",
"example": "ATTIVA",
"type": [
"string",
"null"
],
"enum": [
"ATTIVA",
"REGISTRATA",
"INATTIVA",
"SOSPESA",
"IN_ISCRIZIONE",
"CESSATA"
]
},
"last_update_timestamp": {
"example": 1589395200,
"type": [
"integer",
"null"
]
},
"recipient_code": {
"description": "The company's tax recipient code",
"example": "ABC1234",
"type": [
"string",
"null"
]
},
"gps": {
"description": "The GPS coordinates of the company's location",
"anyOf": [
{
"$ref": "#/components/schemas/Gps-read"
},
{
"type": "null"
}
]
},
"enrollment_date": {
"description": "The date of enrollment to the Italian Chamber of Commerce",
"example": "2018-01-01",
"type": [
"string",
"null"
]
}
}
},
"SimpleCompany.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"id": {
"description": "The company's VAT number or fiscal id",
"example": "10442360961",
"type": [
"string",
"null"
]
},
"fiscal_code": {
"example": "10442360961",
"type": [
"string",
"null"
]
},
"company_name": {
"example": "Company name",
"type": [
"string",
"null"
]
},
"registered_office": {
"anyOf": [
{
"$ref": "#/components/schemas/Address.jsonld-read"
},
{
"type": "null"
}
]
},
"activity_status": {
"description": "The status of the company according to the Italian Chamber of Commerce",
"example": "ATTIVA",
"type": [
"string",
"null"
],
"enum": [
"ATTIVA",
"REGISTRATA",
"INATTIVA",
"SOSPESA",
"IN_ISCRIZIONE",
"CESSATA"
]
},
"last_update_timestamp": {
"example": 1589395200,
"type": [
"integer",
"null"
]
},
"recipient_code": {
"description": "The company's tax recipient code",
"example": "ABC1234",
"type": [
"string",
"null"
]
},
"gps": {
"description": "The GPS coordinates of the company's location",
"anyOf": [
{
"$ref": "#/components/schemas/Gps.jsonld-read"
},
{
"type": "null"
}
]
},
"enrollment_date": {
"description": "The date of enrollment to the Italian Chamber of Commerce",
"example": "2018-01-01",
"type": [
"string",
"null"
]
}
}
},
"SistemaTSRequest-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id": {
"readOnly": true,
"type": "string",
"format": "uuid"
},
"protocol_id": {
"type": [
"string",
"null"
]
},
"esito_chiamata": {
"type": [
"integer",
"null"
]
},
"responses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SistemaTSResponse-read"
}
},
"requested_at": {
"readOnly": true,
"type": "string",
"format": "date-time"
},
"request_type": {
"description": "The request type",
"type": "string",
"enum": [
"inserimento",
"variazione",
"rimborso",
"cancellazione"
]
}
}
},
"SistemaTSRequest.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"id": {
"readOnly": true,
"type": "string",
"format": "uuid"
},
"protocol_id": {
"type": [
"string",
"null"
]
},
"esito_chiamata": {
"type": [
"integer",
"null"
]
},
"responses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SistemaTSResponse.jsonld-read"
}
},
"requested_at": {
"readOnly": true,
"type": "string",
"format": "date-time"
},
"request_type": {
"description": "The request type",
"type": "string",
"enum": [
"inserimento",
"variazione",
"rimborso",
"cancellazione"
]
}
}
},
"SistemaTSResponse-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id": {
"readOnly": true,
"type": "integer"
},
"received_at": {
"readOnly": true,
"type": "string",
"format": "date-time"
},
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"description": "Message type (E)rror, (W)arning or (S)uccess",
"type": "string",
"enum": [
"E",
"W",
"S"
]
}
}
},
"SistemaTSResponse.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"id": {
"readOnly": true,
"type": "integer"
},
"received_at": {
"readOnly": true,
"type": "string",
"format": "date-time"
},
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"description": "Message type (E)rror, (W)arning or (S)uccess",
"type": "string",
"enum": [
"E",
"W",
"S"
]
}
}
},
"Spesa": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"tipo_spesa",
"importo"
],
"properties": {
"tipo_spesa": {
"enum": [
"TK, FC, FV, AD, AS, SR, CT, PI, IC, SP, SV, AA"
],
"description": "The Expense type:\n- TK: Fixed fee and/or Difference with reference price. Deductible. First Aid and direct access)\n- FC: Medication, including homeopathic. EC Medical Devices\n- FV: Veterinary drug\n- AD: Purchase or rental of EC medical device\n- AS: Medical expenses related to ECG, spirometry, Holter pressure and heart rate, blood glucose, cholesterol and triglyceride tests or blood pressure measurement, services provided by the service pharmacy and similar)\n- SR: healthcare services: outpatient specialist care excluding cosmetic surgery; general and specialist medical examination or extrumental diagnostic services; surgical services excluding cosmetic surgery; medical certification; hospital admissions related to surgery or adjudication, excluding cosmetic surgery, net of comfort\n- CT: spa treatment\n- PI: prosthetic and integrative\n- IC: cosmetic surgery and aesthetic medicine services (out-patient or in-patient)\n- SP: Health benefits\n- SV: Veterinary expenses\n- AA: Other expenses.",
"type": "string"
},
"flag_tipo_spesa": {
"enum": [
1,
2
],
"description": "The field is valorised in order to in order to highlight particular characteristics of certain types of expenditure:\n- 1: with type TK (emergency ticket)\n- 2: with type SR (visit in intramoenia).",
"type": [
"integer",
"null"
]
},
"importo": {
"description": "Amount of each individual expense incurred by the citizen / refund granted to the citizen against an expense incurred. The field must always take positive values, even in the case of reimbursement (Value from 5 + 2 decimals).",
"type": "number"
},
"aliquota_iva": {
"exclusiveMinimum": 0,
"description": "VAT rate relative to the amount of the item of expenditure, to be set as an alternative for the field natura_iva. (Value of 2 + 2 decimals, e.g. 10.00).",
"type": [
"number",
"null"
]
},
"natura_iva": {
"minLength": 2,
"maxLength": 10,
"description": "Code of the VAT nature, to be set as an alternative of the field aliquota_iva. Values from N1 to N6 for tipo_documento = D (2 characters) or from N1 to N7 or subvalues for typeDocument = F (max 4 characters).",
"type": [
"string",
"null"
]
}
}
},
"Spesa.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"tipo_spesa",
"importo"
],
"properties": {
"tipo_spesa": {
"enum": [
"TK, FC, FV, AD, AS, SR, CT, PI, IC, SP, SV, AA"
],
"description": "The Expense type:\n- TK: Fixed fee and/or Difference with reference price. Deductible. First Aid and direct access)\n- FC: Medication, including homeopathic. EC Medical Devices\n- FV: Veterinary drug\n- AD: Purchase or rental of EC medical device\n- AS: Medical expenses related to ECG, spirometry, Holter pressure and heart rate, blood glucose, cholesterol and triglyceride tests or blood pressure measurement, services provided by the service pharmacy and similar)\n- SR: healthcare services: outpatient specialist care excluding cosmetic surgery; general and specialist medical examination or extrumental diagnostic services; surgical services excluding cosmetic surgery; medical certification; hospital admissions related to surgery or adjudication, excluding cosmetic surgery, net of comfort\n- CT: spa treatment\n- PI: prosthetic and integrative\n- IC: cosmetic surgery and aesthetic medicine services (out-patient or in-patient)\n- SP: Health benefits\n- SV: Veterinary expenses\n- AA: Other expenses.",
"type": "string"
},
"flag_tipo_spesa": {
"enum": [
1,
2
],
"description": "The field is valorised in order to in order to highlight particular characteristics of certain types of expenditure:\n- 1: with type TK (emergency ticket)\n- 2: with type SR (visit in intramoenia).",
"type": [
"integer",
"null"
]
},
"importo": {
"description": "Amount of each individual expense incurred by the citizen / refund granted to the citizen against an expense incurred. The field must always take positive values, even in the case of reimbursement (Value from 5 + 2 decimals).",
"type": "number"
},
"aliquota_iva": {
"exclusiveMinimum": 0,
"description": "VAT rate relative to the amount of the item of expenditure, to be set as an alternative for the field natura_iva. (Value of 2 + 2 decimals, e.g. 10.00).",
"type": [
"number",
"null"
]
},
"natura_iva": {
"minLength": 2,
"maxLength": 10,
"description": "Code of the VAT nature, to be set as an alternative of the field aliquota_iva. Values from N1 to N6 for tipo_documento = D (2 characters) or from N1 to N7 or subvalues for typeDocument = F (max 4 characters).",
"type": [
"string",
"null"
]
}
}
},
"SplitpaymentCompany": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id": {
"description": "The company's fiscal id or VAT number",
"type": [
"string",
"null"
],
"example": "10442360961"
},
"company_name": {
"description": "The company's name",
"type": [
"string",
"null"
],
"example": "denominazione"
},
"enrollment_date": {
"description": "The company's enrollment date to split-payment timestamp",
"type": [
"string",
"null"
],
"example": "1605031159"
},
"category": {
"description": "The company's category",
"type": [
"string",
"null"
],
"example": "categoria"
},
"update_timestamp": {
"type": [
"integer",
"null"
],
"example": 1605031159
}
}
},
"SplitpaymentCompany.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"id": {
"description": "The company's fiscal id or VAT number",
"type": [
"string",
"null"
],
"example": "10442360961"
},
"company_name": {
"description": "The company's name",
"type": [
"string",
"null"
],
"example": "denominazione"
},
"enrollment_date": {
"description": "The company's enrollment date to split-payment timestamp",
"type": [
"string",
"null"
],
"example": "1605031159"
},
"category": {
"description": "The company's category",
"type": [
"string",
"null"
],
"example": "categoria"
},
"update_timestamp": {
"type": [
"integer",
"null"
],
"example": 1605031159
}
}
},
"SupplierInvoiceImport.SupplierInvoiceImportInput": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"invoice"
],
"properties": {
"invoice": {
"description": "The base64 encoded invoice XML or P7M.",
"type": "string"
},
"metadata": {
"description": "The base64 encoded invoice metadata XML. If it is not provided you must provide invoice_file_name and sdi_id.",
"type": "boolean"
},
"invoice_file_name": {
"description": "The invoice filename, to be provided only when there is not metadata.",
"type": "string"
},
"sdi_id": {
"description": "he invoice SDI ID, to be provided only when there is not metadata.",
"type": "string"
}
}
},
"SupplierInvoiceImport.SupplierInvoiceImportInput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"invoice"
],
"properties": {
"invoice": {
"description": "The base64 encoded invoice XML or P7M.",
"type": "string"
},
"metadata": {
"description": "The base64 encoded invoice metadata XML. If it is not provided you must provide invoice_file_name and sdi_id.",
"type": "boolean"
},
"invoice_file_name": {
"description": "The invoice filename, to be provided only when there is not metadata.",
"type": "string"
},
"sdi_id": {
"description": "he invoice SDI ID, to be provided only when there is not metadata.",
"type": "string"
}
}
},
"SupplierInvoiceImport.SupplierInvoiceImportOutput": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"uuid": {
"description": "The UUID used to identify uniquely the invoice. In case the invoice XML embeds multiple bodies, you will get an array of UUIDs.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
}
}
},
"SupplierInvoiceImport.SupplierInvoiceImportOutput.jsonld": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"uuid": {
"description": "The UUID used to identify uniquely the invoice. In case the invoice XML embeds multiple bodies, you will get an array of UUIDs.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
}
}
},
"TerzoIntermediarioSoggettoEmittente-write": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"dati_anagrafici"
],
"properties": {
"dati_anagrafici": {
"$ref": "#/components/schemas/DatiAnagraficiTerzoIntermediario-write"
}
}
},
"UserEntity-read-accept-only": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"accept_only_verified_supplier_invoices": {
"type": [
"boolean",
"null"
]
}
}
},
"UserEntity-read_setting": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"apply_signature": {
"type": "boolean"
},
"apply_legal_storage": {
"type": "boolean"
},
"accept_only_verified_supplier_invoices": {
"type": [
"boolean",
"null"
]
},
"do_not_require_fiscal_id_registration_to_preserve": {
"type": [
"boolean",
"null"
]
},
"require_signature_to_preserve": {
"default": true,
"example": true,
"type": "boolean"
},
"statistics_scope": {
"default": "year",
"example": "year",
"type": "string"
},
"invoice_filename": {
"type": [
"string",
"null"
]
},
"invoice_filename_base": {
"type": [
"string",
"null"
]
}
}
},
"UserEntity-write-accept-only": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"accept_only_verified_supplier_invoices": {
"type": [
"boolean",
"null"
]
}
}
},
"UserEntity.UserRecipientCodeOutput-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"recipient_code": {
"type": [
"string",
"null"
]
}
}
},
"UserEntity.UserRecipientCodeOutput.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"recipient_code": {
"type": [
"string",
"null"
]
}
}
},
"UserEntity.jsonld-read-accept-only": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"accept_only_verified_supplier_invoices": {
"type": [
"boolean",
"null"
]
}
}
},
"UserEntity.jsonld-read_setting": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"apply_signature": {
"type": "boolean"
},
"apply_legal_storage": {
"type": "boolean"
},
"accept_only_verified_supplier_invoices": {
"type": [
"boolean",
"null"
]
},
"do_not_require_fiscal_id_registration_to_preserve": {
"type": [
"boolean",
"null"
]
},
"require_signature_to_preserve": {
"default": true,
"example": true,
"type": "boolean"
},
"statistics_scope": {
"default": "year",
"example": "year",
"type": "string"
},
"invoice_filename": {
"type": [
"string",
"null"
]
},
"invoice_filename_base": {
"type": [
"string",
"null"
]
}
}
},
"UserEntity.jsonld-write-accept-only": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"accept_only_verified_supplier_invoices": {
"type": [
"boolean",
"null"
]
}
}
},
"VatGroup-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"participation": {
"description": "Indicates if the company has participation",
"type": [
"boolean",
"null"
]
},
"is_head_of_group": {
"description": "Indicates if the company is the head of a group (based on VAT number)",
"type": [
"boolean",
"null"
]
},
"is_data_validated": {
"description": "Indicates if the company's data is validated",
"type": [
"boolean",
"null"
]
}
}
},
"VatGroup.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"participation": {
"description": "Indicates if the company has participation",
"type": [
"boolean",
"null"
]
},
"is_head_of_group": {
"description": "Indicates if the company is the head of a group (based on VAT number)",
"type": [
"boolean",
"null"
]
},
"is_data_validated": {
"description": "Indicates if the company's data is validated",
"type": [
"boolean",
"null"
]
}
}
},
"draft.InvoiceSimplifiedDraftInput-write": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"fattura_elettronica_header": {
"anyOf": [
{
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.FatturaElettronicaHeader-write"
},
{
"type": "null"
}
]
},
"fattura_elettronica_body": {
"minItems": 0,
"maxItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/FatturaElettronicaSemplificata.FatturaElettronicaBody-write"
}
}
}
},
"draft.InvoiceSimplifiedOutput-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"uuid": {
"type": "string"
}
}
},
"draft.InvoiceSimplifiedOutput.jsonld-read": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"@context": {
"readOnly": true,
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"@vocab": {
"type": "string"
},
"hydra": {
"type": "string",
"enum": [
"http://www.w3.org/ns/hydra/core#"
]
}
},
"required": [
"@vocab",
"hydra"
],
"additionalProperties": true
}
]
},
"@id": {
"readOnly": true,
"type": "string"
},
"@type": {
"readOnly": true,
"type": "string"
},
"uuid": {
"type": "string"
}
}
}
},
"responses": {},
"parameters": {},
"examples": {},
"requestBodies": {},
"headers": {},
"securitySchemes": {
"Bearer": {
"type": "apiKey",
"description": "Value for the Authorization header parameter.",
"name": "Authorization",
"in": "header"
}
}
},
"security": [
{
"Bearer": []
}
],
"tags": [],
"webhooks": {},
"x-logo": {
"url": "https://www.acubeapi.com/logo.svg"
},
"x-tagGroups": [
{
"name": "Platform",
"tags": [
"ApiConfiguration",
"BusinessRegistry",
"BusinessRegistryConfiguration",
"Schedule",
"Job"
]
},
{
"name": "Invoice",
"tags": [
"Invoice",
"InvoiceSimplified",
"InvoiceExtraSDI",
"Notification",
"CustomerInvoiceImport",
"SupplierInvoiceImport",
"InvoiceStats",
"InvoiceExtract",
"InvoiceTransfer",
"RejectedInvoice",
"NumberingSequence"
]
},
{
"name": "Legal Storage",
"tags": [
"PreservedDocument",
"PreservedDocumentReceipt"
]
},
{
"name": "Sistema Tessera Sanitaria",
"tags": [
"Expense"
]
},
{
"name": "Verify",
"tags": [
"FiscalIdValidity",
"Company",
"SimpleCompany",
"SplitpaymentCompany"
]
}
]
}