package
2.85.0+incompatible
Repository: https://github.com/transcom/mymove.git
Documentation: pkg.go.dev
# Functions
NewGetPaymentRequestEDI creates a new http.Handler for the get payment request e d i operation.
NewGetPaymentRequestEDIBadRequest creates GetPaymentRequestEDIBadRequest with default headers values.
NewGetPaymentRequestEDIConflict creates GetPaymentRequestEDIConflict with default headers values.
NewGetPaymentRequestEDIForbidden creates GetPaymentRequestEDIForbidden with default headers values.
NewGetPaymentRequestEDIInternalServerError creates GetPaymentRequestEDIInternalServerError with default headers values.
NewGetPaymentRequestEDINotFound creates GetPaymentRequestEDINotFound with default headers values.
NewGetPaymentRequestEDIOK creates GetPaymentRequestEDIOK with default headers values.
NewGetPaymentRequestEDIParams creates a new GetPaymentRequestEDIParams object
There are no default values defined in the spec.
NewGetPaymentRequestEDIUnauthorized creates GetPaymentRequestEDIUnauthorized with default headers values.
NewGetPaymentRequestEDIUnprocessableEntity creates GetPaymentRequestEDIUnprocessableEntity with default headers values.
NewListMTOPaymentRequests creates a new http.Handler for the list m t o payment requests operation.
NewListMTOPaymentRequestsBadRequest creates ListMTOPaymentRequestsBadRequest with default headers values.
NewListMTOPaymentRequestsForbidden creates ListMTOPaymentRequestsForbidden with default headers values.
NewListMTOPaymentRequestsInternalServerError creates ListMTOPaymentRequestsInternalServerError with default headers values.
NewListMTOPaymentRequestsNotFound creates ListMTOPaymentRequestsNotFound with default headers values.
NewListMTOPaymentRequestsOK creates ListMTOPaymentRequestsOK with default headers values.
NewListMTOPaymentRequestsParams creates a new ListMTOPaymentRequestsParams object
There are no default values defined in the spec.
NewListMTOPaymentRequestsUnauthorized creates ListMTOPaymentRequestsUnauthorized with default headers values.
NewProcessReviewedPaymentRequests creates a new http.Handler for the process reviewed payment requests operation.
NewProcessReviewedPaymentRequestsBadRequest creates ProcessReviewedPaymentRequestsBadRequest with default headers values.
NewProcessReviewedPaymentRequestsForbidden creates ProcessReviewedPaymentRequestsForbidden with default headers values.
NewProcessReviewedPaymentRequestsInternalServerError creates ProcessReviewedPaymentRequestsInternalServerError with default headers values.
NewProcessReviewedPaymentRequestsNotFound creates ProcessReviewedPaymentRequestsNotFound with default headers values.
NewProcessReviewedPaymentRequestsOK creates ProcessReviewedPaymentRequestsOK with default headers values.
NewProcessReviewedPaymentRequestsParams creates a new ProcessReviewedPaymentRequestsParams object
There are no default values defined in the spec.
NewProcessReviewedPaymentRequestsUnauthorized creates ProcessReviewedPaymentRequestsUnauthorized with default headers values.
NewProcessReviewedPaymentRequestsUnprocessableEntity creates ProcessReviewedPaymentRequestsUnprocessableEntity with default headers values.
NewRecalculatePaymentRequest creates a new http.Handler for the recalculate payment request operation.
NewRecalculatePaymentRequestBadRequest creates RecalculatePaymentRequestBadRequest with default headers values.
NewRecalculatePaymentRequestConflict creates RecalculatePaymentRequestConflict with default headers values.
NewRecalculatePaymentRequestCreated creates RecalculatePaymentRequestCreated with default headers values.
NewRecalculatePaymentRequestForbidden creates RecalculatePaymentRequestForbidden with default headers values.
NewRecalculatePaymentRequestInternalServerError creates RecalculatePaymentRequestInternalServerError with default headers values.
NewRecalculatePaymentRequestNotFound creates RecalculatePaymentRequestNotFound with default headers values.
NewRecalculatePaymentRequestParams creates a new RecalculatePaymentRequestParams object
There are no default values defined in the spec.
NewRecalculatePaymentRequestPreconditionFailed creates RecalculatePaymentRequestPreconditionFailed with default headers values.
NewRecalculatePaymentRequestUnauthorized creates RecalculatePaymentRequestUnauthorized with default headers values.
NewRecalculatePaymentRequestUnprocessableEntity creates RecalculatePaymentRequestUnprocessableEntity with default headers values.
NewUpdatePaymentRequestStatus creates a new http.Handler for the update payment request status operation.
NewUpdatePaymentRequestStatusBadRequest creates UpdatePaymentRequestStatusBadRequest with default headers values.
NewUpdatePaymentRequestStatusConflict creates UpdatePaymentRequestStatusConflict with default headers values.
NewUpdatePaymentRequestStatusForbidden creates UpdatePaymentRequestStatusForbidden with default headers values.
NewUpdatePaymentRequestStatusInternalServerError creates UpdatePaymentRequestStatusInternalServerError with default headers values.
NewUpdatePaymentRequestStatusNotFound creates UpdatePaymentRequestStatusNotFound with default headers values.
NewUpdatePaymentRequestStatusOK creates UpdatePaymentRequestStatusOK with default headers values.
NewUpdatePaymentRequestStatusParams creates a new UpdatePaymentRequestStatusParams object
There are no default values defined in the spec.
NewUpdatePaymentRequestStatusPreconditionFailed creates UpdatePaymentRequestStatusPreconditionFailed with default headers values.
NewUpdatePaymentRequestStatusUnauthorized creates UpdatePaymentRequestStatusUnauthorized with default headers values.
NewUpdatePaymentRequestStatusUnprocessableEntity creates UpdatePaymentRequestStatusUnprocessableEntity with default headers values.
# Constants
GetPaymentRequestEDIBadRequestCode is the HTTP code returned for type GetPaymentRequestEDIBadRequest.
GetPaymentRequestEDIConflictCode is the HTTP code returned for type GetPaymentRequestEDIConflict.
GetPaymentRequestEDIForbiddenCode is the HTTP code returned for type GetPaymentRequestEDIForbidden.
GetPaymentRequestEDIInternalServerErrorCode is the HTTP code returned for type GetPaymentRequestEDIInternalServerError.
GetPaymentRequestEDINotFoundCode is the HTTP code returned for type GetPaymentRequestEDINotFound.
GetPaymentRequestEDIOKCode is the HTTP code returned for type GetPaymentRequestEDIOK.
GetPaymentRequestEDIUnauthorizedCode is the HTTP code returned for type GetPaymentRequestEDIUnauthorized.
GetPaymentRequestEDIUnprocessableEntityCode is the HTTP code returned for type GetPaymentRequestEDIUnprocessableEntity.
ListMTOPaymentRequestsBadRequestCode is the HTTP code returned for type ListMTOPaymentRequestsBadRequest.
ListMTOPaymentRequestsForbiddenCode is the HTTP code returned for type ListMTOPaymentRequestsForbidden.
ListMTOPaymentRequestsInternalServerErrorCode is the HTTP code returned for type ListMTOPaymentRequestsInternalServerError.
ListMTOPaymentRequestsNotFoundCode is the HTTP code returned for type ListMTOPaymentRequestsNotFound.
ListMTOPaymentRequestsOKCode is the HTTP code returned for type ListMTOPaymentRequestsOK.
ListMTOPaymentRequestsUnauthorizedCode is the HTTP code returned for type ListMTOPaymentRequestsUnauthorized.
ProcessReviewedPaymentRequestsBadRequestCode is the HTTP code returned for type ProcessReviewedPaymentRequestsBadRequest.
ProcessReviewedPaymentRequestsForbiddenCode is the HTTP code returned for type ProcessReviewedPaymentRequestsForbidden.
ProcessReviewedPaymentRequestsInternalServerErrorCode is the HTTP code returned for type ProcessReviewedPaymentRequestsInternalServerError.
ProcessReviewedPaymentRequestsNotFoundCode is the HTTP code returned for type ProcessReviewedPaymentRequestsNotFound.
ProcessReviewedPaymentRequestsOKCode is the HTTP code returned for type ProcessReviewedPaymentRequestsOK.
ProcessReviewedPaymentRequestsUnauthorizedCode is the HTTP code returned for type ProcessReviewedPaymentRequestsUnauthorized.
ProcessReviewedPaymentRequestsUnprocessableEntityCode is the HTTP code returned for type ProcessReviewedPaymentRequestsUnprocessableEntity.
RecalculatePaymentRequestBadRequestCode is the HTTP code returned for type RecalculatePaymentRequestBadRequest.
RecalculatePaymentRequestConflictCode is the HTTP code returned for type RecalculatePaymentRequestConflict.
RecalculatePaymentRequestCreatedCode is the HTTP code returned for type RecalculatePaymentRequestCreated.
RecalculatePaymentRequestForbiddenCode is the HTTP code returned for type RecalculatePaymentRequestForbidden.
RecalculatePaymentRequestInternalServerErrorCode is the HTTP code returned for type RecalculatePaymentRequestInternalServerError.
RecalculatePaymentRequestNotFoundCode is the HTTP code returned for type RecalculatePaymentRequestNotFound.
RecalculatePaymentRequestPreconditionFailedCode is the HTTP code returned for type RecalculatePaymentRequestPreconditionFailed.
RecalculatePaymentRequestUnauthorizedCode is the HTTP code returned for type RecalculatePaymentRequestUnauthorized.
RecalculatePaymentRequestUnprocessableEntityCode is the HTTP code returned for type RecalculatePaymentRequestUnprocessableEntity.
UpdatePaymentRequestStatusBadRequestCode is the HTTP code returned for type UpdatePaymentRequestStatusBadRequest.
UpdatePaymentRequestStatusConflictCode is the HTTP code returned for type UpdatePaymentRequestStatusConflict.
UpdatePaymentRequestStatusForbiddenCode is the HTTP code returned for type UpdatePaymentRequestStatusForbidden.
UpdatePaymentRequestStatusInternalServerErrorCode is the HTTP code returned for type UpdatePaymentRequestStatusInternalServerError.
UpdatePaymentRequestStatusNotFoundCode is the HTTP code returned for type UpdatePaymentRequestStatusNotFound.
UpdatePaymentRequestStatusOKCode is the HTTP code returned for type UpdatePaymentRequestStatusOK.
UpdatePaymentRequestStatusPreconditionFailedCode is the HTTP code returned for type UpdatePaymentRequestStatusPreconditionFailed.
UpdatePaymentRequestStatusUnauthorizedCode is the HTTP code returned for type UpdatePaymentRequestStatusUnauthorized.
UpdatePaymentRequestStatusUnprocessableEntityCode is the HTTP code returned for type UpdatePaymentRequestStatusUnprocessableEntity.
# Structs
GetPaymentRequestEDI swagger:route GET /payment-requests/{paymentRequestID}/edi paymentRequest getPaymentRequestEDI
getPaymentRequestEDI
Returns the EDI (Electronic Data Interchange) message for the payment request identified
by the given payment request ID.
GetPaymentRequestEDIBadRequest The request payload is invalid.
GetPaymentRequestEDIConflict There was a conflict with the request.
GetPaymentRequestEDIForbidden The request was denied.
GetPaymentRequestEDIInternalServerError A server error occurred.
GetPaymentRequestEDINotFound The requested resource wasn't found.
GetPaymentRequestEDIOK Successfully retrieved payment requests associated with a given move task order
swagger:response getPaymentRequestEDIOK
*/.
GetPaymentRequestEDIParams contains all the bound params for the get payment request e d i operation typically these are obtained from a http.Request
swagger:parameters getPaymentRequestEDI.
GetPaymentRequestEDIUnauthorized The request was denied.
GetPaymentRequestEDIUnprocessableEntity The payload was unprocessable.
GetPaymentRequestEDIURL generates an URL for the get payment request e d i operation.
ListMTOPaymentRequests swagger:route GET /move-task-orders/{moveTaskOrderID}/payment-requests paymentRequest listMTOPaymentRequests
listMTOPaymentRequests
### Functionality
This endpoint lists all PaymentRequests associated with a given MoveTaskOrder.
ListMTOPaymentRequestsBadRequest The request payload is invalid.
ListMTOPaymentRequestsForbidden The request was denied.
ListMTOPaymentRequestsInternalServerError A server error occurred.
ListMTOPaymentRequestsNotFound The requested resource wasn't found.
ListMTOPaymentRequestsOK Successfully retrieved payment requests associated with a given move task order
swagger:response listMTOPaymentRequestsOK
*/.
ListMTOPaymentRequestsParams contains all the bound params for the list m t o payment requests operation typically these are obtained from a http.Request
swagger:parameters listMTOPaymentRequests.
ListMTOPaymentRequestsUnauthorized The request was denied.
ListMTOPaymentRequestsURL generates an URL for the list m t o payment requests operation.
ProcessReviewedPaymentRequests swagger:route PATCH /payment-requests/process-reviewed paymentRequest processReviewedPaymentRequests
processReviewedPaymentRequests
Updates the status of reviewed payment requests and sends PRs to Syncada if
the SendToSyncada flag is set
This is a support endpoint and will not be available in production.
ProcessReviewedPaymentRequestsBadRequest The request payload is invalid.
ProcessReviewedPaymentRequestsForbidden The request was denied.
ProcessReviewedPaymentRequestsInternalServerError A server error occurred.
ProcessReviewedPaymentRequestsNotFound The requested resource wasn't found.
ProcessReviewedPaymentRequestsOK Successfully updated status of reviewed payment request and sent to Syncada if that flag is set
swagger:response processReviewedPaymentRequestsOK
*/.
ProcessReviewedPaymentRequestsParams contains all the bound params for the process reviewed payment requests operation typically these are obtained from a http.Request
swagger:parameters processReviewedPaymentRequests.
ProcessReviewedPaymentRequestsUnauthorized The request was denied.
ProcessReviewedPaymentRequestsUnprocessableEntity The payload was unprocessable.
ProcessReviewedPaymentRequestsURL generates an URL for the process reviewed payment requests operation.
RecalculatePaymentRequest swagger:route POST /payment-requests/{paymentRequestID}/recalculate paymentRequest recalculatePaymentRequest
recalculatePaymentRequest
Recalculates an existing pending payment request by creating a new payment request for the same service
items but is priced based on the current inputs (weights, dates, etc.).
RecalculatePaymentRequestBadRequest The request payload is invalid.
RecalculatePaymentRequestConflict There was a conflict with the request.
RecalculatePaymentRequestCreated The new payment request with recalculated pricing.
RecalculatePaymentRequestForbidden The request was denied.
RecalculatePaymentRequestInternalServerError A server error occurred.
RecalculatePaymentRequestNotFound The requested resource wasn't found.
RecalculatePaymentRequestParams contains all the bound params for the recalculate payment request operation typically these are obtained from a http.Request
swagger:parameters recalculatePaymentRequest.
RecalculatePaymentRequestPreconditionFailed Precondition failed, likely due to a stale eTag (If-Match).
RecalculatePaymentRequestUnauthorized The request was denied.
RecalculatePaymentRequestUnprocessableEntity The payload was unprocessable.
RecalculatePaymentRequestURL generates an URL for the recalculate payment request operation.
UpdatePaymentRequestStatus swagger:route PATCH /payment-requests/{paymentRequestID}/status paymentRequest updatePaymentRequestStatus
updatePaymentRequestStatus
Updates status of a payment request to REVIEWED, SENT_TO_GEX, TPPS_RECEIVED, REVIEWED_AND_ALL_SERVICE_ITEMS_REJECTED, PAID, EDI_ERROR, or DEPRECATED.
UpdatePaymentRequestStatusBadRequest The request payload is invalid.
UpdatePaymentRequestStatusConflict There was a conflict with the request.
UpdatePaymentRequestStatusForbidden The request was denied.
UpdatePaymentRequestStatusInternalServerError A server error occurred.
UpdatePaymentRequestStatusNotFound The requested resource wasn't found.
UpdatePaymentRequestStatusOK Successfully updated payment request status.
UpdatePaymentRequestStatusParams contains all the bound params for the update payment request status operation typically these are obtained from a http.Request
swagger:parameters updatePaymentRequestStatus.
UpdatePaymentRequestStatusPreconditionFailed Precondition failed, likely due to a stale eTag (If-Match).
UpdatePaymentRequestStatusUnauthorized The request was denied.
UpdatePaymentRequestStatusUnprocessableEntity The payload was unprocessable.
UpdatePaymentRequestStatusURL generates an URL for the update payment request status operation.
# Interfaces
GetPaymentRequestEDIHandler interface for that can handle valid get payment request e d i params.
ListMTOPaymentRequestsHandler interface for that can handle valid list m t o payment requests params.
ProcessReviewedPaymentRequestsHandler interface for that can handle valid process reviewed payment requests params.
RecalculatePaymentRequestHandler interface for that can handle valid recalculate payment request params.
UpdatePaymentRequestStatusHandler interface for that can handle valid update payment request status params.
# Type aliases
GetPaymentRequestEDIHandlerFunc turns a function with the right signature into a get payment request e d i handler.
ListMTOPaymentRequestsHandlerFunc turns a function with the right signature into a list m t o payment requests handler.
ProcessReviewedPaymentRequestsHandlerFunc turns a function with the right signature into a process reviewed payment requests handler.
RecalculatePaymentRequestHandlerFunc turns a function with the right signature into a recalculate payment request handler.
UpdatePaymentRequestStatusHandlerFunc turns a function with the right signature into a update payment request status handler.