Package com.chrt.api.resources.billing.lineitemgroups

Class RawLineItemGroupsClient

java.lang.Object

com.chrt.api.resources.billing.lineitemgroups.RawLineItemGroupsClient

public class RawLineItemGroupsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
RawLineItemGroupsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
ChrtApiHttpResponse<LineItemGroup1>	adjustLineItemV1(java.lang.String lineItemGroupId, AdjustLineItemReq request)	Adjusts a line item within a line item group.
ChrtApiHttpResponse<LineItemGroup1>	adjustLineItemV1(java.lang.String lineItemGroupId, AdjustLineItemReq request, RequestOptions requestOptions)	Adjusts a line item within a line item group.
ChrtApiHttpResponse<LineItemGroup1>	associateWithStatementV1(java.lang.String lineItemGroupId, LineItemGroupsAssociateWithStatementV1Request request)	Associates a line item group with a statement.
ChrtApiHttpResponse<LineItemGroup1>	associateWithStatementV1(java.lang.String lineItemGroupId, LineItemGroupsAssociateWithStatementV1Request request, RequestOptions requestOptions)	Associates a line item group with a statement.
ChrtApiHttpResponse<LineItemGroup1>	calculateLineItemsV1(java.lang.String lineItemGroupId)	(Re)calculates line items for a line item group.
ChrtApiHttpResponse<LineItemGroup1>	calculateLineItemsV1(java.lang.String lineItemGroupId, RequestOptions requestOptions)	(Re)calculates line items for a line item group.
ChrtApiHttpResponse<LineItemGroup1>	finalizeV1(java.lang.String lineItemGroupId)	Finalizes a line item group.
ChrtApiHttpResponse<LineItemGroup1>	finalizeV1(java.lang.String lineItemGroupId, RequestOptions requestOptions)	Finalizes a line item group.
ChrtApiHttpResponse<LineItemGroup1>	getV1(java.lang.String lineItemGroupId)	Gets a line item group by ID.
ChrtApiHttpResponse<LineItemGroup1>	getV1(java.lang.String lineItemGroupId, RequestOptions requestOptions)	Gets a line item group by ID.
ChrtApiHttpResponse<LineItemGroupListRes>	listForCourierOrgV1()	Lists line item groups for the authenticated courier organization with filtering and pagination.
ChrtApiHttpResponse<LineItemGroupListRes>	listForCourierOrgV1(LineItemGroupsListForCourierOrgV1Request request)	Lists line item groups for the authenticated courier organization with filtering and pagination.
ChrtApiHttpResponse<LineItemGroupListRes>	listForCourierOrgV1(LineItemGroupsListForCourierOrgV1Request request, RequestOptions requestOptions)	Lists line item groups for the authenticated courier organization with filtering and pagination.

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

RawLineItemGroupsClient

public RawLineItemGroupsClient(ClientOptions clientOptions)

Method Detail

getV1

public ChrtApiHttpResponse<LineItemGroup1> getV1(java.lang.String lineItemGroupId)

Gets a line item group by ID. | authz_personas=[lig_org_operators, lig_driver] | () -> (LineItemGroup1)

getV1

public ChrtApiHttpResponse<LineItemGroup1> getV1(java.lang.String lineItemGroupId,
                                                 RequestOptions requestOptions)

Gets a line item group by ID. | authz_personas=[lig_org_operators, lig_driver] | () -> (LineItemGroup1)

listForCourierOrgV1

public ChrtApiHttpResponse<LineItemGroupListRes> listForCourierOrgV1()

Lists line item groups for the authenticated courier organization with filtering and pagination. | org_type=[courier], min_org_role=operator | () -> (LineItemGroupListRes)

listForCourierOrgV1

public ChrtApiHttpResponse<LineItemGroupListRes> listForCourierOrgV1(LineItemGroupsListForCourierOrgV1Request request)

Lists line item groups for the authenticated courier organization with filtering and pagination. | org_type=[courier], min_org_role=operator | () -> (LineItemGroupListRes)

