MarketPe APIs

Disbursement Ledger

POST /ledger/disbursement

Every limit change for your org members — top ups and revokes — across all members, oldest first.

This is the JSON form of the Disbursement Ledger excel in the marketpe workspace, and carries the same information.

Only limit changes appear here. What a member actually spent against their limit is a payment, and shows up in the company ledger. A limit change is recorded once the limit actually moves, so a request still awaiting approval is not listed.

Available only if the org-member feature is enabled for your organization.

Request Body

{
  "fromTime": "2025-12-01T00:00:00.000+0530",
  "toTime": "2025-12-05T00:00:00.000+0530"
}

Request Parameters

ParameterTypeRequiredDescription
fromTimestringYesStart of the window, inclusive.
toTimestringYesEnd of the window, exclusive. Must be under 31 days after fromTime.

Response

{
  "status": "success",
  "data": {
    "entries": [
      {
        "id": "cmictkaua0000qemb2v0nueim",
        "timestamp": "2025-12-01T06:12:03.114Z",
        "description": "Top up (API)",
        "source": "TOPUP",
        "origin": "API",
        "topUp": 500,
        "revoke": null,
        "orgMember": {
          "id": "om-xxxxxx",
          "name": "RAVI KUMAR"
        },
        "vehicleRegistrationNumber": "MH12AB1234",
        "remarks": "Daily topup",
        "doneBy": "APP-API",
        "apiReferenceKey": "topup-2026-05-22-001",
        "customFieldValues": {
          "cf-id-1": "Fooding"
        }
      },
      {
        "id": "cmi7a7lnf0000mlmd10yjloab",
        "timestamp": "2025-12-02T11:41:55.902Z",
        "description": "Revoke (admin)",
        "source": "REDUCE",
        "origin": "USER",
        "topUp": null,
        "revoke": 200,
        "orgMember": {
          "id": "om-xxxxxx",
          "name": "RAVI KUMAR"
        },
        "vehicleRegistrationNumber": "MH12AB1234",
        "remarks": "Trip cancelled",
        "doneBy": "Suresh",
        "apiReferenceKey": null,
        "customFieldValues": null
      }
    ]
  }
}

Response Fields

FieldTypeDescription
idstringId of the limit change.
timestampstringWhen the limit moved.
descriptionstringThe change as shown in the workspace ledger, e.g. Top up (API), Top up (admin), Revoke (admin).
sourcestringTOPUP or REDUCE.
originstring | nullWho triggered it — API (you), USER (your workspace team) or MEMBER (the member asked).
topUpnumber | nullAmount added to the limit.
revokenumber | nullAmount taken off the limit, as a positive number.
orgMemberobject{ id, name } of the member whose limit moved.
vehicleRegistrationNumberstring | nullVehicle the member was on, if any.
remarksstring | nullReason recorded with the change.
doneBystring | nullName of the workspace user who made the change; APP-API when it came through this API.
apiReferenceKeystring | nullThe idempotencyKey you sent on a top up you made through the API, so you can reconcile the row against your own system. Null on every other origin.
customFieldValuesobject | nullThe custom field values recorded on the top ups. Always null on a revoke.

Errors

Org-member feature not enabled:

{
  "status": "error",
  "errorCode": "failed",
  "message": "Org-member feature is not enabled for your organization"
}

Last updated on