Package com.chrt.api.resources.shipperpaycourierpayments

Class RawShipperPayCourierPaymentsClient

java.lang.Object

com.chrt.api.resources.shipperpaycourierpayments.RawShipperPayCourierPaymentsClient

public class RawShipperPayCourierPaymentsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
RawShipperPayCourierPaymentsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
ChrtApiHttpResponse<java.lang.String>	createV1(CreateShipperPayCourierPaymentReq request)	Creates a shipper-to-courier payment record based on all task groups in an order.
ChrtApiHttpResponse<java.lang.String>	createV1(CreateShipperPayCourierPaymentReq request, RequestOptions requestOptions)	Creates a shipper-to-courier payment record based on all task groups in an order.
ChrtApiHttpResponse<java.lang.Boolean>	deleteV1(java.lang.String shipperPayCourierPaymentId)	Deletes a shipper-to-courier payment record if invoice not yet created.
ChrtApiHttpResponse<java.lang.Boolean>	deleteV1(java.lang.String shipperPayCourierPaymentId, RequestOptions requestOptions)	Deletes a shipper-to-courier payment record if invoice not yet created.
ChrtApiHttpResponse<ShipperPayCourierStatement1>	getByIdV1(java.lang.String shipperPayCourierPaymentId)	Retrieves a shipper pay courier payment by its ID with Stripe invoice sync.
ChrtApiHttpResponse<ShipperPayCourierStatement1>	getByIdV1(java.lang.String shipperPayCourierPaymentId, RequestOptions requestOptions)	Retrieves a shipper pay courier payment by its ID with Stripe invoice sync.
ChrtApiHttpResponse<ShipperPayCourierStatement1>	getByOrderIdOrShortIdV1(java.lang.String orderIdOrShortId)	Retrieves a shipper pay courier payment by order ID or short ID with Stripe invoice sync.
ChrtApiHttpResponse<ShipperPayCourierStatement1>	getByOrderIdOrShortIdV1(java.lang.String orderIdOrShortId, RequestOptions requestOptions)	Retrieves a shipper pay courier payment by order ID or short ID with Stripe invoice sync.
ChrtApiHttpResponse<GetShipperPayCourierPaymentsForShipperRes>	listByCourierOrgIdV1(ListPaymentsByCourierReq request)	Lists shipper pay courier payments by courier org ID with status filtering and Stripe sync.
ChrtApiHttpResponse<GetShipperPayCourierPaymentsForShipperRes>	listByCourierOrgIdV1(ListPaymentsByCourierReq request, RequestOptions requestOptions)	Lists shipper pay courier payments by courier org ID with status filtering and Stripe sync.
ChrtApiHttpResponse<GetShipperPayCourierPaymentsForShipperRes>	listByShipperOrgIdV1(ListPaymentsByShipperReq request)	Lists shipper pay courier payments by shipper org ID with status filtering and Stripe sync.
ChrtApiHttpResponse<GetShipperPayCourierPaymentsForShipperRes>	listByShipperOrgIdV1(ListPaymentsByShipperReq request, RequestOptions requestOptions)	Lists shipper pay courier payments by shipper org ID with status filtering and Stripe sync.
ChrtApiHttpResponse<PaymentPreviewResponse>	previewV1(CreateShipperPayCourierPaymentReq request)	Previews a shipper-to-courier payment showing task groups, line item groups, total amount, and readiness status.
ChrtApiHttpResponse<PaymentPreviewResponse>	previewV1(CreateShipperPayCourierPaymentReq request, RequestOptions requestOptions)	Previews a shipper-to-courier payment showing task groups, line item groups, total amount, and readiness status.

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

RawShipperPayCourierPaymentsClient

public RawShipperPayCourierPaymentsClient(ClientOptions clientOptions)

Method Detail

getByIdV1

public ChrtApiHttpResponse<ShipperPayCourierStatement1> getByIdV1(java.lang.String shipperPayCourierPaymentId)

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

getByIdV1

public ChrtApiHttpResponse<ShipperPayCourierStatement1> getByIdV1(java.lang.String shipperPayCourierPaymentId,
                                                                  RequestOptions requestOptions)

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

deleteV1

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

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

deleteV1

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

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

getByOrderIdOrShortIdV1

public ChrtApiHttpResponse<ShipperPayCourierStatement1> getByOrderIdOrShortIdV1(java.lang.String orderIdOrShortId)

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

getByOrderIdOrShortIdV1

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

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

listByShipperOrgIdV1

public ChrtApiHttpResponse<GetShipperPayCourierPaymentsForShipperRes> listByShipperOrgIdV1(ListPaymentsByShipperReq request)

Lists shipper pay courier payments by shipper org ID with status filtering and Stripe sync. | (ListPaymentsByShipperReq) -> (GetShipperPayCourierPaymentsForShipperRes)

listByShipperOrgIdV1

public ChrtApiHttpResponse<GetShipperPayCourierPaymentsForShipperRes> listByShipperOrgIdV1(ListPaymentsByShipperReq request,
                                                                                           RequestOptions requestOptions)

Lists shipper pay courier payments by shipper org ID with status filtering and Stripe sync. | (ListPaymentsByShipperReq) -> (GetShipperPayCourierPaymentsForShipperRes)

listByCourierOrgIdV1

public ChrtApiHttpResponse<GetShipperPayCourierPaymentsForShipperRes> listByCourierOrgIdV1(ListPaymentsByCourierReq request)

Lists shipper pay courier payments by courier org ID with status filtering and Stripe sync. | (ListPaymentsByCourierReq) -> (GetShipperPayCourierPaymentsForShipperRes)

listByCourierOrgIdV1

public ChrtApiHttpResponse<GetShipperPayCourierPaymentsForShipperRes> listByCourierOrgIdV1(ListPaymentsByCourierReq request,
                                                                                           RequestOptions requestOptions)

Lists shipper pay courier payments by courier org ID with status filtering and Stripe sync. | (ListPaymentsByCourierReq) -> (GetShipperPayCourierPaymentsForShipperRes)

createV1

public ChrtApiHttpResponse<java.lang.String> createV1(CreateShipperPayCourierPaymentReq request)

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

createV1

public ChrtApiHttpResponse<java.lang.String> createV1(CreateShipperPayCourierPaymentReq request,
                                                      RequestOptions requestOptions)

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

previewV1

public ChrtApiHttpResponse<PaymentPreviewResponse> previewV1(CreateShipperPayCourierPaymentReq request)

Previews a shipper-to-courier payment showing task groups, line item groups, total amount, and readiness status. | (CreateShipperPayCourierPaymentReq) -> (PaymentPreviewResponse)

previewV1

public ChrtApiHttpResponse<PaymentPreviewResponse> previewV1(CreateShipperPayCourierPaymentReq request,
                                                             RequestOptions requestOptions)

Previews a shipper-to-courier payment showing task groups, line item groups, total amount, and readiness status. | (CreateShipperPayCourierPaymentReq) -> (PaymentPreviewResponse)