BusinessRegistryConfiguration

Retrieves the collection of BusinessRegistryConfiguration resources.

SecurityBearer
Request
query Parameters
fiscal_id
string
fiscal_id[]
Array of strings
email
string
name
string
supplier_invoice_enabled
boolean
apply_signature
boolean
apply_legal_storage
boolean
legal_storage_active
boolean
receipts_enabled
boolean
page
integer

The collection page number

Responses
200

BusinessRegistryConfiguration collection response

get/business-registry-configurations
Request samples 
Response samples 
[
  • {
    }
]
Creates a BusinessRegistryConfiguration resource.
SecurityBearer 
Request 
Request Body schema: 
The new BusinessRegistryConfiguration resource


fiscal_id
required
string
The fiscal code or the vat number WITHOUT the country prefix. It should not be empty.


 
name
string
The owner's name for the fiscal id.


 
email
string
The email where the owner of the fiscalId will receive communications from the platform.


 
supplier_invoice_enabled
boolean
The fiscal id is enabled to received supplier invoices.


 
receipts_enabled
boolean
Enable receipt service.


 
apply_signature
boolean
Apply digital signature before sending invoices to SDI.


 
apply_legal_storage
boolean
Apply the legal storage for invoices sent/received by the fiscal id.


 
Array of objects (ApiConfiguration-write) 
 
Responses 
201
BusinessRegistryConfiguration resource created


400
Invalid input


404
Resource not found


post/business-registry-configurations
Request samples 
{
  • "fiscal_id": "string",
  • "name": "string",
  • "email": "string",
  • "supplier_invoice_enabled": true,
  • "receipts_enabled": true,
  • "apply_signature": true,
  • "apply_legal_storage": true,
  • "api_configurations": [
    ]
}
Response samples 
{
  • "fiscal_id": "string",
  • "name": "string",
  • "email": "string",
  • "email_for_preservation_requested_at": "2019-08-24T14:15:22Z",
  • "supplier_invoice_enabled": true,
  • "receipts_enabled": true,
  • "apply_signature": true,
  • "apply_legal_storage": true,
  • "legal_storage_active": true,
  • "api_configurations": [
    ]
}
Retrieves a BusinessRegistryConfiguration resource.
Retrieve the business registry configuration for the provided fiscal identifier


SecurityBearer 
Request 
path Parameters
id
required
string
The fiscal identifier of the Business Registry


 
Responses 
200
BusinessRegistryConfiguration resource response


404
Resource not found


get/business-registry-configurations/{id}
Request samples 
Response samples 
{
  • "fiscal_id": "string",
  • "name": "string",
  • "email": "string",
  • "email_for_preservation_requested_at": "2019-08-24T14:15:22Z",
  • "supplier_invoice_enabled": true,
  • "receipts_enabled": true,
  • "apply_signature": true,
  • "apply_legal_storage": true,
  • "legal_storage_active": true,
  • "api_configurations": [
    ]
}
Updates the business registry configuration for the provided fiscal identifier
SecurityBearer 
Request 
path Parameters
id
required
string
The fiscal identifier of the Business Registry


 
Request Body schema: 
The updated BusinessRegistryConfiguration resource


fiscal_id
required
string
The fiscal code or the vat number WITHOUT the country prefix. It should not be empty.


 
name
string
The owner's name for the fiscal id.


 
email
string
The email where the owner of the fiscalId will receive communications from the platform.


 
supplier_invoice_enabled
boolean
The fiscal id is enabled to received supplier invoices.


 
receipts_enabled
boolean
Enable receipt service.


 
apply_signature
boolean
Apply digital signature before sending invoices to SDI.


 
apply_legal_storage
boolean
Apply the legal storage for invoices sent/received by the fiscal id.


 
Array of objects (ApiConfiguration-write) 
 
Responses 
200
BusinessRegistryConfiguration resource updated


400
Invalid input


404
Resource not found


