Update the fiscal profile

curl --request PATCH \
  --url https://api.melso.ai/v1/companies/{company_id}/fiscal-profile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tax_id": "12345678Z",
  "legal_name": "Lucía Martín Pérez",
  "address": "Calle Mayor 1",
  "postal_code": "50001",
  "activity_type": "profesional",
  "iae_code": "844",
  "registration_status": "alta",
  "registered_on": "2024-03",
  "irpf_method": "directa_simplificada",
  "vat_regime": "general",
  "client_types": [
    "es_business"
  ]
}
'

import requests

url = "https://api.melso.ai/v1/companies/{company_id}/fiscal-profile"

payload = {
    "tax_id": "12345678Z",
    "legal_name": "Lucía Martín Pérez",
    "address": "Calle Mayor 1",
    "postal_code": "50001",
    "activity_type": "profesional",
    "iae_code": "844",
    "registration_status": "alta",
    "registered_on": "2024-03",
    "irpf_method": "directa_simplificada",
    "vat_regime": "general",
    "client_types": ["es_business"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    tax_id: '12345678Z',
    legal_name: 'Lucía Martín Pérez',
    address: 'Calle Mayor 1',
    postal_code: '50001',
    activity_type: 'profesional',
    iae_code: '844',
    registration_status: 'alta',
    registered_on: '2024-03',
    irpf_method: 'directa_simplificada',
    vat_regime: 'general',
    client_types: ['es_business']
  })
};

fetch('https://api.melso.ai/v1/companies/{company_id}/fiscal-profile', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "profile": {
    "tax_id": "<string>",
    "legal_name": "<string>",
    "trade_name": "<string>",
    "address": "<string>",
    "postal_code": "<string>",
    "city": "<string>",
    "province": "<string>",
    "tax_territory": "comun",
    "vat_regime": "general",
    "activity_type": "profesional",
    "activity_description": "<string>",
    "iae_code": "<string>",
    "registration_status": "alta",
    "registered_on": "<string>",
    "irpf_method": "directa_simplificada",
    "irpf_retention_rate": 50,
    "eu_operator": true,
    "vat_sii": true,
    "vat_redeme": true,
    "is_large_company": true,
    "client_types": [
      "es_business"
    ],
    "invoice_series": "<string>",
    "next_invoice_number": 500000000,
    "iban": "<string>",
    "tax_id_type": "dni"
  },
  "missing": [
    "<string>"
  ],
  "errors": {},
  "deduced": {},
  "invoice_missing": [
    "<string>"
  ],
  "tax_missing": [
    "<string>"
  ]
}

{
  "error": "lines[0].vat_rate must be 21, 10, 4 or 0",
  "code": "invalid_invoice",
  "request_id": "req_01JAB3K9X2"
}

{
  "error": "invalid token",
  "code": "unauthorized",
  "request_id": "req_01JAB3K9X2"
}

{
  "error": "invoice not found",
  "code": "not_found",
  "request_id": "req_01JAB3K9X2"
}

PATCH

companies

{company_id}

fiscal-profile

Update the fiscal profile

curl --request PATCH \
  --url https://api.melso.ai/v1/companies/{company_id}/fiscal-profile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tax_id": "12345678Z",
  "legal_name": "Lucía Martín Pérez",
  "address": "Calle Mayor 1",
  "postal_code": "50001",
  "activity_type": "profesional",
  "iae_code": "844",
  "registration_status": "alta",
  "registered_on": "2024-03",
  "irpf_method": "directa_simplificada",
  "vat_regime": "general",
  "client_types": [
    "es_business"
  ]
}
'

import requests

url = "https://api.melso.ai/v1/companies/{company_id}/fiscal-profile"

payload = {
    "tax_id": "12345678Z",
    "legal_name": "Lucía Martín Pérez",
    "address": "Calle Mayor 1",
    "postal_code": "50001",
    "activity_type": "profesional",
    "iae_code": "844",
    "registration_status": "alta",
    "registered_on": "2024-03",
    "irpf_method": "directa_simplificada",
    "vat_regime": "general",
    "client_types": ["es_business"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    tax_id: '12345678Z',
    legal_name: 'Lucía Martín Pérez',
    address: 'Calle Mayor 1',
    postal_code: '50001',
    activity_type: 'profesional',
    iae_code: '844',
    registration_status: 'alta',
    registered_on: '2024-03',
    irpf_method: 'directa_simplificada',
    vat_regime: 'general',
    client_types: ['es_business']
  })
};

