v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

Fiscalization

Validate fiscalization registration data

Validates party data against country-specific fiscalization rules based on the $regime field

post/fiscal-document/v1/fiscalization/registration/validate

Request body

partnerIdinteger

Optional scope to a specific partner instance on a multi-partner property. Omit on single-partner properties (legacy behavior).

countrystring required

ISO 3166-1 alpha-2 country code

namestring required

Legal name of the company

taxIdstring

Primary tax identification number

identitiesobject

Additional tax/legal identities (key-value pairs)

extensionsobject

Country-specific tax configuration. Known MX keys: mx_border_zone ("true"/"false") — set to "true" for properties in Mexico's northern border zone where IVA is 8% instead of 16%.

Example request

{
  "country": "IT",
  "name": "Mario Rossi Albergo",
  "taxId": "98765432103",
  "addresses": [
    {
      "street": "Via Roma 123",
      "number": "123",
      "locality": "Centro",
      "region": "Milan",
      "state": "MI",
      "postalCode": "20121",
      "country": "IT"
    }
  ],
  "emails": [
    {
      "address": "fatture@hotel-italia.it",
      "label": "Invoicing"
    }
  ],
  "phones": [
    {
      "number": "+39 02 1234567",
      "label": "Office"
    }
  ],
  "identities": {
    "it-fiscal-code": "98765432103"
  },
  "extensions": {
    "it-regime-fiscale": "RF07",
    "it-sdi-format": "FPR12",
    "mx_border_zone": "true"
  }
}

Response

Validation completed

validboolean required

Whether the data is valid

Example response

{
  "errors": [
    {
      "message": "One or more fields failed validation",
      "code": "VALIDATION_ERROR",
      "timestamp": "2024-01-15T10:30:45.123Z",
      "fieldErrors": [
        {
          "field": "email",
          "message": "must be a well-formed email address (provided: 'invalid-email')"
        }
      ]
    }
  ],
  "warnings": [
    {
      "message": "One or more fields failed validation",
      "code": "VALIDATION_ERROR",
      "timestamp": "2024-01-15T10:30:45.123Z",
      "fieldErrors": [
        {
          "field": "email",
          "message": "must be a well-formed email address (provided: 'invalid-email')"
        }
      ]
    }
  ]
}