Package com.chrt.api.resources.billing.statements

Class RawStatementsClient

java.lang.Object

com.chrt.api.resources.billing.statements.RawStatementsClient

public class RawStatementsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
RawStatementsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
ChrtApiHttpResponse<Statement1>	createV1(CreateStatementReq request)	Creates a new statement without LIG IDs, starting in STAGED status.
ChrtApiHttpResponse<Statement1>	createV1(CreateStatementReq request, RequestOptions requestOptions)	Creates a new statement without LIG IDs, starting in STAGED status.
ChrtApiHttpResponse<java.lang.Boolean>	deleteV1(java.lang.String statementId)	Deletes a statement.
ChrtApiHttpResponse<java.lang.Boolean>	deleteV1(java.lang.String statementId, RequestOptions requestOptions)	Deletes a statement.
ChrtApiHttpResponse<StatementExpandedRes>	expandedRetrieveV1(StatementExpandedRetrieveReq request)	Retrieves a statement with its associated LineItemGroups expanded.
ChrtApiHttpResponse<StatementExpandedRes>	expandedRetrieveV1(StatementExpandedRetrieveReq request, RequestOptions requestOptions)	Retrieves a statement with its associated LineItemGroups expanded.
ChrtApiHttpResponse<Statement1>	getByLigIdV1(java.lang.String lineItemGroupId)	Gets a statement by its associated LineItemGroup ID.
ChrtApiHttpResponse<Statement1>	getByLigIdV1(java.lang.String lineItemGroupId, RequestOptions requestOptions)	Gets a statement by its associated LineItemGroup ID.
ChrtApiHttpResponse<Statement1>	getV1(java.lang.String statementId)	Gets a statement by ID.
ChrtApiHttpResponse<Statement1>	getV1(java.lang.String statementId, RequestOptions requestOptions)	Gets a statement by ID.
ChrtApiHttpResponse<StatementsListRes>	listV1()	Lists statements with filtering, sorting, and pagination.
ChrtApiHttpResponse<StatementsListRes>	listV1(StatementsListV1Request request)	Lists statements with filtering, sorting, and pagination.
ChrtApiHttpResponse<StatementsListRes>	listV1(StatementsListV1Request request, RequestOptions requestOptions)	Lists statements with filtering, sorting, and pagination.
ChrtApiHttpResponse<Statement1>	openInvoiceV1(java.lang.String statementId)	Opens a Stripe Connect invoice for a statement and attempt to send via email.
ChrtApiHttpResponse<Statement1>	openInvoiceV1(java.lang.String statementId, OpenInvoiceReq request)	Opens a Stripe Connect invoice for a statement and attempt to send via email.
ChrtApiHttpResponse<Statement1>	openInvoiceV1(java.lang.String statementId, OpenInvoiceReq request, RequestOptions requestOptions)	Opens a Stripe Connect invoice for a statement and attempt to send via email.
ChrtApiHttpResponse<Statement1>	syncInvoiceV1(java.lang.String statementId)	Syncs invoice state from Stripe Connect to the Statement and LineItemGroups.
ChrtApiHttpResponse<Statement1>	syncInvoiceV1(java.lang.String statementId, RequestOptions requestOptions)	Syncs invoice state from Stripe Connect to the Statement and LineItemGroups.
ChrtApiHttpResponse<Statement1>	updateOffChrtSettlementStateV1(java.lang.String statementId, BodyStatementsPatchUpdateOffChrtSettlementStateV1BillingUpdateOffChrtSettlementStateV1StatementIdPatch request)	Updates the status of an off-CHRT settlement statement.
ChrtApiHttpResponse<Statement1>	updateOffChrtSettlementStateV1(java.lang.String statementId, BodyStatementsPatchUpdateOffChrtSettlementStateV1BillingUpdateOffChrtSettlementStateV1StatementIdPatch request, RequestOptions requestOptions)	Updates the status of an off-CHRT settlement statement.
ChrtApiHttpResponse<Statement1>	updateSettlementTypeV1(java.lang.String statementId, BodyStatementsPatchUpdateSettlementTypeV1BillingUpdateSettlementTypeV1StatementIdPatch request)	Updates the settlement type of a statement.
ChrtApiHttpResponse<Statement1>	updateSettlementTypeV1(java.lang.String statementId, BodyStatementsPatchUpdateSettlementTypeV1BillingUpdateSettlementTypeV1StatementIdPatch request, RequestOptions requestOptions)	Updates the settlement type of a statement.
ChrtApiHttpResponse<Statement1>	voidInvoiceV1(java.lang.String statementId)	Voids a Stripe Connect invoice.
ChrtApiHttpResponse<Statement1>	voidInvoiceV1(java.lang.String statementId, RequestOptions requestOptions)	Voids a Stripe Connect invoice.

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