fetch('https://api.melso.ai/v1/companies/{company_id}/fiscal-profile', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "profile": {
    "tax_id": "<string>",
    "legal_name": "<string>",
    "trade_name": "<string>",
    "address": "<string>",
    "postal_code": "<string>",
    "city": "<string>",
    "province": "<string>",
    "tax_territory": "comun",
    "vat_regime": "general",
    "activity_type": "profesional",
    "activity_description": "<string>",
    "iae_code": "<string>",
    "registration_status": "alta",
    "registered_on": "<string>",
    "irpf_method": "directa_simplificada",
    "irpf_retention_rate": 50,
    "eu_operator": true,
    "vat_sii": true,
    "vat_redeme": true,
    "is_large_company": true,
    "client_types": [
      "es_business"
    ],
    "invoice_series": "<string>",
    "next_invoice_number": 500000000,
    "iban": "<string>",
    "tax_id_type": "dni"
  },
  "missing": [
    "<string>"
  ],
  "errors": {},
  "deduced": {},
  "invoice_missing": [
    "<string>"
  ],
  "tax_missing": [
    "<string>"
  ]
}

{
  "error": "lines[0].vat_rate must be 21, 10, 4 or 0",
  "code": "invalid_invoice",
  "request_id": "req_01JAB3K9X2"
}

{
  "error": "invalid token",
  "code": "unauthorized",
  "request_id": "req_01JAB3K9X2"
}

{
  "error": "invoice not found",
  "code": "not_found",
  "request_id": "req_01JAB3K9X2"
}

Live capability. Melso runs this in production today. Partner keys reach it once your partner account is enabled. See Availability.

A field that fails validation is reported in errors and the valid fields are still saved, so the response is 200 either way: read errors. A postal code fills in the province and the tax territory (deduced).

Authorizations

Authorization

string

header

required

Your partner secret key, mk_live_… for real companies or mk_test_… for test companies. Keep it on your servers. See Authentication.

Path Parameters

company_id

string<uuid>

required

The company's ID. Every company-scoped call works in exactly this company.

Body

application/json

tax_id

string

DNI or NIE for an autónomo, CIF for an empresa, with a valid check character.

legal_name

string

Maximum string length: 300

trade_name

string

Maximum string length: 300

address

string

Maximum string length: 300

postal_code

string

Fills in province and tax_territory.

Pattern: ^[0-9]{5}$

city

string

Maximum string length: 300

province

string

Maximum string length: 300

tax_territory

enum<string>

Available options:

comun,

alava,

bizkaia,

gipuzkoa,

navarra,

canarias,

ceuta,

melilla

vat_regime

enum<string>

Must fit the tax territory.

Available options:

general,

recargo_equivalencia,

simplificado,

reagp,

exento,

igic_general,

igic_simplificado,

igic_repep,

ipsi

activity_type

enum<string>

An empresa is always empresarial.

Available options:

profesional,

empresarial

activity_description

string

Maximum string length: 300

iae_code

string

Pattern: ^[0-9]{1,4}(\.[0-9]{1,2})?$

registration_status

enum<string>

pendiente while the autónomo is not registered yet.

Available options:

alta,

pendiente

registered_on

string

YYYY-MM or YYYY-MM-DD, not in the future.

irpf_method

enum<string>

Autónomos only.

Available options:

directa_simplificada,

directa_normal,

modulos

irpf_retention_rate

number

Autónomos only.

Required range: 0 <= x <= 100

eu_operator

boolean

Registered in the ROI for intra-community operations.

vat_sii

boolean

Keeps its VAT books through the SII.

vat_redeme

boolean

Registered for monthly VAT refunds.

is_large_company

boolean

Gran empresa

client_types

enum<string>[]

Minimum array length: 1

Available options:

es_business,

es_individual,

eu_business,

non_eu_business

invoice_series

string

Maximum string length: 40

next_invoice_number

integer

Required range: 1 <= x <= 1000000000

iban

string

Returned masked.

clear

string[]

Fields to empty.

Response

The whole profile, with errors for any field not saved.

profile

object

required

Show child attributes

missing

string[]

required

errors

object

The fields not saved, each with the reason.

Show child attributes

deduced

object

Fields Melso filled in from others, such as the territory from the postal code.

invoice_missing

string[]

What is still needed to invoice.

tax_missing

string[]

What is still needed to calculate returns.

Get started

Solutions

Companies and access

Invoicing

Bookkeeping

Taxes

Payroll and Social Security

Update the fiscal profile

Authorizations

Path Parameters

Body

Response