Statements

Removes a child statement from a consolidated parent statement.

Removes a child statement from a consolidated parent. The child must be in Consolidating status and will transition to Generated status. Parent statistics and prices are recalculated.

delete/public/v1/billing/statements/{id}/children/{childId}

Request

  • Base URL: https://api.platform.softwareone.com
  • URL: https://api.platform.softwareone.com/public/v1/billing/statements/{id}/children/{childId}
  • Auth: none declared

Path parameters

idstring required

The ID of the consolidated parent statement.

childIdstring required

The ID of the child statement to remove.

Response

OK

revisioninteger
idstring

The unique identifier of the statement.

type'Debit' | 'Credit'

Represents the type of a statement in the billing system.

billingType'Automated' | 'Manual' | 'Consolidated'

Represents the type of billing process.

status'Generated' | 'Queued' | 'Error' | 'Cancelled' | 'Pending' | 'Issued' | 'Generating' | 'Consolidating' | 'Consolidated'

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

Example response

{
  "id": "SOM-1234-1234-1234-1234-1234",
  "externalIds": {
    "operations": "OPS-12345",
    "vendor": "VND-67890",
    "erpId": "ERP-12345",
    "client": "CLI-12345"
  },
  "ledger": {
    "id": "BLE-1234-1234-1234-1234"
  },
  "customLedger": {
    "name": "Quarterly Revenue Ledger"
  },
  "price": {
    "markup": 15.5,
    "margin": 20,
    "totalPP": 1000,
    "totalBP": 1100,
    "totalBSP": 1200,
    "currency": {
      "purchase": "USD",
      "sale": "EUR",
      "rate": 1
    },
    "totalSP": 1200
  },
  "processing": {
    "total": 100,
    "ready": 80,
    "error": 5,
    "split": 10,
    "skipped": 5,
    "ignored": 2
  },
  "error": {
    "errorCode": "ERR-001",
    "errorMessage": "Invalid billing data provided.",
    "id": "12345",
    "message": "Failed to process the billing entity due to missing data."
  },
  "invoice": {
    "id": "INV-123-456-789"
  },
  "parent": {
    "id": "SOM-1234-1234-1234-1234-1234"
  },
  "statistics": {
    "statements": 3,
    "products": 3,
    "agreements": 3,
    "licensees": 2
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.