Update Custom Ledger

Updates an existing custom ledger.

put

Path parameters

idstringRequired

The ID of the custom ledger to update.

Body

Represents a custom ledger in the billing system.

$metaall of | nullableOptional

Platform entity metadata.

auditall ofOptional

Contains audit-related details for the entity.

idstringOptional

The unique identifier of the custom ledger.

namestringOptional

Name of the custom ledger.

Example: Quarterly Revenue Ledger

externalIdsall ofOptional

External identifiers associated with the custom ledger.

sellerall ofOptional

vendorall ofOptional

billingStartDatestring · date-timeOptional

The start date of the billing period for the custom ledger.

Example: 2025-01-01T00:00:00.0000000+00:00

billingEndDatestring · date-timeOptional

The end date of the billing period for the custom ledger.

Example: 2025-03-31T23:59:59.0000000+00:00

notesstring | nullableOptional

Additional notes or comments about the custom ledger.

Example: Includes all transactions for Q1 2025.

statusall ofOptional

The current status of the custom ledger.

Example: Validated

string · enumOptional

Represents the various statuses a custom ledger can have in the billing system.

Possible values:

assigneeall ofOptional

priceall ofOptional

Pricing details associated with the custom ledger.

processingall ofOptional

Processing status and related details for the custom ledger, visible to operations.

errorall of | nullableOptional

Error details associated with the custom ledger, if any.

Responses

200

application/json

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

put

PUT /public/v1/billing/custom-ledgers/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 2580

{
  "$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",
    "erpLink": {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "icon": "text",
      "buyer": {
        "id": "text",
        "icon": "text",
        "name": "text"
      },
      "seller": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      },
      "name": "text",
      "status": "Active",
      "note": "text",
      "externalIds": {
        "erpCompanyContact": "text",
        "erpCustomer": "text",
        "accountExternalId": "text"
      },
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      }
    }
  },
  "vendor": {
    "id": "text",
    "icon": "text",
    "type": "Client",
    "status": "Active",
    "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
  },
  "error": {
    "errorCode": "ERR-001",
    "errorMessage": "Invalid billing data provided.",
    "id": "12345",
    "message": "Failed to process the billing entity due to missing 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",
    "erpLink": {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "icon": "text",
      "buyer": {
        "id": "text",
        "icon": "text",
        "name": "text"
      },
      "seller": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      },
      "name": "text",
      "status": "Active",
      "note": "text",
      "externalIds": {
        "erpCompanyContact": "text",
        "erpCustomer": "text",
        "accountExternalId": "text"
      },
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      }
    }
  },
  "vendor": {
    "id": "text",
    "icon": "text",
    "type": "Client",
    "status": "Active",
    "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
  },
  "error": {
    "errorCode": "ERR-001",
    "errorMessage": "Invalid billing data provided.",
    "id": "12345",
    "message": "Failed to process the billing entity due to missing data."
  }
}

PreviousCreate Custom Ledger NextDelete Custom Ledger

Last updated 1 month ago

Was this helpful?