listForCourierOrgV1

public ChrtApiHttpResponse<LineItemGroupListRes> listForCourierOrgV1(LineItemGroupsListForCourierOrgV1Request request,
                                                                     RequestOptions requestOptions)

Lists line item groups for the authenticated courier organization with filtering and pagination. | org_type=[courier], min_org_role=operator | () -> (LineItemGroupListRes)

finalizeV1

public ChrtApiHttpResponse<LineItemGroup1> finalizeV1(java.lang.String lineItemGroupId)

Finalizes a line item group. LIG must be in ADJUSTABLE status. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | () -> (LineItemGroup1)

finalizeV1

public ChrtApiHttpResponse<LineItemGroup1> finalizeV1(java.lang.String lineItemGroupId,
                                                      RequestOptions requestOptions)

Finalizes a line item group. LIG must be in ADJUSTABLE status. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | () -> (LineItemGroup1)

calculateLineItemsV1

public ChrtApiHttpResponse<LineItemGroup1> calculateLineItemsV1(java.lang.String lineItemGroupId)

(Re)calculates line items for a line item group. LIG must be PENDING_CALCULATION or ADJUSTABLE and must be associated with a TaskGroup. Note: Line item calculation normally happens automatically; this route is primarily for PENDING_CALCULATION LIGs where automatic calculation failed (e.g., due to third-party service failure). | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | () -> (LineItemGroup1)

calculateLineItemsV1

public ChrtApiHttpResponse<LineItemGroup1> calculateLineItemsV1(java.lang.String lineItemGroupId,
                                                                RequestOptions requestOptions)

(Re)calculates line items for a line item group. LIG must be PENDING_CALCULATION or ADJUSTABLE and must be associated with a TaskGroup. Note: Line item calculation normally happens automatically; this route is primarily for PENDING_CALCULATION LIGs where automatic calculation failed (e.g., due to third-party service failure). | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | () -> (LineItemGroup1)

associateWithStatementV1

public ChrtApiHttpResponse<LineItemGroup1> associateWithStatementV1(java.lang.String lineItemGroupId,
                                                                    LineItemGroupsAssociateWithStatementV1Request request)

Associates a line item group with a statement. LIG must be PENDING_RATES, PENDING_CALCULATION, ADJUSTABLE, or FINALIZED (before OPEN). Statement must be OPEN. LIG payment info must match Statement. Also removes from previous statement if any. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators, statement_owner_operators] | (PydanticObjectId) -> (LineItemGroup1)

associateWithStatementV1

public ChrtApiHttpResponse<LineItemGroup1> associateWithStatementV1(java.lang.String lineItemGroupId,
                                                                    LineItemGroupsAssociateWithStatementV1Request request,
                                                                    RequestOptions requestOptions)

Associates a line item group with a statement. LIG must be PENDING_RATES, PENDING_CALCULATION, ADJUSTABLE, or FINALIZED (before OPEN). Statement must be OPEN. LIG payment info must match Statement. Also removes from previous statement if any. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators, statement_owner_operators] | (PydanticObjectId) -> (LineItemGroup1)

adjustLineItemV1

public ChrtApiHttpResponse<LineItemGroup1> adjustLineItemV1(java.lang.String lineItemGroupId,
                                                            AdjustLineItemReq request)

Adjusts a line item within a line item group. LIG must be ADJUSTABLE. Adjustment can be negative beyond item.amount to serve as a credit. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (AdjustLineItemReq) -> (LineItemGroup1)

adjustLineItemV1

public ChrtApiHttpResponse<LineItemGroup1> adjustLineItemV1(java.lang.String lineItemGroupId,
                                                            AdjustLineItemReq request,
                                                            RequestOptions requestOptions)

Adjusts a line item within a line item group. LIG must be ADJUSTABLE. Adjustment can be negative beyond item.amount to serve as a credit. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (AdjustLineItemReq) -> (LineItemGroup1)