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
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
string

The fiscal code or the vat number WITHOUT the country prefix

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.

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,
  • "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,
  • "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

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,
  • "apply_signature": true,
  • "apply_legal_storage": true,
  • "legal_storage_active": true,
  • "api_configurations": [
    ]
}

Replaces the BusinessRegistryConfiguration resource.

Update the business registry configuration for the provided fiscal identifier

SecurityBearer
Request
path Parameters
id
required
string

The fiscal identifier

Request Body schema:

The updated BusinessRegistryConfiguration resource

fiscal_id
string

The fiscal code or the vat number WITHOUT the country prefix

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.

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,
  • "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,
  • "apply_signature": true,
  • "apply_legal_storage": true,
  • "legal_storage_active": true,
  • "api_configurations": [
    ]
}

Removes the BusinessRegistryConfiguration resource.

Delete the business registry configuration for the provided fiscal identifier

SecurityBearer
Request
path Parameters
id
required
string

The fiscal identifier

Responses
204

BusinessRegistryConfiguration resource deleted

404

Resource not found

delete/business-registry-configurations/{id}
Request samples

Reset legal storage portal password.

Ask to reset legal storage portal password for the provided fiscal identifier

SecurityBearer
Request
path Parameters
id
required
string
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
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
Request Body schema: application/json

The new BusinessRegistryConfiguration resource

email
required
string

Email of the sub account

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
email
required
string
Responses
204

BusinessRegistryConfiguration resource deleted

404

Resource not found

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