Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Fiscal Documents

Update pro forma invoice status

Update the status of a pro forma invoice. Supported status transitions:

  • OPEN -> ACCEPTED, REJECTED, CANCELED
  • ACCEPTED -> CANCELED
  • REJECTED -> CANCELED
put/fiscal-document/v1/fiscal-documents/pro-forma-invoice/{id}/status

Path parameters

idinteger required

Unique ID of the pro forma invoice to update.

Headers

X-Property-IDinteger required

Property id

Request body

status'ACCEPTED' | 'REJECTED' | 'CANCELED' required

New status for the pro forma invoice

Response

Pro forma invoice status successfully updated

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"
  }
}