RawStatementsClient

public RawStatementsClient(ClientOptions clientOptions)

Method Detail

getV1

public ChrtApiHttpResponse<Statement1> getV1(java.lang.String statementId)

Gets a statement by ID. | authz_personas=[statement_org_operators, statement_driver] | () -> (Statement1)

getV1

public ChrtApiHttpResponse<Statement1> getV1(java.lang.String statementId,
                                             RequestOptions requestOptions)

Gets a statement by ID. | authz_personas=[statement_org_operators, statement_driver] | () -> (Statement1)

getByLigIdV1

public ChrtApiHttpResponse<Statement1> getByLigIdV1(java.lang.String lineItemGroupId)

Gets a statement by its associated LineItemGroup ID. | authz_personas=[statement_org_operators, statement_driver] | () -> (Statement1)

getByLigIdV1

public ChrtApiHttpResponse<Statement1> getByLigIdV1(java.lang.String lineItemGroupId,
                                                    RequestOptions requestOptions)

Gets a statement by its associated LineItemGroup ID. | authz_personas=[statement_org_operators, statement_driver] | () -> (Statement1)

expandedRetrieveV1

public ChrtApiHttpResponse<StatementExpandedRes> expandedRetrieveV1(StatementExpandedRetrieveReq request)

Retrieves a statement with its associated LineItemGroups expanded. | authz_personas=[statement_org_operators, statement_driver] | (StatementExpandedRetrieveReq) -> (StatementExpandedRes)

expandedRetrieveV1

public ChrtApiHttpResponse<StatementExpandedRes> expandedRetrieveV1(StatementExpandedRetrieveReq request,
                                                                    RequestOptions requestOptions)

Retrieves a statement with its associated LineItemGroups expanded. | authz_personas=[statement_org_operators, statement_driver] | (StatementExpandedRetrieveReq) -> (StatementExpandedRes)

listV1

public ChrtApiHttpResponse<StatementsListRes> listV1()

Lists statements with filtering, sorting, and pagination. | authz_personas=[statement_org_operators, statement_driver] | () -> (StatementsListRes)

listV1

public ChrtApiHttpResponse<StatementsListRes> listV1(StatementsListV1Request request)

Lists statements with filtering, sorting, and pagination. | authz_personas=[statement_org_operators, statement_driver] | () -> (StatementsListRes)

listV1

public ChrtApiHttpResponse<StatementsListRes> listV1(StatementsListV1Request request,
                                                     RequestOptions requestOptions)

Lists statements with filtering, sorting, and pagination. | authz_personas=[statement_org_operators, statement_driver] | () -> (StatementsListRes)

createV1

public ChrtApiHttpResponse<Statement1> createV1(CreateStatementReq request)

Creates a new statement without LIG IDs, starting in STAGED status. Requires payment vector, origin, and destination. | authz: org_type=[courier, forwarder], min_org_role=operator | (CreateStatementReq) -> (Statement1)

createV1

public ChrtApiHttpResponse<Statement1> createV1(CreateStatementReq request,
                                                RequestOptions requestOptions)

Creates a new statement without LIG IDs, starting in STAGED status. Requires payment vector, origin, and destination. | authz: org_type=[courier, forwarder], min_org_role=operator | (CreateStatementReq) -> (Statement1)

deleteV1

public ChrtApiHttpResponse<java.lang.Boolean> deleteV1(java.lang.String statementId)

Deletes a statement. Only allowed if statement has no LineItemGroup IDs. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators] | () -> (bool)

deleteV1

public ChrtApiHttpResponse<java.lang.Boolean> deleteV1(java.lang.String statementId,
                                                       RequestOptions requestOptions)

Deletes a statement. Only allowed if statement has no LineItemGroup IDs. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators] | () -> (bool)

updateSettlementTypeV1

public ChrtApiHttpResponse<Statement1> updateSettlementTypeV1(java.lang.String statementId,
                                                              BodyStatementsPatchUpdateSettlementTypeV1BillingUpdateSettlementTypeV1StatementIdPatch request)

