v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Fiscal Documents

Create a fiscal document of the type rectify invoice

Create a fiscal document of the type rectify invoice.

Spanish Fiscal Regulations:

  • Only available for properties in Spain
  • An invoice that has already been rectified cannot be rectified again
  • To make corrections to a rectified invoice, you must rectify the most recent invoice in the rectification chain

Validation Rules:

  • The target invoice must not have been previously rectified
  • If the invoice has been rectified, the API will return an error with details about which invoice should be rectified instead
post/fiscal-document/v1/fiscal-documents/rectify-invoice

Headers

X-Property-IDinteger required

Property id

Request body

invoiceIdinteger required

ID of the invoice to be rectified.

Validation: This invoice must not have been previously rectified according to Spanish fiscal regulations.

reasonstring

Reason for rectifying the invoice

userIdinteger

ID of the user creating the rectification

method'VOID' | 'ADJUSTMENT' required
transactionIdsinteger[] nullable

Include transactions with the specified IDs (deprecated, use includeTransactionIds instead)

folioIdsinteger[] nullable

Include all transactions from the specified folio IDs

excludeTransactionIdsinteger[] nullable

Exclude transactions with the specified IDs

includeTransactionIdsinteger[] nullable

Include transactions with the specified IDs

Response

OK

idstring
kind'INVOICE' | 'CREDIT_NOTE' | 'RECEIPT' | 'RECTIFY_INVOICE' | 'PRO_FORMA_INVOICE' | 'REFUND_RECEIPT' | 'INVOICE_RECEIPT' | 'ADVANCE_INVOICE' | 'SETTLEMENT_INVOICE' | 'TAX_WITHHOLDING'

Kind of fiscal document

status'COMPLETED' | 'VOIDED' | 'PAID' | 'PENDING_INTEGRATION' | 'PARTIALLY_PAID' | 'COMPLETED_INTEGRATION' | 'FAILED_INTEGRATION' | 'CORRECTION_NEEDED' | 'CANCELED' | 'CANCEL_REQUESTED' | 'OPEN' | 'REQUESTED' | 'VOID_REQUESTED' | 'FAILED' | 'MANUALLY_RECONCILED' | 'REJECTED' | 'ACCEPTED' | 'PENDING_TRANSACTION' | 'ALLOCATED' | 'APPLIED'

Status of the fiscal document

linkedTostring

Example response

{
  "governmentIntegration": {
    "folioFiscal": "9B3E26F4-1234-4A5B-8C9D-ABCDEF012345"
  }
}