Events are our way of letting you know when something interesting happens in your account. When an interesting event occurs, we create a new Event resource. For example, when an entity’s SAT credential is submitted, we create a credential.created event; and when a data extraction process finishes, we create an extraction.updated event.

Note that many API requests may cause multiple events to be created. For example, if you submit a valid taxpayer credential, you will receive a credential.created, credential.updated and link.created event.

Events occur when the state of another API resource changes. The state of that resource at the time of the change is embedded in the event’s data field. For example, a credential.updated event will contain a Credential, and an invoice.updated event will contain an Invoice.

As with other API resources, you can use endpoints to retrieve an individual event or a list of events from the API. We also have a separate webhooks system for sending the Event objects directly to an endpoint on your server. Webhooks are managed in your account settings.

NOTE: Access to events is only guaranteed for 7 days.

​
Types of events

  • credential.created: Occurs whenever a new taxpayer credential is submitted
  • credential.updated: Occurs whenever a credential status changes
  • credential.deleted: Occurs whenever a credential is deleted
  • link.created: Occurs whenever an entity with a taxpayer is created
  • link.updated: Occurs whenever an entity status changes
  • link.deleted: Occurs whenever an entity is deleted
  • file.created: Occurs whenever a file is created
  • extraction.created: Occurs whenever a data extraction request is created
  • extraction.updated: Occurs whenever an extraction status changes
  • invoice.created: Occurs whenever a new invoice is extracted from SAT
  • invoice.updated: Occurs whenever an existing invoice is updated
  • invoice.deleted: Occurs whenever an existing invoice is deleted
  • invoice_payment.created: Occurs whenever a new “invoice payment” is created from an invoice of type payment
  • invoice_payment.updated: Occurs whenever an existing “invoice payment” is updated
  • invoice_line_item.created: Occurs whenever a new “invoice line item” is created from an invoice
  • invoice_line_item.updated: Occurs whenever an existing “invoice line item” is updated
  • tax_return.created: Occurs whenever a new tax return is extracted from SAT
  • tax_return.updated: Occurs whenever an existing tax return is updated
  • tax_return.deleted: Occurs whenever an existing tax return is deleted
  • export.created: Occurs whenever the export endpoint is requested to generate a file
  • export.updated: Occurs whenever the export status changes. At the beginning it is pending, running while the file is creating and finished when the resource is ready
  • tax_status.created: Occurs whenever a tax status is extracted from SAT
  • tax_status.updated: Occurs whenever an existing tax status is updated
  • tax_status.deleted: Occurs whenever an existing tax status is deleted
  • tax_compliance_check.created: Occurs whenever a tax compliance check is extracted from SAT
  • tax_compliance_check.updated: Occurs whenever an existing tax compliance check is updated
  • tax_compliance_check.deleted: Occurs whenever an existing tax compliance check is deleted
  • tax_retention.created: Occurs whenever a tax retention is extracted from SAT
  • tax_retention.updated: Occurs whenever an existing tax retention is updated
  • tax_retention.deleted: Occurs whenever an existing tax retention is deleted
  • electronic_accounting_record.created: Occurs whenever a electronic accounting record is extracted from the SAT
  • electronic_accounting_record.updated: Occurs whenever an existing electronic accounting record is updated
  • rpc_entidades.created: Occurs whenever a new entidade is extracted from RPC
  • rpc_entidades.updated: Occurs whenever an existing entidade is updated
  • rpc_socios.created: Occurs whenever a new socio is extracted from RPC
  • rpc_socios.updated: Occurs whenever an existing socio is updated
  • rpc_acto.created: Occurs whenever a new acto is extracted from RPC
  • rpc_acto.updated: Occurs whenever an existing acto is updated
  • rug_garantia.created: Occurs whenever a new garantia is extracted from RUG
  • rug_garantia.updated: Occurs whenever an existing garantia is updated
  • buro_de_credito_report.created: Occurs whenever a new Buró de Crédito is created
  • buro_de_credito_report.updated: Occurs whenever a new Buró de Crédito is updated