put/business-registry-configurations/{id}
Request samples 
{
  • "fiscal_id": "string",
  • "name": "string",
  • "email": "string",
  • "supplier_invoice_enabled": true,
  • "receipts_enabled": true,
  • "apply_signature": true,
  • "apply_legal_storage": true,
  • "api_configurations": [
    ]
}
Response samples 
{
  • "fiscal_id": "string",
  • "name": "string",
  • "email": "string",
  • "email_for_preservation_requested_at": "2019-08-24T14:15:22Z",
  • "supplier_invoice_enabled": true,
  • "receipts_enabled": true,
  • "apply_signature": true,
  • "apply_legal_storage": true,
  • "legal_storage_active": true,
  • "api_configurations": [
    ]
}
Removes the BusinessRegistryConfiguration resource.
Please note that you cannot delete a BRC that is connected to other entities, such as invoices or receipts. Check the HTTP status code (which has to be 204) to be sure you sucessfully deleted the BRC.


SecurityBearer 
Request 
path Parameters
id
required
string
The fiscal identifier of the Business Registry


 
Responses 
204
BusinessRegistryConfiguration resource deleted


404
Resource not found


delete/business-registry-configurations/{id}
Request samples 
Appoint A-Cube to use the receipt services.
Appoint A-Cube to use the receipt services on the Agenzia delle Entrate portal using FiscOnline / Entratel credentials


SecurityBearer 
Request 
path Parameters
id
required
string
The fiscal identifier of the Business Registry


 
Request Body schema: 
The updated BusinessRegistryConfiguration resource


appointee_fiscal_id
required
string
The appointee fiscal id. The special value A-CUBE tells that the A-Cube default fiscal id will be used.


 
codice_fiscale
required
string
 
password
required
string
 
pin
required
string
 
Responses 
204
OK


400
Bad request


403
Forbidden


404
Not found


422
Wrong credentials


put/business-registry-configurations/{id}/appoint/fisconline
Request samples 
{
  • "appointee_fiscal_id": "string",
  • "codice_fiscale": "string",
  • "password": "string",
  • "pin": "string"
}
Appoint a 3rd party person to use the receipt services on the Agenzia delle Entrate portal with SPID credentials
Appoint a 3rd party person to use the receipt services on the Agenzia delle Entrate portal with SPID credentials


SecurityBearer 
Request 
path Parameters
id
required
string
The fiscal identifier of the Business Registry


 
Request Body schema: 
The updated BusinessRegistryConfiguration resource


appointee_fiscal_id
required
string
The appointee fiscal id. The special value A-CUBE tells that the A-Cube default fiscal id will be used.


 
required
object (AppointingPersonData) 
 
return_url
Responses 
201
Created


400
Bad request


403
Forbidden


404
Not found


422
Wrong credentials


put/business-registry-configurations/{id}/appoint/spid
Request samples 
{
  • "appointee_fiscal_id": "string",
  • "appointing_person_data": {
    },
  • "return_url": "string"
}
Response samples 
{}
Gets the status of an appointing request
Gets the status of an appointing request


SecurityBearer 
Request 
path Parameters
id
required
string
The fiscal identifier of the Business Registry


 
Responses 
200
BusinessRegistryConfigurationAppointStatusOutput resource response


404
Resource not found


get/business-registry-configurations/{id}/appoint/status
Request samples 
Response samples 
{
  • "receipt_enabled": true,
  • "appointee": "string",
  • "status": "string",
  • "url": "string"
}
Set new Agenzia delle Entrate credentials.
Update the credentials to access the Agenzia delle Entrate portal (FiscOnline / Entratel)


SecurityBearer 
Request 
path Parameters
id
required
string
The fiscal identifier of the Business Registry


 
Request Body schema: 
The updated BusinessRegistryConfiguration resource


codice_fiscale
required
string
 
password
required
string
 
pin
required
string
 
Responses 
204
OK


400
Bad request


403
Forbidden


404
Not found


422
Wrong credentials


