List ledger charges

Retrieves a list of charges for a specific ledger.

get

Returns all charges aggregated in the ledger. Supports JSONL export for operations (Accept: application/jsonl). Supports filtering, sorting, and pagination via query parameters.

Path parameters

ledgerIdstringRequired

Responses

200

OK

application/json

get

/public/v1/billing/ledgers/{ledgerId}/charges

HTTPcURLJavaScriptPython

GET /public/v1/billing/ledgers/{ledgerId}/charges HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*

200

OK

{
  "$meta": {
    "pagination": {
      "offset": 1,
      "limit": 1,
      "total": 1
    },
    "omitted": [
      "text"
    ]
  },
  "data": [
    {
      "audit": {
        "reconciled": "[Circular Reference]",
        "reset": "[Circular Reference]"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "revision": 1,
      "id": "CHG-1234-1234-1234-1234-1234",
      "externalIds": {
        "reference": "REF-67890",
        "invoice": "INV-12345",
        "vendor": "VND-54321"
      },
      "search": {
        "source": {
          "criteria": "externalIds.Vendor",
          "value": "EXT-12345",
          "type": "Subscription"
        },
        "order": {
          "criteria": "externalIds.Vendor",
          "value": "EXT-12345"
        },
        "item": {
          "criteria": "externalIds.Vendor",
          "value": "EXT-12345"
        }
      },
      "period": {
        "start": "2026-06-12T20:11:51.814Z",
        "end": "2026-06-12T20:11:51.814Z"
      },
      "quantity": 10.5,
      "price": {
        "currency": {
          "purchase": "USD",
          "sale": "EUR",
          "rate": 1
        },
        "markup": 15.5,
        "markupSource": "Line",
        "margin": 20,
        "unitPP": 100,
        "PPx1": 1000,
        "unitBSP": 120,
        "BSPx1": 1200,
        "unitSP": 120,
        "SPx1": 1200
      },
      "description": {
        "value1": "Monthly subscription charge",
        "value2": "Includes additional services"
      },
      "attributes": {
        "documentNumber": "DOC-12345",
        "orderType": "PurchaseOrder",
        "externalDocumentNo": "EXT-67890",
        "externalDocumentNo2": "EXT2-54321",
        "yourReference": "CUST-REF-001",
        "agreementVendorId": "170ec08e-f43c-4831-aeb2-0d6455e1acf5",
        "segment": "Segment-A"
      },
      "journal": {
        "revision": 1,
        "id": "BJO-1234-1234",
        "name": "29 Nov 2024 #1",
        "dueDate": "2025-05-15T23:59:59+00:00"
      },
      "ledger": {
        "revision": 1,
        "id": "BLE-1234-1234-1234-1234"
      },
      "customLedger": {
        "revision": 1,
        "id": "text",
        "name": "Quarterly Revenue Ledger"
      },
      "parent": {
        "revision": 1,
        "id": "CHG-1234-1234-1234-1234-1234",
        "externalIds": {
          "reference": "REF-67890",
          "invoice": "INV-12345",
          "vendor": "VND-54321"
        }
      },
      "billingType": "Automated",
      "upload": {
        "status": "Ready",
        "errors": [
          "Invalid charge amount",
          "Missing buyer information"
        ]
      },
      "licensee": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1,
        "externalId": "text"
      },
      "agreement": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1,
        "status": "New"
      },
      "subscription": {
        "id": "text",
        "name": "text",
        "revision": 1
      },
      "line": {
        "id": "text",
        "audit": "[Circular Reference]",
        "quantity": 1,
        "item": "[Circular Reference]",
        "price": {
          "currency": "text",
          "markup": 1,
          "margin": 1,
          "defaultMarkupSource": {
            "type": "text",
            "ref": {
              "id": "text",
              "name": "text"
            }
          },
          "markupSource": {
            "type": "text",
            "ref": {
              "id": "text",
              "name": "text"
            }
          },
          "unitSP": 1,
          "unitPP": 1,
          "PPx1": 1,
          "SPx1": 1,
          "SPxY": 1,
          "SPxM": 1,
          "PPxY": 1,
          "PPxM": 1
        },
        "order": "[Circular Reference]",
        "status": "Active",
        "subscription": "[Circular Reference]",
        "asset": "[Circular Reference]",
        "agreement": "[Circular Reference]",
        "client": "[Circular Reference]",
        "vendor": "[Circular Reference]",
        "buyer": "[Circular Reference]",
        "seller": "[Circular Reference]",
        "product": "[Circular Reference]",
        "description": "text",
        "info": {
          "visible": true,
          "description": "text"
        }
      },
      "order": {
        "id": "text",
        "revision": 1
      },
      "asset": {
        "id": "text",
        "name": "text",
        "revision": 1,
        "status": "New"
      },
      "item": {
        "id": "text",
        "name": "text",
        "revision": 1,
        "externalIds": {
          "vendor": "text",
          "operations": "text"
        }
      },
      "authorization": {
        "id": "text",
        "name": "text",
        "revision": 1,
        "currency": "text"
      },
      "statement": {
        "revision": 1,
        "id": "SOM-1234-1234-1234-1234-1234"
      },
      "statementType": "Debit",
      "processing": {
        "status": "Ready",
        "errors": [
          "Invalid charge amount",
          "Missing buyer information"
        ]
      },
      "erpData": {
        "erpCountryCode": "US",
        "defaultErpProductId": "PROD-12345",
        "defaultErpProductName": "Standard Product",
        "cdg": "CDG-001",
        "scu": "SCU-123",
        "cco": "CCO-456",
        "erpItemId": "ITEM-789"
      },
      "buyer": {
        "id": "text",
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "icon": "text",
        "revision": 1,
        "externalIds": {
          "erpCompanyContact": "text",
          "erpCustomer": "text",
          "accountExternalId": "text"
        },
        "status": "Active",
        "address": {
          "addressLine1": "text",
          "addressLine2": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "taxId": "text",
        "account": "[Circular Reference]",
        "errors": [
          {
            "id": "text",
            "message": "text",
            "parameters": null
          }
        ],
        "sellers": [
          "[Circular Reference]"
        ]
      },
      "vendor": {
        "id": "text",
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "icon": "text",
        "revision": 1,
        "type": "Client",
        "status": "Active",
        "externalIds": {
          "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "externalId": "text",
        "externalName": "text",
        "address": {
          "addressLine1": "text",
          "addressLine2": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "technicalSupportEmail": "text",
        "website": "text",
        "description": "text",
        "groups": [
          "[Circular Reference]"
        ],
        "eligibility": {
          "client": true,
          "partner": true
        },
        "defaultLanguageCode": "text"
      },
      "seller": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1,
        "externalId": "text"
      },
      "split": {
        "percentage": 50
      },
      "reconciliation": {
        "type": "Match",
        "source": "Unknown",
        "reason": "text",
        "original": "[Circular Reference]"
      }
    }
  ]
}