Updates the settlement type of a statement. Statement must be in STAGED status. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators], statement_status=STAGED | (SettlementTypeEnum1) -> (Statement1)

updateSettlementTypeV1

public ChrtApiHttpResponse<Statement1> updateSettlementTypeV1(java.lang.String statementId,
                                                              BodyStatementsPatchUpdateSettlementTypeV1BillingUpdateSettlementTypeV1StatementIdPatch request,
                                                              RequestOptions requestOptions)

Updates the settlement type of a statement. Statement must be in STAGED status. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators], statement_status=STAGED | (SettlementTypeEnum1) -> (Statement1)

updateOffChrtSettlementStateV1

public ChrtApiHttpResponse<Statement1> updateOffChrtSettlementStateV1(java.lang.String statementId,
                                                                      BodyStatementsPatchUpdateOffChrtSettlementStateV1BillingUpdateOffChrtSettlementStateV1StatementIdPatch request)

Updates the status of an off-CHRT settlement statement. Used to manually transition OFF_CHRT statements between STAGED, OPEN, PAID, and VOID. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators] | (StatementStatusEnum1) -> (Statement1)

updateOffChrtSettlementStateV1

public ChrtApiHttpResponse<Statement1> updateOffChrtSettlementStateV1(java.lang.String statementId,
                                                                      BodyStatementsPatchUpdateOffChrtSettlementStateV1BillingUpdateOffChrtSettlementStateV1StatementIdPatch request,
                                                                      RequestOptions requestOptions)

Updates the status of an off-CHRT settlement statement. Used to manually transition OFF_CHRT statements between STAGED, OPEN, PAID, and VOID. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators] | (StatementStatusEnum1) -> (Statement1)

openInvoiceV1

public ChrtApiHttpResponse<Statement1> openInvoiceV1(java.lang.String statementId)

Opens a Stripe Connect invoice for a statement and attempt to send via email. Org must have a Stripe Connect account. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators], statement_status=STAGED, line_item_groups_status=FINALIZED | (OpenInvoiceReq) -> (Statement1)

openInvoiceV1

public ChrtApiHttpResponse<Statement1> openInvoiceV1(java.lang.String statementId,
                                                     OpenInvoiceReq request)

Opens a Stripe Connect invoice for a statement and attempt to send via email. Org must have a Stripe Connect account. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators], statement_status=STAGED, line_item_groups_status=FINALIZED | (OpenInvoiceReq) -> (Statement1)

openInvoiceV1

public ChrtApiHttpResponse<Statement1> openInvoiceV1(java.lang.String statementId,
                                                     OpenInvoiceReq request,
                                                     RequestOptions requestOptions)

Opens a Stripe Connect invoice for a statement and attempt to send via email. Org must have a Stripe Connect account. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators], statement_status=STAGED, line_item_groups_status=FINALIZED | (OpenInvoiceReq) -> (Statement1)

syncInvoiceV1

public ChrtApiHttpResponse<Statement1> syncInvoiceV1(java.lang.String statementId)

Syncs invoice state from Stripe Connect to the Statement and LineItemGroups. The webhook usually keeps invoices up to date, but users can manually trigger a sync. | authz: org_type=[courier, forwarder, shipper], min_org_role=operator, authz_personas=[statement_org_operators] | () -> (Statement1)

syncInvoiceV1

public ChrtApiHttpResponse<Statement1> syncInvoiceV1(java.lang.String statementId,
                                                     RequestOptions requestOptions)

Syncs invoice state from Stripe Connect to the Statement and LineItemGroups. The webhook usually keeps invoices up to date, but users can manually trigger a sync. | authz: org_type=[courier, forwarder, shipper], min_org_role=operator, authz_personas=[statement_org_operators] | () -> (Statement1)

voidInvoiceV1

public ChrtApiHttpResponse<Statement1> voidInvoiceV1(java.lang.String statementId)

Voids a Stripe Connect invoice. Statement reverts to STAGED and LIGs revert to FINALIZED. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators], statement_status=OPEN | () -> (Statement1)

voidInvoiceV1

public ChrtApiHttpResponse<Statement1> voidInvoiceV1(java.lang.String statementId,
                                                     RequestOptions requestOptions)

Voids a Stripe Connect invoice. Statement reverts to STAGED and LIGs revert to FINALIZED. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators], statement_status=OPEN | () -> (Statement1)