List Ledger Charges

Retrieves a list of charges for a specific ledger.

get

Path parameters

ledgerIdstringRequired

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /public/v1/billing/ledgers/{ledgerId}/charges HTTP/1.1
Host: 
Accept: */*

200

OK

{
  "$meta": {
    "pagination": {
      "offset": 1,
      "limit": 1,
      "total": 1
    },
    "omitted": [
      "text"
    ]
  },
  "data": [
    {
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "id": "CHG-1234-1234-1234-1234-1234",
      "externalIds": {
        "reference": "REF-67890",
        "invoice": "INV-12345",
        "vendor": "VND-54321"
      },
      "search": {
        "subscription": {
          "criteria": "externalIds.Vendor",
          "value": "EXT-12345"
        },
        "order": {
          "criteria": "externalIds.Vendor",
          "value": "EXT-12345"
        },
        "item": {
          "criteria": "externalIds.Vendor",
          "value": "EXT-12345"
        }
      },
      "period": {
        "start": "2025-01-01T00:00:00.0000000+00:00",
        "end": "2025-01-31T23:59:59.0000000+00:00"
      },
      "quantity": 10.5,
      "price": {
        "currency": {
          "purchase": "USD",
          "sale": "EUR",
          "rate": 1
        },
        "markup": 15.5,
        "markupSource": "Line",
        "margin": 20,
        "unitPP": 100,
        "PPx1": 1000,
        "unitSP": 120,
        "SPx1": 1200
      },
      "segment": "Segment-A",
      "description": {
        "value1": "Monthly subscription charge",
        "value2": "Includes additional services"
      },
      "journal": {
        "id": "BJO-1234-1234",
        "name": "29 Nov 2024 #1",
        "dueDate": "2025-05-15T23:59:59.0000000+00:00"
      },
      "ledger": {
        "id": "BLE-1234-1234-1234-1234"
      },
      "customLedger": {
        "id": "text",
        "name": "Quarterly Revenue Ledger"
      },
      "parent": {
        "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",
        "icon": "text",
        "name": "text",
        "externalId": "text"
      },
      "agreement": {
        "id": "text",
        "icon": "text",
        "status": "text",
        "name": "text"
      },
      "subscription": {
        "id": "text",
        "name": "text"
      },
      "order": {
        "id": "text"
      },
      "item": {
        "id": "text",
        "name": "text",
        "externalIds": {
          "vendor": "text",
          "operations": "text"
        }
      },
      "authorization": {
        "id": "text",
        "name": "text",
        "currency": "text"
      },
      "statement": {
        "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",
        "icon": "text",
        "name": "text"
      },
      "vendor": {
        "id": "text",
        "icon": "text",
        "type": "text",
        "status": "text",
        "name": "text"
      },
      "seller": {
        "id": "text",
        "icon": "text",
        "externalId": "text",
        "name": "text"
      },
      "attributes": {
        "documentNumber": "DOC-12345",
        "orderType": "PurchaseOrder",
        "externalDocumentNo": "EXT-67890",
        "externalDocumentNo2": "EXT2-54321",
        "yourReference": "CUST-REF-001"
      },
      "split": {
        "percentage": 50
      }
    }
  ]
}