1b TPA Enrollment Audit
get
/api/v2/tpa/enrollment/{jobID}
This API facilitates the management of Textura Payment Accelerator (TPA) enrollment for General Contractors and their Vendors. It supports importing enrollment data, including program participation, rate overrides, and contact details. Users can enroll or unenroll participants, adjust rates, and update program information as needed.
Request
Path Parameters
-
jobID(required): integer(int64)
Unique identifier of the job number.
Header Parameters
-
Authentification(required): string
The protocol for the API requires a valid username and password for TPM.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Audit data included in response payload.
Root Schema : schema
Type:
Show Source
object-
audit: string
Example:
-
code: number
Status codeExample:
200 -
declineReason: string
Description of reasoning for declining the program enrollment.Example:
My company does not need financing. -
enrollmentDate: string
Example:
-
gcUpdatedBy: object
gcUpdatedBy
-
jobID: number
Example:
34889284 -
programName: string
Example:
-
rateOverride: number
Example:
-
status: string
Example:
SUCCESS -
total: number
Example:
1 -
totalDuplicate: number
Example:
0 -
totalError: number
Example:
0 -
totalInfo: number
Example:
0 -
totalSuccess: number
Example:
1 -
vendorAgreedToBy: object
vendorAgreedToBy
-
vendorId: number
Example:
Nested Schema : gcUpdatedBy
Type:
Show Source
object-
email: string
Example:
-
firstName: string
Example:
-
lastName: string
Example:
-
phone: string
Example:
Nested Schema : vendorAgreedToBy
Type:
Show Source
object-
email: string
Example:
-
firstName: string
Example:
-
lastName: string
Example:
-
phone: string
Example:
Examples
202 Response
Accepted. Encountered when the requestor has asked for request export data or an audit log, but the request is still in process.
Default Response
Links to working URLs
Links
- Production URL
-
https://services.texturacorp.com/ebis/api/v2/tpa/enrollment/{jobID}
- Test URL
-
https://usint1.textura.oraclecloud.com/ebis/api/v2/tpa/enrollment/{jobID}