Cancel statement

Cancels a statement.

post

Transitions statement to Cancelled status. Cancelled statements are excluded from billing. When called for a consolidated statement, children receive the status Queued and are detached from the consolidated parent.

Path parameters

idstringRequired

The ID of the statement to cancel.

Body

application/jsontext/jsonapplication/*+json

Represents a billing statement in the system, containing details about transactions, pricing, and associated entities.

revisioninteger · int32Optional

idstringOptional

The unique identifier of the statement.

Example: SOM-1234-1234-1234-1234-1234

typestring · enumOptional

Represents the type of a statement in the billing system.

Possible values:

billingTypestring · enumOptional

Represents the type of billing process.

Possible values:

statusstring · enumOptional

Represents the various statuses a statement can have in the billing system.

Possible values:

Responses

200

OK

application/json

Represents a billing statement in the system, containing details about transactions, pricing, and associated entities.

revisioninteger · int32Optional

idstringOptional

The unique identifier of the statement.

Example: SOM-1234-1234-1234-1234-1234

typestring · enumOptional

Represents the type of a statement in the billing system.

Possible values:

billingTypestring · enumOptional

Represents the type of billing process.

Possible values:

statusstring · enumOptional

Represents the various statuses a statement can have in the billing system.

Possible values:

403

Forbidden

application/json

404

Not Found

application/json

post/public/v1/billing/statements/{id}/cancel

HTTPcURLJavaScriptPython

POST /public/v1/billing/statements/{id}/cancel HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 2910

{
  "audit": {
    "created": {
      "at": "2026-08-07T19:18:54.966Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-08-07T19:18:54.966Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "generated": {
      "at": "2026-08-07T19:18:54.966Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "queued": {
      "at": "2026-08-07T19:18:54.966Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "error": {
      "at": "2026-08-07T19:18:54.966Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "cancelled": {
      "at": "2026-08-07T19:18:54.966Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "pending": {
      "at": "2026-08-07T19:18:54.966Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "issued": {
      "at": "2026-08-07T19:18:54.966Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "generating": {
      "at": "2026-08-07T19:18:54.966Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "consolidating": {
      "at": "2026-08-07T19:18:54.966Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "consolidated": {
      "at": "2026-08-07T19:18:54.966Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "revision": 1,
  "id": "SOM-1234-1234-1234-1234-1234",
  "externalIds": {
    "operations": "OPS-12345",
    "vendor": "VND-67890",
    "erpId": "ERP-12345",
    "client": "CLI-12345"
  },
  "ledger": {
    "revision": 1,
    "id": "BLE-1234-1234-1234-1234"
  },
  "customLedger": {
    "revision": 1,
    "id": "text",
    "name": "Quarterly Revenue Ledger"
  },
  "type": "Debit",
  "billingType": "Automated",
  "status": "Generated",
  "client": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  },
  "buyer": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1
  },
  "vendor": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  },
  "seller": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "externalId": "text"
  },
  "product": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "externalIds": {
      "operations": "text",
      "defaultErpItem": "text"
    },
    "status": "text"
  },
  "agreement": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "status": "New"
  },
  "licensee": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "externalId": "text"
  },
  "price": {
    "markup": 15.5,
    "margin": 20,
    "totalPP": 1000,
    "totalBSP": 1200,
    "currency": {
      "purchase": "USD",
      "sale": "EUR",
      "rate": 1
    },
    "totalSP": 1200
  },
  "processing": {
    "total": 100,
    "ready": 80,
    "error": 5,
    "split": 10,
    "skipped": 5,
    "ignored": 2
  },
  "statusNotes": {
    "message": "text",
    "parameters": null
  },
  "error": {
    "errorCode": "ERR-001",
    "errorMessage": "Invalid billing data provided.",
    "id": "12345",
    "message": "Failed to process the billing entity due to missing data."
  },
  "creditMemo": {
    "revision": 1,
    "id": "text"
  },
  "invoice": {
    "revision": 1,
    "id": "INV-123-456-789"
  },
  "backup": {
    "status": "Pending",
    "date": "2026-08-07T19:18:54.966Z"
  },
  "parent": {
    "revision": 1,
    "id": "SOM-1234-1234-1234-1234-1234"
  },
  "statistics": {
    "statements": 3,
    "products": 3,
    "agreements": 3,
    "licensees": 2
  }
}

application/jsontext/jsonapplication/*+json

{
  "audit": {
    "created": {
      "at": "2026-08-07T19:18:54.966Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-08-07T19:18:54.966Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "generated": {
      "at": "2026-08-07T19:18:54.966Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "queued": {
      "at": "2026-08-07T19:18:54.966Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "error": {
      "at": "2026-08-07T19:18:54.966Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "cancelled": {
      "at": "2026-08-07T19:18:54.966Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "pending": {
      "at": "2026-08-07T19:18:54.966Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "issued": {
      "at": "2026-08-07T19:18:54.966Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "generating": {
      "at": "2026-08-07T19:18:54.966Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "consolidating": {
      "at": "2026-08-07T19:18:54.966Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "consolidated": {
      "at": "2026-08-07T19:18:54.966Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "revision": 1,
  "id": "SOM-1234-1234-1234-1234-1234",
  "externalIds": {
    "operations": "OPS-12345",
    "vendor": "VND-67890",
    "erpId": "ERP-12345",
    "client": "CLI-12345"
  },
  "ledger": {
    "revision": 1,
    "id": "BLE-1234-1234-1234-1234"
  },
  "customLedger": {
    "revision": 1,
    "id": "text",
    "name": "Quarterly Revenue Ledger"
  },
  "type": "Debit",
  "billingType": "Automated",
  "status": "Generated",
  "client": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  },
  "buyer": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1
  },
  "vendor": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  },
  "seller": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "externalId": "text"
  },
  "product": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "externalIds": {
      "operations": "text",
      "defaultErpItem": "text"
    },
    "status": "text"
  },
  "agreement": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "status": "New"
  },
  "licensee": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "externalId": "text"
  },
  "price": {
    "markup": 15.5,
    "margin": 20,
    "totalPP": 1000,
    "totalBSP": 1200,
    "currency": {
      "purchase": "USD",
      "sale": "EUR",
      "rate": 1
    },
    "totalSP": 1200
  },
  "processing": {
    "total": 100,
    "ready": 80,
    "error": 5,
    "split": 10,
    "skipped": 5,
    "ignored": 2
  },
  "statusNotes": {
    "message": "text",
    "parameters": null
  },
  "error": {
    "errorCode": "ERR-001",
    "errorMessage": "Invalid billing data provided.",
    "id": "12345",
    "message": "Failed to process the billing entity due to missing data."
  },
  "creditMemo": {
    "revision": 1,
    "id": "text"
  },
  "invoice": {
    "revision": 1,
    "id": "INV-123-456-789"
  },
  "backup": {
    "status": "Pending",
    "date": "2026-08-07T19:18:54.966Z"
  },
  "parent": {
    "revision": 1,
    "id": "SOM-1234-1234-1234-1234-1234"
  },
  "statistics": {
    "statements": 3,
    "products": 3,
    "agreements": 3,
    "licensees": 2
  }
}