List Statements

get
Responses
200
OK
application/json
get
GET /public/v1/billing/statements HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
200

OK

{
  "$meta": {
    "pagination": {
      "offset": 1,
      "limit": 1,
      "total": 1
    },
    "omitted": [
      "text"
    ]
  },
  "data": [
    {
      "$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": "[Circular Reference]"
      },
      "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"
      }
    }
  ]
}

Last updated

Was this helpful?