Retry Failed Statement

Retry failed statement by setting its status to Mpt.Models.Billing.StatementStatus.Generated.

post

Path parameters

idstringRequired

Body

application/jsontext/jsonapplication/*+json

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

$metaall of | nullableOptional

Platform entity metadata.

auditall ofOptional

Contains audit-related details for the entity.

idstringOptional

The unique identifier of the statement.

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

externalIdsall ofOptional

Contains external identifiers associated with the statement.

ledgerall ofOptional

customLedgerall ofOptional

typeall ofOptional

Specifies the type of the statement.

Example: Debit

string · enumOptional

Represents the type of a statement in the billing system.

Possible values:

billingTypeall ofOptional

Specifies the billing type of the statement.

Example: Automated

string · enumOptional

Represents the type of billing process.

Possible values:

statusall ofOptional

Indicates the current status of the statement.

Example: Generated

string · enumOptional

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

Possible values:

clientall ofOptional

buyerall ofOptional

vendorall ofOptional

sellerall ofOptional

productall ofOptional

agreementall ofOptional

licenseeall ofOptional

priceall ofOptional

Contains the pricing summary for the statement.

processingall ofOptional

Contains the processing summary for the statement, visible to operations.

statusNotesall of | nullableOptional

Contains additional notes or messages about the status of the statement, if applicable.

errorall of | nullableOptional

Represents any error associated with the statement, visible to clients or operations.

invoiceall ofOptional

Responses

200

OK

application/json

403

Forbidden

application/json

404

Not Found

application/json

post

HTTPcURLJavaScriptPython

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

{
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "audit": {
    "created": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "generated": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "queued": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "error": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "cancelled": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "pending": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "issued": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "generating": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    }
  },
  "id": "SOM-1234-1234-1234-1234-1234",
  "externalIds": {
    "operations": "OPS-12345",
    "vendor": "VND-67890",
    "erpId": "ERP-12345"
  },
  "ledger": {
    "id": "BLE-1234-1234-1234-1234"
  },
  "customLedger": {
    "id": "text",
    "name": "Quarterly Revenue Ledger"
  },
  "type": "Debit",
  "billingType": "Automated",
  "status": "Generated",
  "client": {
    "id": "text",
    "icon": "text",
    "type": "Client",
    "status": "Active",
    "name": "text"
  },
  "buyer": {
    "id": "text",
    "icon": "text",
    "name": "text"
  },
  "vendor": {
    "id": "text",
    "icon": "text",
    "type": "Client",
    "status": "Active",
    "name": "text"
  },
  "seller": {
    "id": "text",
    "icon": "text",
    "externalId": "text",
    "name": "text",
    "erpLink": {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "icon": "text",
      "buyer": {
        "id": "text",
        "icon": "text",
        "name": "text"
      },
      "seller": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      },
      "name": "text",
      "status": "Active",
      "note": "text",
      "externalIds": {
        "erpCompanyContact": "text",
        "erpCustomer": "text",
        "accountExternalId": "text"
      },
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      }
    }
  },
  "product": {
    "id": "text",
    "name": "text",
    "externalIds": {
      "operations": "text"
    },
    "icon": "text",
    "status": "text"
  },
  "agreement": {
    "id": "text",
    "icon": "text",
    "status": "New",
    "name": "text"
  },
  "licensee": {
    "id": "text",
    "icon": "text",
    "name": "text",
    "externalId": "text"
  },
  "price": {
    "markup": 15.5,
    "margin": 20,
    "totalPP": 1000,
    "totalSP": 1200,
    "currency": {
      "purchase": "USD",
      "sale": "EUR",
      "rate": 1
    },
    "totalGT": 1500.75,
    "totalST": 1200.5
  },
  "processing": {
    "total": 100,
    "ready": 80,
    "error": 5,
    "split": 10,
    "skipped": 5
  },
  "statusNotes": {
    "id": "text",
    "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."
  },
  "invoice": {
    "id": "INV-123-456-789"
  }
}

application/jsontext/jsonapplication/*+json

{
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "audit": {
    "created": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "generated": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "queued": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "error": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "cancelled": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "pending": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "issued": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "generating": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    }
  },
  "id": "SOM-1234-1234-1234-1234-1234",
  "externalIds": {
    "operations": "OPS-12345",
    "vendor": "VND-67890",
    "erpId": "ERP-12345"
  },
  "ledger": {
    "id": "BLE-1234-1234-1234-1234"
  },
  "customLedger": {
    "id": "text",
    "name": "Quarterly Revenue Ledger"
  },
  "type": "Debit",
  "billingType": "Automated",
  "status": "Generated",
  "client": {
    "id": "text",
    "icon": "text",
    "type": "Client",
    "status": "Active",
    "name": "text"
  },
  "buyer": {
    "id": "text",
    "icon": "text",
    "name": "text"
  },
  "vendor": {
    "id": "text",
    "icon": "text",
    "type": "Client",
    "status": "Active",
    "name": "text"
  },
  "seller": {
    "id": "text",
    "icon": "text",
    "externalId": "text",
    "name": "text",
    "erpLink": {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "icon": "text",
      "buyer": {
        "id": "text",
        "icon": "text",
        "name": "text"
      },
      "seller": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      },
      "name": "text",
      "status": "Active",
      "note": "text",
      "externalIds": {
        "erpCompanyContact": "text",
        "erpCustomer": "text",
        "accountExternalId": "text"
      },
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      }
    }
  },
  "product": {
    "id": "text",
    "name": "text",
    "externalIds": {
      "operations": "text"
    },
    "icon": "text",
    "status": "text"
  },
  "agreement": {
    "id": "text",
    "icon": "text",
    "status": "New",
    "name": "text"
  },
  "licensee": {
    "id": "text",
    "icon": "text",
    "name": "text",
    "externalId": "text"
  },
  "price": {
    "markup": 15.5,
    "margin": 20,
    "totalPP": 1000,
    "totalSP": 1200,
    "currency": {
      "purchase": "USD",
      "sale": "EUR",
      "rate": 1
    },
    "totalGT": 1500.75,
    "totalST": 1200.5
  },
  "processing": {
    "total": 100,
    "ready": 80,
    "error": 5,
    "split": 10,
    "skipped": 5
  },
  "statusNotes": {
    "id": "text",
    "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."
  },
  "invoice": {
    "id": "INV-123-456-789"
  }
}