object TaxDeclarationIndividual
{
  "type": "object",
  "title": "Individual Tax Declaration",
  "required": [
    "id",
    "link",
    "collected_at",
    "created_at",
    "document_information",
    "tax_payer_information",
    "equity_statement",
    "annual_income_statement",
    "pension_income_statement",
    "tax_assessment",
    "date_issued",
    "pdf"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "example": "1c83ead8-6665-429c-a17a-ddc76cb3a95e",
      "description": "Belvo's unique ID for the current tax declaration."
    },
    "pdf": {
      "type": "string",
      "example": "==BINARY-STRING==",
      "nullable": true,
      "description": "The PDF of the tax declaration, as a binary string."
    },
    "link": {
      "type": "string",
      "format": "uuid",
      "example": "8a95ca1a-1a7a-4ce0-8599-f8ff1dc792ac",
      "description": "Belvo's unique ID of the user that this tax declaration is associated with."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2020-04-23T21:30:20.336854+00:00",
      "description": "The ISO-8601 timestamp of when the data point was last updated in Belvo's database."
    },
    "date_issued": {
      "type": "string",
      "format": "date",
      "example": "2022-09-02",
      "description": "The date the tax declaration was issued by the fiscal institution."
    },
    "collected_at": {
      "type": "string",
      "format": "date-time",
      "example": "2020-04-23T21:32:55.336854+00:00",
      "description": "The ISO-8601 timestamp when the data point was collected."
    },
    "tax_assessment": {
      "$ref": "#/components/schemas/TaxAssessmentIndividual"
    },
    "equity_statement": {
      "$ref": "#/components/schemas/EquityStatementIndividual"
    },
    "document_information": {
      "$ref": "#/components/schemas/DocumentInformationIndividual"
    },
    "tax_payer_information": {
      "$ref": "#/components/schemas/TaxPayerInformationIndividual"
    },
    "annual_income_statement": {
      "$ref": "#/components/schemas/AnnualIncomeStatementIndividual"
    },
    "pension_income_statement": {
      "$ref": "#/components/schemas/PensionIncomeStatementIndividual"
    }
  }
}
object TaxDeclarationIndividualPaginated
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/common_pagination_properties"
    },
    {
      "properties": {
        "results": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/TaxDeclarationIndividual"
          },
          "description": "Array of Individual Tax Declaration objects."
        }
      }
    }
  ],
  "title": "Tax Declaration Individual"
}
array TaxDeclarationsDeleteSpecificDeclaration404Response
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/NotFoundError"
  },
  "description": "You made a request where you:\n\n  - provided the wrong URL.\n  - used an ID (for a link, account, transaction, and so on) that is not associated with your Belvo account.\n  \n"
}
array TaxDeclarationsDeleteSpecificDeclarationResponse
{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}
array TaxDeclarationsGetDetails401Response
{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}
array TaxDeclarationsGetDetails404Response
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/NotFoundError"
  },
  "description": "You made a request where you:\n\n  - provided the wrong URL.\n  - used an ID (for a link, account, transaction, and so on) that is not associated with your Belvo account.\n  \n"
}
object TaxDeclarationsGetDetailsResponse
{
  "oneOf": [
    {
      "$ref": "#/components/schemas/TaxDeclarationIndividual"
    },
    {
      "$ref": "#/components/schemas/TaxDeclarationBusiness"
    }
  ]
}
array TaxDeclarationsGetFiscalLink201Response
{
  "type": "array",
  "items": {
    "oneOf": [
      {
        "$ref": "#/components/schemas/TaxDeclarationBusiness"
      },
      {
        "$ref": "#/components/schemas/TaxDeclarationIndividual"
      }
    ]
  }
}
array TaxDeclarationsGetFiscalLink400Response
{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/TooManySessionsError"
      },
      {
        "$ref": "#/components/schemas/LoginError"
      },
      {
        "$ref": "#/components/schemas/SessionExpiredError"
      },
      {
        "$ref": "#/components/schemas/ValidationError"
      },
      {
        "$ref": "#/components/schemas/InstitutionDownError"
      },
      {
        "$ref": "#/components/schemas/InstitutionUnavailableError"
      },
      {
        "$ref": "#/components/schemas/InstitutionInactiveError"
      },
      {
        "$ref": "#/components/schemas/UnsupportedOperationError"
      },
      {
        "$ref": "#/components/schemas/InvalidLinkError"
      },
      {
        "$ref": "#/components/schemas/UnconfirmedLinkError"
      }
    ]
  }
}
array TaxDeclarationsGetFiscalLink401Response
{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}
array TaxDeclarationsGetFiscalLink500Response
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/UnexpectedError"
  },
  "title": "Unexpected Error",
  "description": "This error occurs when we (Belvo) have encountered an internal system error (sorry about that) or due to an unsupported response from the institution.\n  \n"
}
array TaxDeclarationsGetFiscalLinkResponse
{
  "type": "array",
  "items": {
    "oneOf": [
      {
        "$ref": "#/components/schemas/TaxDeclarationBusiness"
      },
      {
        "$ref": "#/components/schemas/TaxDeclarationIndividual"
      }
    ]
  }
}
array TaxDeclarationsListAll401Response
{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}
object TaxDeclarationsListAllResponse
{
  "oneOf": [
    {
      "$ref": "#/components/schemas/TaxDeclarationIndividualPaginated"
    },
    {
      "$ref": "#/components/schemas/TaxDeclarationBusinessPaginated"
    }
  ]
}
object TaxDeclarationsRequest
{
  "type": "object",
  "title": "Tax Declarations",
  "required": [
    "link",
    "type",
    "year_to",
    "year_from"
  ],
  "properties": {
    "link": {
      "type": "string",
      "format": "uuid",
      "example": "d4617561-1c01-4b2f-83b6-a594f7b3bc57",
      "description": "The fiscal `link.id` you want specific tax declaration information for."
    },
    "year_to": {
      "type": "string",
      "example": "2019",
      "description": "The year you want to stop getting tax declaration for, in `YYYY` format.\n"
    },
    "save_data": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Indicates whether or not to persist the data in Belvo. By default, this is set to `true` and we return a 201 Created response.\n\nWhen set to `false`, the data won't be persisted and we return a 200 OK response.\n"
    },
    "year_from": {
      "type": "string",
      "example": "2018",
      "description": "The starting year you want to get tax declaration for, in `YYYY` format.\n"
    },
    "attach_pdf": {
      "type": "boolean",
      "default": false,
      "example": false,
      "description": "When this is set to `true`, you will receive the PDF as a binary string in\nthe response.\n"
    }
  },
  "description": "Request body for tax declrarations"
}
object TaxPayerInformationBusiness
{
  "type": "object",
  "required": [
    "first_last_name",
    "second_last_name",
    "first_name",
    "other_names",
    "company_name",
    "main_economic_activity",
    "document_id",
    "reporting_id"
  ],
  "properties": {
    "first_name": {
      "type": "string",
      "example": "Carlos",
      "nullable": true,
      "description": "The tax payer's first name."
    },
    "document_id": {
      "$ref": "#/components/schemas/DocumentIdBusiness"
    },
    "other_names": {
      "type": "string",
      "example": "Alberto",
      "nullable": true,
      "description": "Additional names of the tax payer."
    },
    "company_name": {
      "type": "string",
      "example": "Trusty Spanners",
      "description": "The name of the company, as registered at the institution."
    },
    "reporting_id": {
      "$ref": "#/components/schemas/ReportingId"
    },
    "first_last_name": {
      "type": "string",
      "example": "Restrepo",
      "nullable": true,
      "description": "The tax payer's first last name."
    },
    "second_last_name": {
      "type": "string",
      "example": "Vives",
      "nullable": true,
      "description": "The tax payer's second last name."
    },
    "main_economic_activity": {
      "type": "string",
      "example": "0032",
      "description": "The main economic activity the tax payer is involved in."
    }
  },
  "description": "Object containing information about the tax payer."
}
object TaxPayerInformationIndividual
{
  "type": "object",
  "required": [
    "first_last_name",
    "second_last_name",
    "first_name",
    "other_names",
    "main_economic_activity",
    "document_id",
    "reporting_id"
  ],
  "properties": {
    "first_name": {
      "type": "string",
      "example": "Carlos",
      "description": "The tax payer's first name."
    },
    "document_id": {
      "$ref": "#/components/schemas/DocumentIdIndividual"
    },
    "other_names": {
      "type": "string",
      "example": "Alberto",
      "description": "Additional names of the tax payer."
    },
    "reporting_id": {
      "$ref": "#/components/schemas/ReportingId"
    },
    "first_last_name": {
      "type": "string",
      "example": "Restrepo",
      "description": "The tax payer's first last name."
    },
    "second_last_name": {
      "type": "string",
      "example": "Vives",
      "description": "The tax payer's second last name."
    },
    "main_economic_activity": {
      "type": "string",
      "example": "0010",
      "description": "The main economic activity the tax payer is involved in."
    }
  },
  "description": "Object containing information about the tax payer."
}
object TaxRetentions
{
  "type": "object",
  "required": [
    "collected_at",
    "invoice_identification",
    "version",
    "code",
    "issued_at",
    "certified_at",
    "cancelled_at",
    "sender_id",
    "sender_name",
    "receiver_nationality",
    "receiver_id",
    "receiver_name",
    "total_invoice_amount",
    "total_taxable_amount",
    "total_exempt_amount",
    "total_retained_amount",
    "retention_breakdown",
    "xml"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "example": "c749315b-eec2-435d-a458-06912878564f",
      "description": "Belvo's unique identifier used to reference the current tax retention statement."
    },
    "xml": {
      "type": "string",
      "example": "=XML-STRING=",
      "nullable": true,
      "description": "The tax retention document in XML form.\n"
    },
    "code": {
      "type": "integer",
      "format": "int32",
      "example": 25,
      "nullable": true,
      "description": "The tax retention code. For more information, see our [SAT Catalogs DevPortal article](https://developers.belvo.com/docs/sat-catalogs#retention-code).\n"
    },
    "link": {
      "type": "string",
      "format": "uuid",
      "example": "19697249-01b8-443e-a451-76bfc5fbeebf",
      "description": "The `link.id` the tax retention belongs to."
    },
    "version": {
      "type": "string",
      "example": "1.0",
      "nullable": true,
      "description": "The CFDI version of the tax retentions.\n"
    },
    "issued_at": {
      "type": "string",
      "format": "date-time",
      "example": "2019-01-03T21:10:40.000Z",
      "nullable": true,
      "description": "The ISO-8601 timestamp of when the tax retention was issued.\n"
    },
    "sender_id": {
      "type": "string",
      "example": "JKUF980404P0",
      "nullable": true,
      "description": "The fiscal ID of the invoice sender.\n"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2022-02-09T08:46:20.406032Z",
      "description": "The ISO-8601 timestamp of when the data point was last updated in Belvo's database.\n"
    },
    "receiver_id": {
      "type": "string",
      "example": "GYGK3207809L1",
      "nullable": true,
      "description": "The fiscal ID of the invoice receiver.\n"
    },
    "sender_name": {
      "type": "string",
      "example": "Roberto Nunez Batman",
      "nullable": true,
      "description": "The name of the invoice sender.\n"
    },
    "cancelled_at": {
      "type": "string",
      "format": "date-time",
      "example": null,
      "nullable": true,
      "description": "The ISO-8601 timestamp of when the tax retention was canceled (if applicable).\n"
    },
    "certified_at": {
      "type": "string",
      "format": "date-time",
      "example": "2019-01-03T21:10:41.000Z",
      "nullable": true,
      "description": "The ISO-8601 timestamp of when the tax retention was certified.\n"
    },
    "collected_at": {
      "type": "string",
      "format": "date-time",
      "example": "2022-02-09T08:45:50.406032Z",
      "nullable": true,
      "description": "The ISO-8601 timestamp of when the data point was collected.\n"
    },
    "receiver_name": {
      "type": "string",
      "example": "ACME LTD",
      "nullable": true,
      "description": "The name of the invoice receiver.\n"
    },
    "retention_breakdown": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/RetentionBreakdown"
      },
      "nullable": true,
      "description": "A breakdown of the retained taxes.\n"
    },
    "total_exempt_amount": {
      "type": "number",
      "format": "float",
      "example": 1000.8,
      "nullable": true,
      "description": "Total amount that is exempt from taxation.\n"
    },
    "receiver_nationality": {
      "$ref": "#/components/schemas/EnumTaxRetentionReceiverNationality"
    },
    "total_invoice_amount": {
      "type": "number",
      "format": "float",
      "example": 53249.8,
      "nullable": true,
      "description": "The total amount of the invoice that the tax retention relates to.\n"
    },
    "total_taxable_amount": {
      "type": "number",
      "format": "float",
      "example": 43249,
      "nullable": true,
      "description": "The total amount that can be taxed. Calculated as `total_invoice_amount` - `total_exempt_amount`.\n"
    },
    "total_retained_amount": {
      "type": "number",
      "format": "float",
      "example": 1550.7,
      "nullable": true,
      "description": "Total tax retained.\n"
    },
    "invoice_identification": {
      "type": "string",
      "format": "uuid",
      "example": "def404af-5eef-4112-aa99-d1ec8493b89a",
      "nullable": true,
      "description": "The fiscal institution's unique ID for the invoice that the tax retention relates to.\n"
    }
  }
}
array TaxRetentionsDeleteSpecificTaxRetention404Response
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/NotFoundError"
  },
  "description": "You made a request where you:\n\n  - provided the wrong URL.\n  - used an ID (for a link, account, transaction, and so on) that is not associated with your Belvo account.\n  \n"
}
array TaxRetentionsDeleteSpecificTaxRetentionResponse
{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}
array TaxRetentionsGetDetails404Response
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/NotFoundError"
  },
  "description": "You made a request where you:\n\n  - provided the wrong URL.\n  - used an ID (for a link, account, transaction, and so on) that is not associated with your Belvo account.\n  \n"
}
array TaxRetentionsGetDetailsResponse
{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}
array TaxRetentionsGetLinkTaxRetentions201Response
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/TaxRetentions"
  }
}
array TaxRetentionsGetLinkTaxRetentions400Response
{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/TooManySessionsError"
      },
      {
        "$ref": "#/components/schemas/LoginError"
      },
      {
        "$ref": "#/components/schemas/SessionExpiredError"
      },
      {
        "$ref": "#/components/schemas/ValidationError"
      },
      {
        "$ref": "#/components/schemas/InstitutionDownError"
      },
      {
        "$ref": "#/components/schemas/InstitutionUnavailableError"
      },
      {
        "$ref": "#/components/schemas/InstitutionInactiveError"
      },
      {
        "$ref": "#/components/schemas/UnsupportedOperationError"
      },
      {
        "$ref": "#/components/schemas/InvalidLinkError"
      },
      {
        "$ref": "#/components/schemas/UnconfirmedLinkError"
      }
    ]
  }
}
array TaxRetentionsGetLinkTaxRetentions401Response
{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}
array TaxRetentionsGetLinkTaxRetentions408Response
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/RequestTimeoutError"
  },
  "title": "Request Timeout",
  "description": "Belvo has a limit regarding the time it takes to log in, retrieve account data, and log out. A timeout occurs when there is a very high amount of data and everything could not be obtained within the allotted time.\n  \n"
}
array TaxRetentionsGetLinkTaxRetentions500Response
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/UnexpectedError"
  },
  "title": "Unexpected Error",
  "description": "This error occurs when we (Belvo) have encountered an internal system error (sorry about that) or due to an unsupported response from the institution.\n  \n"
}
array TaxRetentionsGetLinkTaxRetentionsResponse
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/TaxRetentions"
  }
}
array TaxRetentionsListAllResponse
{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}
object TaxRetentionsPaginatedResponse
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/common_pagination_properties"
    },
    {
      "properties": {
        "results": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/TaxRetentions"
          },
          "description": "Array of tax retentions objects."
        }
      }
    }
  ]
}
object TaxRetentionsRequest
{
  "type": "object",
  "required": [
    "link",
    "date_from",
    "date_to",
    "type"
  ],
  "properties": {
    "link": {
      "type": "string",
      "format": "uuid",
      "example": "9e432f18-36ca-4bd6-a3f3-1971e58dc1e8",
      "description": "The `link.id` that you want to get information for.\n"
    },
    "type": {
      "$ref": "#/components/schemas/EnumTaxRetentionType"
    },
    "date_to": {
      "type": "string",
      "example": "2020-02-01",
      "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
      "description": "The date you want to stop getting tax retentions for, in `YYYY-MM-DD` format.\n\n⚠️ The number of days between `date_from` and `date_to` cannot be over 365.\n"
    },
    "date_from": {
      "type": "string",
      "example": "2020-01-01",
      "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
      "description": "The date from which you want to start getting tax retentions for, in `YYYY-MM-DD` format.\n\n⚠️ The value of `date_from` cannot be greater than `date_to`.\n"
    },
    "save_data": {
      "type": "boolean",
      "default": true,
      "description": "Indicates whether or not to persist the data in Belvo. By default, this is set to `true` and we return a 201 Created response.\n\nWhen set to `false`, the data won't be persisted and we return a 200 OK response.\n"
    },
    "attach_xml": {
      "type": "boolean",
      "default": true,
      "description": "When set to `true`, you will receive the XML tax retention in the\nresponse.\n"
    }
  }
}
object TaxReturnBusiness
{
  "type": "object",
  "title": "Tax Return Business",
  "required": [
    "id",
    "collected_at",
    "created_at",
    "informacion_general",
    "datos_adicionales",
    "estado_resultados",
    "estado_posicion_financiera_balance",
    "conciliacion_entre_resultado_contable_fiscal",
    "deducciones_autorizadas",
    "cifras_cierre_ejercicio",
    "determinacion_del_impuesto_sobre_la_renta",
    "dividendos_o_utilidades_distribuidos",
    "detalle_pago_r1_isr_personas_morales",
    "pdf",
    "receipt_pdf"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "example": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
      "description": "Unique identifier created by Belvo used to reference the current Tax\nReturn.\n"
    },
    "pdf": {
      "type": "string",
      "format": "binary",
      "example": "=PDF-STRING=",
      "nullable": true,
      "description": "Tax return PDF as a binary."
    },
    "ingressos": {
      "type": "object",
      "nullable": true,
      "description": "> **Note**: Only applicable for tax return filed on or after 2022. For tax returns filed before 2022, this field will return `null`.\n\nDetails regarding the total amounts earned in the fiscal year.\n"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2022-02-09T08:45:50.406032Z",
      "description": "The ISO-8601 timestamp of when the data point was last updated in Belvo's database.\n"
    },
    "receipt_pdf": {
      "type": "string",
      "format": "binary",
      "example": "=PDF-STRING=",
      "nullable": true,
      "description": "The acknowledgement receipt from the fiscal institution confirming that\nthey received the tax return.\n"
    },
    "collected_at": {
      "type": "string",
      "format": "date-time",
      "example": "2019-09-27T13:01:41.941Z",
      "nullable": true,
      "description": "The ISO-8601 timestamp when the data point was collected.\n"
    },
    "determinacion": {
      "type": "object",
      "nullable": true,
      "description": "> **Note**: Only applicable for tax return filed on or after 2022. For tax returns filed before 2022, this field will return `null`.\n\nDetails regarding the tax due or tax credit.\n"
    },
    "datos_adicionales": {
      "type": "object",
      "nullable": true,
      "description": "Additional data regarding the tax return."
    },
    "estado_resultados": {
      "type": "object",
      "nullable": true,
      "description": "Detailed information about the legal entity's yearly profit and loss.\n\n> **Note**: For tax returns submitted for the 2022 tax year and later, this field will return null as it is no longer a required field when submitting your tax return.\n"
    },
    "informacion_general": {
      "type": "object",
      "nullable": true,
      "description": "General information regarding the tax return (year, RFC, return type,\nperson/company name, and so on).\n"
    },
    "cifras_cierre_ejercicio": {
      "type": "object",
      "nullable": true,
      "description": "Details regarding key numbers at the end of the fiscal exercise."
    },
    "deducciones_autorizadas": {
      "type": "object",
      "nullable": true,
      "description": "Details regarding the legal entity's deductions."
    },
    "estado_posicion_financiera_balance": {
      "type": "object",
      "nullable": true,
      "description": "Details regarding balance sheet of the legal entity.\n\n> **Note**: For tax returns submitted for the 2022 tax year and later, this field will return null as it is no longer a required field when submitting your tax return.\n"
    },
    "detalle_pago_r1_isr_personas_morales": {
      "type": "object",
      "nullable": true,
      "description": "Details of the tax payment."
    },
    "dividendos_o_utilidades_distribuidos": {
      "type": "object",
      "nullable": true,
      "description": "Details regarding distributed dividends."
    },
    "determinacion_del_impuesto_sobre_la_renta": {
      "type": "object",
      "nullable": true,
      "description": "Details regarding the final tax return."
    },
    "conciliacion_entre_resultado_contable_fiscal": {
      "type": "object",
      "nullable": true,
      "description": "Details regarding the accounting reconciliation.\n\n> **Note**: For tax returns submitted for the 2022 tax year and later, this field will return null as it is no longer a required field when submitting your tax return.\n"
    }
  },
  "additionalProperties": true
}
object TaxReturnBusinessMonthly
{
  "type": "object",
  "title": "Tax Return Business Monthly",
  "required": [
    "informacion_general",
    "determinacion_isr",
    "pdf",
    "type",
    "collected_at",
    "detalle_pago_isr",
    "determinacion_iva",
    "detalle_pago_iva"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "example": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
      "description": "Unique identifier created by Belvo used to reference the current Tax\nReturn.\n"
    },
    "pdf": {
      "type": "string",
      "format": "binary",
      "example": "=PDF-STRING=",
      "nullable": true,
      "description": "Tax return PDF as a binary."
    },
    "type": {
      "type": "string",
      "example": "monthly",
      "nullable": true,
      "description": "The type of tax return. Can be either monthly or annual."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2022-02-09T08:45:50.406032Z",
      "description": "The ISO-8601 timestamp of when the data point was last updated in Belvo's database.\n"
    },
    "receipt_pdf": {
      "type": "string",
      "format": "binary",
      "example": "=PDF-STRING=",
      "nullable": true,
      "description": "The acknowledgement receipt from the fiscal institution confirming that\nthey received the tax return.\n"
    },
    "collected_at": {
      "type": "string",
      "format": "date-time",
      "example": "2019-09-27T13:01:41.941Z",
      "nullable": true,
      "description": "The ISO-8601 timestamp when the data point was collected.\n"
    },
    "detalle_pago_isr": {
      "type": "object",
      "nullable": true,
      "description": "Information on the monthly provisional payments for the income tax."
    },
    "detalle_pago_iva": {
      "type": "object",
      "nullable": true,
      "description": "Information on the monthly provisional payments for the VAT tax."
    },
    "determinacion_isr": {
      "type": "object",
      "nullable": true,
      "description": "Information used to calculate the provisional income tax for the period."
    },
    "determinacion_iva": {
      "type": "object",
      "nullable": true,
      "description": "Information used to calculate the provisional VAT tax for the period."
    },
    "informacion_general": {
      "type": "object",
      "nullable": true,
      "description": "General information regarding the tax return (year, RFC, return type,\nperson/company name, and so on).\n"
    }
  },
  "additionalProperties": true
}
object TaxReturnPersonal
{
  "type": "object",
  "title": "Tax Return Personal",
  "required": [
    "informacion_general",
    "sueldos_salarios",
    "servicios_profesionales",
    "dividendos",
    "deducciones_personales",
    "retenciones",
    "determinacion_impuesto",
    "pdf",
    "receipt_pdf",
    "collected_at"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "example": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
      "description": "Unique identifier created by Belvo used to reference the current Tax\nReturn.\n"
    },
    "pdf": {
      "type": "string",
      "format": "binary",
      "example": "=PDF-STRING=",
      "nullable": true,
      "description": "Tax return PDF as a binary."
    },
    "link": {
      "type": "string",
      "format": "uuid",
      "example": "30cb4806-6e00-48a4-91c9-ca55968576c8",
      "description": "The `link.id` the statement belongs to"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2022-02-09T08:45:50.406032Z",
      "description": "The ISO-8601 timestamp of when the data point was last updated in Belvo's database.\n"
    },
    "dividendos": {
      "type": "object",
      "nullable": true,
      "description": "Details regarding dividends."
    },
    "receipt_pdf": {
      "type": "string",
      "format": "binary",
      "example": "=PDF-STRING=",
      "nullable": true,
      "description": "The acknowledgement receipt from the fiscal institution confirming that\nthey received the tax return.\n"
    },
    "retenciones": {
      "type": "object",
      "nullable": true,
      "description": "Details on the already withheld taxes."
    },
    "collected_at": {
      "type": "string",
      "format": "date-time",
      "example": "2019-09-27T13:01:41.941Z",
      "nullable": true,
      "description": "The ISO-8601 timestamp when the data point was collected.\n"
    },
    "sueldos_salarios": {
      "type": "object",
      "nullable": true,
      "description": "Details regarding the income information together combined with withheld\ntaxes.\n"
    },
    "datos_informativos": {
      "type": "object",
      "nullable": true,
      "description": "Extra informative data on the tax return."
    },
    "informacion_general": {
      "type": "object",
      "nullable": true,
      "description": "General information on the tax return (year, RFC, return type,\nperson/company name, and so on).\n"
    },
    "deducciones_personales": {
      "type": "object",
      "nullable": true,
      "description": "List of all personal tax deductions."
    },
    "determinacion_impuesto": {
      "type": "object",
      "nullable": true,
      "description": "Details regarding the final tax return."
    },
    "servicios_profesionales": {
      "type": "object",
      "nullable": true,
      "description": "Details regarding the income and tax information from professional\nservices provided.\n"
    }
  },
  "additionalProperties": true
}
object TaxReturnPersonalMonthly
{
  "type": "object",
  "title": "Tax Return Personal Monthly",
  "required": [
    "informacion_general",
    "pdf",
    "type",
    "isr",
    "iva",
    "collected_at"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "example": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
      "description": "Unique identifier created by Belvo used to reference the current Tax\nReturn.\n"
    },
    "isr": {
      "type": "object",
      "nullable": true,
      "description": "Information used to calculate the monthly provisional payments of the\nincome tax.\n"
    },
    "iva": {
      "type": "object",
      "nullable": true,
      "description": "Information used to calculate the monthly provisional payments of the VAT\ntax.\n"
    },
    "pdf": {
      "type": "string",
      "format": "binary",
      "example": "=PDF-STRING=",
      "nullable": true,
      "description": "Tax return PDF as a binary."
    },
    "type": {
      "type": "string",
      "example": "monthly",
      "description": "The type of tax return. Can be either monthly or annual."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2022-02-09T08:45:50.406032Z",
      "description": "The ISO-8601 timestamp of when the data point was last updated in Belvo's database.\n"
    },
    "receipt_pdf": {
      "type": "string",
      "format": "binary",
      "example": "=PDF-STRING=",
      "nullable": true,
      "description": "The acknowledgement receipt from the fiscal institution confirming that\nthey received the tax return.\n"
    },
    "collected_at": {
      "type": "string",
      "format": "date-time",
      "example": "2022-02-09T08:45:50.406032Z",
      "nullable": true,
      "description": "The ISO-8601 timestamp when the data point was collected.\n"
    },
    "informacion_general": {
      "type": "object",
      "nullable": true,
      "description": "General information regarding the tax return (year, RFC, return type,\nperson/company name, and so on).\n"
    }
  },
  "additionalProperties": true
}
object TaxReturnsBusinessMonthlyPaginated
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/common_pagination_properties"
    },
    {
      "properties": {
        "results": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/TaxReturnBusinessMonthly"
          },
          "description": "Array of Monthly Business Tax Return objects."
        }
      }
    }
  ],
  "title": "Tax Return Personal Business Monthly",
  "additionalProperties": true
}
object TaxReturnsBusinessPaginated
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/common_pagination_properties"
    },
    {
      "properties": {
        "results": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/TaxReturnBusiness"
          },
          "description": "Array of Business Tax Return objects."
        }
      }
    }
  ],
  "title": "Tax Return Personal Business",
  "additionalProperties": true
}
array TaxReturnsDeleteSpecificTaxReturn404Response
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/NotFoundError"
  },
  "description": "You made a request where you:\n\n  - provided the wrong URL.\n  - used an ID (for a link, account, transaction, and so on) that is not associated with your Belvo account.\n  \n"
}
array TaxReturnsDeleteSpecificTaxReturnResponse
{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}
array TaxReturnsGetDetails401Response
{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}
array TaxReturnsGetDetails404Response
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/NotFoundError"
  },
  "description": "You made a request where you:\n\n  - provided the wrong URL.\n  - used an ID (for a link, account, transaction, and so on) that is not associated with your Belvo account.\n  \n"
}
object TaxReturnsGetDetailsResponse
{
  "oneOf": [
    {
      "$ref": "#/components/schemas/TaxReturnPersonal"
    },
    {
      "$ref": "#/components/schemas/TaxReturnPersonalMonthly"
    },
    {
      "$ref": "#/components/schemas/TaxReturnBusiness"
    },
    {
      "$ref": "#/components/schemas/TaxReturnBusinessMonthly"
    }
  ]
}
array TaxReturnsGetInformation201Response
{
  "type": "array",
  "items": {
    "oneOf": [
      {
        "$ref": "#/components/schemas/TaxReturnPersonal"
      },
      {
        "$ref": "#/components/schemas/TaxReturnPersonalMonthly"
      },
      {
        "$ref": "#/components/schemas/TaxReturnBusiness"
      },
      {
        "$ref": "#/components/schemas/TaxReturnBusinessMonthly"
      }
    ]
  }
}
array TaxReturnsGetInformation400Response
{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/TooManySessionsError"
      },
      {
        "$ref": "#/components/schemas/LoginError"
      },
      {
        "$ref": "#/components/schemas/SessionExpiredError"
      },
      {
        "$ref": "#/components/schemas/ValidationError"
      },
      {
        "$ref": "#/components/schemas/InstitutionDownError"
      },
      {
        "$ref": "#/components/schemas/InstitutionUnavailableError"
      },
      {
        "$ref": "#/components/schemas/InstitutionInactiveError"
      },
      {
        "$ref": "#/components/schemas/UnsupportedOperationError"
      },
      {
        "$ref": "#/components/schemas/InvalidLinkError"
      },
      {
        "$ref": "#/components/schemas/UnconfirmedLinkError"
      }
    ]
  }
}
array TaxReturnsGetInformation401Response
{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}
array TaxReturnsGetInformation500Response
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/UnexpectedError"
  },
  "title": "Unexpected Error",
  "description": "This error occurs when we (Belvo) have encountered an internal system error (sorry about that) or due to an unsupported response from the institution.\n  \n"
}
object TaxReturnsGetInformationRequest
{
  "oneOf": [
    {
      "$ref": "#/components/schemas/TaxReturnsMonthlyRequest"
    },
    {
      "$ref": "#/components/schemas/TaxReturnsYearlyRequest"
    }
  ]
}
array TaxReturnsGetInformationResponse
{
  "type": "array",
  "items": {
    "oneOf": [
      {
        "$ref": "#/components/schemas/TaxReturnPersonal"
      },
      {
        "$ref": "#/components/schemas/TaxReturnPersonalMonthly"
      },
      {
        "$ref": "#/components/schemas/TaxReturnBusiness"
      },
      {
        "$ref": "#/components/schemas/TaxReturnBusinessMonthly"
      }
    ]
  }
}
array TaxReturnsListAll401Response
{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}
object TaxReturnsListAllResponse
{
  "oneOf": [
    {
      "$ref": "#/components/schemas/TaxReturnsPersonalPaginated"
    },
    {
      "$ref": "#/components/schemas/TaxReturnsPersonalMonthlyPaginated"
    },
    {
      "$ref": "#/components/schemas/TaxReturnsBusinessPaginated"
    },
    {
      "$ref": "#/components/schemas/TaxReturnsBusinessMonthlyPaginated"
    }
  ]
}
Load more schemas