List Custom Ledgers

get

Responses

200

OK

application/json

get

/public/v1/billing/custom-ledgers

HTTPcURLJavaScriptPython

GET /public/v1/billing/custom-ledgers 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"
          }
        },
        "draft": {
          "at": "2025-04-30T14:30:00.0000000+00:00",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "deleted": {
          "at": "2025-04-30T14:30:00.0000000+00:00",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "validating": {
          "at": "2025-04-30T14:30:00.0000000+00:00",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "validated": {
          "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"
          }
        },
        "generating": {
          "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"
          }
        },
        "completed": {
          "at": "2025-04-30T14:30:00.0000000+00:00",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        }
      },
      "id": "text",
      "name": "Quarterly Revenue Ledger",
      "externalIds": {
        "operations": "OPS-12345",
        "vendor": "VND-67890"
      },
      "seller": {
        "id": "text",
        "icon": "text",
        "externalId": "text",
        "name": "text"
      },
      "vendor": {
        "id": "text",
        "icon": "text",
        "type": "text",
        "status": "text",
        "name": "text"
      },
      "billingStartDate": "2025-01-01T00:00:00.0000000+00:00",
      "billingEndDate": "2025-03-31T23:59:59.0000000+00:00",
      "notes": "Includes all transactions for Q1 2025.",
      "status": "Validated",
      "assignee": {
        "id": "text",
        "name": "text",
        "icon": "text"
      },
      "price": {
        "markup": 15.5,
        "margin": 20,
        "totalPP": 1000,
        "totalSP": 1200,
        "currency": {
          "purchase": "USD",
          "sale": "EUR",
          "rate": 1
        }
      },
      "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."
      }
    }
  ]
}