Invoice Lifecycle

#Invoice Statuses

Given the complex nature of invoicing the invocie has numerous states:

#Status details

Each of these states have a number of sub-states. Given the sheer number of substates an invoice can have, the API Provides a simpler intent-based description of the invoice states called the status details:

{
  "status": "draft",
  "statusDetails": {
      "availableActions": {
          "approve": {
              "resultingState": "payment_processing.pending"
          },
          "delete": {
              "resultingState": "deleted"
          }
      },
      "extendedStatus": "draft.waiting_auto_approval",
      "failed": false,
      "immutable": false
    },
}

The status field represents the primary invoice state, while statusDetails.extendedStatus provides more granular state information including substates. The status details object contains several key properties to help understand the current state and available actions without having to understand each substate:

• availableActions: Enumerates the permitted operations that can be executed on the invoice, such as approve or delete, along with their resulting states
• failed: Boolean indicator signifying whether the invoice is in a failed state
• immutable: Boolean flag indicating whether the invoice can be modified further

#Reference: list of extended statuses

States not listed here does not have extended statuses.