Package com.chrt.api.resources.billing.billingledgers

Class BillingLedgersClient

java.lang.Object

com.chrt.api.resources.billing.billingledgers.BillingLedgersClient

public class BillingLedgersClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
BillingLedgersClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
java.lang.String	createV1(BillingLedgerClientCreate1 request)	Creates a billing ledger owned by the caller's org.
java.lang.String	createV1(BillingLedgerClientCreate1 request, RequestOptions requestOptions)	Creates a billing ledger owned by the caller's org.
boolean	deactivateV1(java.lang.String id)	Flips a billing ledger to INACTIVE and stamps inactive_at_timestamp.
boolean	deactivateV1(java.lang.String id, RequestOptions requestOptions)	Flips a billing ledger to INACTIVE and stamps inactive_at_timestamp.
BillingLedger1	getByIdV1(java.lang.String id)	Retrieves a billing ledger the caller's org owns or is a payment counterparty on.
BillingLedger1	getByIdV1(java.lang.String id, RequestOptions requestOptions)	Retrieves a billing ledger the caller's org owns or is a payment counterparty on.
BillingLedgerListRes	listV1()	Lists billing ledgers the caller's org owns or is a payment counterparty on.
BillingLedgerListRes	listV1(BillingLedgersListV1Request request)	Lists billing ledgers the caller's org owns or is a payment counterparty on.
BillingLedgerListRes	listV1(BillingLedgersListV1Request request, RequestOptions requestOptions)	Lists billing ledgers the caller's org owns or is a payment counterparty on.
boolean	updateV1(java.lang.String id)	Updates a billing ledger's name and comments.
boolean	updateV1(java.lang.String id, BillingLedgerClientUpdate1 request)	Updates a billing ledger's name and comments.
boolean	updateV1(java.lang.String id, BillingLedgerClientUpdate1 request, RequestOptions requestOptions)	Updates a billing ledger's name and comments.
RawBillingLedgersClient	withRawResponse()	Get responses with HTTP metadata like headers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

BillingLedgersClient

public BillingLedgersClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawBillingLedgersClient withRawResponse()

Get responses with HTTP metadata like headers

getByIdV1

public BillingLedger1 getByIdV1(java.lang.String id)

Retrieves a billing ledger the caller's org owns or is a payment counterparty on. | authz_personas=[billing_ledger_org_operators] | () -> (BillingLedger1)

getByIdV1

public BillingLedger1 getByIdV1(java.lang.String id,
                                RequestOptions requestOptions)

Retrieves a billing ledger the caller's org owns or is a payment counterparty on. | authz_personas=[billing_ledger_org_operators] | () -> (BillingLedger1)

listV1

public BillingLedgerListRes listV1()

Lists billing ledgers the caller's org owns or is a payment counterparty on. | authz_personas=[billing_ledger_org_operators] | () -> (BillingLedgerListRes)

listV1

public BillingLedgerListRes listV1(BillingLedgersListV1Request request)

Lists billing ledgers the caller's org owns or is a payment counterparty on. | authz_personas=[billing_ledger_org_operators] | () -> (BillingLedgerListRes)

listV1

public BillingLedgerListRes listV1(BillingLedgersListV1Request request,
                                   RequestOptions requestOptions)

Lists billing ledgers the caller's org owns or is a payment counterparty on. | authz_personas=[billing_ledger_org_operators] | () -> (BillingLedgerListRes)

createV1

public java.lang.String createV1(BillingLedgerClientCreate1 request)

Creates a billing ledger owned by the caller's org. Caller must be the receiving provider for shipper-pay-provider, or the paying provider for provider-pay-provider/driver. | authz: allowed_org_types=[provider], min_org_role=operator | (BillingLedgerClientCreate1) -> (PydanticObjectId)

createV1

public java.lang.String createV1(BillingLedgerClientCreate1 request,
                                 RequestOptions requestOptions)

Creates a billing ledger owned by the caller's org. Caller must be the receiving provider for shipper-pay-provider, or the paying provider for provider-pay-provider/driver. | authz: allowed_org_types=[provider], min_org_role=operator | (BillingLedgerClientCreate1) -> (PydanticObjectId)

updateV1

public boolean updateV1(java.lang.String id)

Updates a billing ledger's name and comments. Cycle and rate are per-period values supplied at billing_ledger_periods/open/v1 time; the ledger does not carry them. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[billing_ledger_owner_operators] | (BillingLedgerClientUpdate1) -> (bool)

updateV1

public boolean updateV1(java.lang.String id,
                        BillingLedgerClientUpdate1 request)

Updates a billing ledger's name and comments. Cycle and rate are per-period values supplied at billing_ledger_periods/open/v1 time; the ledger does not carry them. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[billing_ledger_owner_operators] | (BillingLedgerClientUpdate1) -> (bool)

updateV1

public boolean updateV1(java.lang.String id,
                        BillingLedgerClientUpdate1 request,
                        RequestOptions requestOptions)

Updates a billing ledger's name and comments. Cycle and rate are per-period values supplied at billing_ledger_periods/open/v1 time; the ledger does not carry them. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[billing_ledger_owner_operators] | (BillingLedgerClientUpdate1) -> (bool)

deactivateV1

public boolean deactivateV1(java.lang.String id)

Flips a billing ledger to INACTIVE and stamps inactive_at_timestamp. Idempotent; the current OPEN period is left untouched. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[billing_ledger_owner_operators] | () -> (bool)

deactivateV1

public boolean deactivateV1(java.lang.String id,
                            RequestOptions requestOptions)

Flips a billing ledger to INACTIVE and stamps inactive_at_timestamp. Idempotent; the current OPEN period is left untouched. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[billing_ledger_owner_operators] | () -> (bool)