put/business-registry-configurations/{id}/credentials/fisconline
Request samples 
{
  • "codice_fiscale": "string",
  • "password": "string",
  • "pin": "string"
}
Gets settings related to Smart Receipts
SecurityBearer 
Request 
path Parameters
id
required
string
The fiscal identifier of the Business Registry


 
Responses 
200
ReceiptSettingsOutput resource response


404
Resource not found


get/business-registry-configurations/{id}/receipt-settings
Request samples 
Response samples 
application/json
{
  • "receipts_alert_recipients": null,
  • "phone_number": "string"
}
Updates settings related to Smart Receipts
SecurityBearer 
Request 
path Parameters
id
required
string
The fiscal identifier of the Business Registry


 
Request Body schema: application/json
The updated BusinessRegistryConfiguration resource


receipts_alert_recipients
Array of strings
The list of email recipients for communications related to AdE technical problems. For example "receipts_alert_recipients": ["foo@bar.com", "baz@bar.com"].


 
phone_number
required
string
The mobile phone number used to reset password (with +xx international prefix).


 
Responses 
200
BusinessRegistryConfiguration resource updated


400
Invalid input


404
Resource not found


put/business-registry-configurations/{id}/receipt-settings
Request samples 
application/json
{
  • "receipts_alert_recipients": [
    ],
  • "phone_number": "string"
}
Response samples 
application/json
{
  • "receipts_alert_recipients": null,
  • "phone_number": "string"
}
Gets reporting parameters for a business registry
SecurityBearer 
Request 
path Parameters
id
required
string
The fiscal identifier of the Business Registry


 
Responses 
200
ReportingOutput resource response


404
Resource not found


get/business-registry-configurations/{id}/reporting
Request samples 
Response samples 
application/json
{
  • "rejected_invoices_alert_schedule": null
}
Replaces reporting parameters for a business registry
SecurityBearer 
Request 
path Parameters
id
required
string
 
Request Body schema: application/json
The updated BusinessRegistryConfiguration resource


object (BusinessRegistryConfiguration_aa00db10cc6f5070518b1fa8d166a3b9-write) 
 
Responses 
200
BusinessRegistryConfiguration resource updated


400
Invalid input


404
Resource not found


put/business-registry-configurations/{id}/reporting
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "rejected_invoices_alert_schedule": null
}
Reset legal storage portal password.
Ask to reset legal storage portal password for the provided fiscal identifier


SecurityBearer 
Request 
path Parameters
id
required
string
The fiscal identifier of the Business Registry


 
Responses 
200
OK


403
Forbidden


404
Not found


get/business-registry-configurations/{id}/reset-legal-storage-password
Request samples 
List all sub accounts connected to the provided fiscal identifier
SecurityBearer 
Request 
path Parameters
id
required
string
The fiscal identifier of the Business Registry


 
Responses 
200
SubAccountOutput resource response


404
Resource not found


get/business-registry-configurations/{id}/sub-accounts
Request samples 
Response samples 
application/json
{
  • "email": "string"
}
Add a new sub account to the provided fiscal identifier
SecurityBearer 
Request 
path Parameters
id
required
string
The fiscal identifier of the Business Registry


 
Request Body schema: application/json
The new BusinessRegistryConfiguration resource


email
required
string
Email of the sub account


 
http://schema.org/email
password
string
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.


 
Responses 
201
BusinessRegistryConfiguration resource created


400
Invalid input


404
Resource not found


post/business-registry-configurations/{id}/sub-accounts
Request samples 
application/json
{
  • "email": "string",
  • "password": "string"
}
Response samples 
application/json
{
  • "email": "string"
}
Remove a sub account from the provided fiscal identifier
SecurityBearer 
Request 
path Parameters
id
required
string
The fiscal identifier of the Business Registry


 
email
required
string
 
Responses 
204
BusinessRegistryConfiguration resource deleted


404
Resource not found


delete/business-registry-configurations/{id}/sub-accounts/{email}
Request samples