Package com.chrt.api.resources.shipperpaycourierstatements

Class ShipperPayCourierStatementsClient

java.lang.Object

com.chrt.api.resources.shipperpaycourierstatements.ShipperPayCourierStatementsClient

public class ShipperPayCourierStatementsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
ShipperPayCourierStatementsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
java.lang.String	createV1(CreateShipperPayCourierStatementReq request)	Creates a shipper-to-courier statement record based on all task groups in an order.
java.lang.String	createV1(CreateShipperPayCourierStatementReq request, RequestOptions requestOptions)	Creates a shipper-to-courier statement record based on all task groups in an order.
boolean	deleteV1(java.lang.String shipperPayCourierStatementId)	Deletes a shipper-to-courier statement record if invoice not yet created.
boolean	deleteV1(java.lang.String shipperPayCourierStatementId, RequestOptions requestOptions)	Deletes a shipper-to-courier statement record if invoice not yet created.
ShipperPayCourierStatement1	getByIdV1(java.lang.String shipperPayCourierStatementId)	Retrieves a shipper pay courier statement by its ID with Stripe invoice sync.
ShipperPayCourierStatement1	getByIdV1(java.lang.String shipperPayCourierStatementId, RequestOptions requestOptions)	Retrieves a shipper pay courier statement by its ID with Stripe invoice sync.
ShipperPayCourierStatement1	getByOrderIdOrShortIdV1(java.lang.String orderIdOrShortId)	Retrieves a shipper pay courier statement by order ID or short ID with Stripe invoice sync.
ShipperPayCourierStatement1	getByOrderIdOrShortIdV1(java.lang.String orderIdOrShortId, RequestOptions requestOptions)	Retrieves a shipper pay courier statement by order ID or short ID with Stripe invoice sync.
GetShipperPayCourierStatementsForShipperRes	listByCourierOrgIdV1(ListStatementsByCourierReq request)	Lists shipper pay courier statements by courier org ID with status filtering and Stripe sync.
GetShipperPayCourierStatementsForShipperRes	listByCourierOrgIdV1(ListStatementsByCourierReq request, RequestOptions requestOptions)	Lists shipper pay courier statements by courier org ID with status filtering and Stripe sync.
GetShipperPayCourierStatementsForShipperRes	listByShipperOrgIdV1(ListStatementsByShipperReq request)	Lists shipper pay courier statements by shipper org ID with status filtering and Stripe sync.
GetShipperPayCourierStatementsForShipperRes	listByShipperOrgIdV1(ListStatementsByShipperReq request, RequestOptions requestOptions)	Lists shipper pay courier statements by shipper org ID with status filtering and Stripe sync.
StatementPreviewResponse	previewV1(CreateShipperPayCourierStatementReq request)	Previews a shipper-to-courier statement showing task groups, line item groups, total amount, and readiness status.
StatementPreviewResponse	previewV1(CreateShipperPayCourierStatementReq request, RequestOptions requestOptions)	Previews a shipper-to-courier statement showing task groups, line item groups, total amount, and readiness status.
RawShipperPayCourierStatementsClient	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

ShipperPayCourierStatementsClient

public ShipperPayCourierStatementsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawShipperPayCourierStatementsClient withRawResponse()

Get responses with HTTP metadata like headers

getByIdV1

public ShipperPayCourierStatement1 getByIdV1(java.lang.String shipperPayCourierStatementId)

Retrieves a shipper pay courier statement by its ID with Stripe invoice sync. | () -> (ShipperPayCourierStatement1)

getByIdV1

public ShipperPayCourierStatement1 getByIdV1(java.lang.String shipperPayCourierStatementId,
                                             RequestOptions requestOptions)

Retrieves a shipper pay courier statement by its ID with Stripe invoice sync. | () -> (ShipperPayCourierStatement1)

deleteV1

public boolean deleteV1(java.lang.String shipperPayCourierStatementId)

Deletes a shipper-to-courier statement record if invoice not yet created. | () -> (bool)

deleteV1

public boolean deleteV1(java.lang.String shipperPayCourierStatementId,
                        RequestOptions requestOptions)

Deletes a shipper-to-courier statement record if invoice not yet created. | () -> (bool)

getByOrderIdOrShortIdV1

public ShipperPayCourierStatement1 getByOrderIdOrShortIdV1(java.lang.String orderIdOrShortId)

Retrieves a shipper pay courier statement by order ID or short ID with Stripe invoice sync. | () -> (ShipperPayCourierStatement1)

getByOrderIdOrShortIdV1

public ShipperPayCourierStatement1 getByOrderIdOrShortIdV1(java.lang.String orderIdOrShortId,
                                                           RequestOptions requestOptions)

Retrieves a shipper pay courier statement by order ID or short ID with Stripe invoice sync. | () -> (ShipperPayCourierStatement1)

listByShipperOrgIdV1

public GetShipperPayCourierStatementsForShipperRes listByShipperOrgIdV1(ListStatementsByShipperReq request)

Lists shipper pay courier statements by shipper org ID with status filtering and Stripe sync. | (ListStatementsByShipperReq) -> (GetShipperPayCourierStatementsForShipperRes)

listByShipperOrgIdV1

public GetShipperPayCourierStatementsForShipperRes listByShipperOrgIdV1(ListStatementsByShipperReq request,
                                                                        RequestOptions requestOptions)

Lists shipper pay courier statements by shipper org ID with status filtering and Stripe sync. | (ListStatementsByShipperReq) -> (GetShipperPayCourierStatementsForShipperRes)

listByCourierOrgIdV1

public GetShipperPayCourierStatementsForShipperRes listByCourierOrgIdV1(ListStatementsByCourierReq request)

Lists shipper pay courier statements by courier org ID with status filtering and Stripe sync. | (ListStatementsByCourierReq) -> (GetShipperPayCourierStatementsForShipperRes)

listByCourierOrgIdV1

public GetShipperPayCourierStatementsForShipperRes listByCourierOrgIdV1(ListStatementsByCourierReq request,
                                                                        RequestOptions requestOptions)

Lists shipper pay courier statements by courier org ID with status filtering and Stripe sync. | (ListStatementsByCourierReq) -> (GetShipperPayCourierStatementsForShipperRes)

createV1

public java.lang.String createV1(CreateShipperPayCourierStatementReq request)

Creates a shipper-to-courier statement record based on all task groups in an order. | (CreateShipperPayCourierStatementReq) -> (PydanticObjectId)

createV1

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

Creates a shipper-to-courier statement record based on all task groups in an order. | (CreateShipperPayCourierStatementReq) -> (PydanticObjectId)

previewV1

public StatementPreviewResponse previewV1(CreateShipperPayCourierStatementReq request)

Previews a shipper-to-courier statement showing task groups, line item groups, total amount, and readiness status. | (CreateShipperPayCourierStatementReq) -> (StatementPreviewResponse)

previewV1

public StatementPreviewResponse previewV1(CreateShipperPayCourierStatementReq request,
                                          RequestOptions requestOptions)

Previews a shipper-to-courier statement showing task groups, line item groups, total amount, and readiness status. | (CreateShipperPayCourierStatementReq) -> (StatementPreviewResponse)