Jump to

• Request
• Response

1a TPA Enrollment

post

/api/v2/tpa/enrollment

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

Header Parameters

• Authentification(required): string
  The protocol for the API requires a valid username and password for TPM.

Supported Media Types

• application/json

Request Body - application/json ()

• application/json

Root Schema : schema

Type: object

Show Source

• declineReason: string
  Description of reasoning for declining the program enrollment, required if the program enrollment is declined.

  Example: My company does not need financing.
• enrollmentDate: string
  Date of enrollment agreement. If not provided, the current datetime is used. (YYYY-MM-DD)

  Example: 2025-04-08
• gcUpdatedBy: object gcUpdatedBy
• programName(required): string
  TPA program name.

  Example: GammaProgram
• rateOverride: number
  Rate override per 30 days for early payment expressed in percent discount. If not provided, the program rate will be used if no existing override rate exists for this vendor/program. If an override exists, then that value will be used. If the value is set to 0, the program standard discount rate is used.

  Example: 1.6
• status: string
  Status of the vendor in the program. The available values are decline, select, accept and null. Decline will unenroll the vendor from the provided program if enrolled. Select will enroll the vendor with the option to select invoices for acceleration. Accept will enroll the vendor with the option for all the invoices to be accelerated. If Null, only a rate override will be performed.

  Example: accept
• vendorAgreedToBy: object vendorAgreedToBy
• vendorID(required): string
  Vendor ID.

  Example: AEGIS

{
    "required":[
        "vendorID",
        "programName"
    ],
    "type":"object",
    "properties":{
        "vendorID":{
            "type":"string",
            "description":"Vendor ID.",
            "example":"AEGIS",
            "nullable":true
        },
        "programName":{
            "type":"string",
            "description":"TPA program name.",
            "example":"GammaProgram",
            "nullable":true
        },
        "rateOverride":{
            "type":"number",
            "description":"Rate override per 30 days for early payment expressed in percent discount. If not provided, the program rate will be used if no existing override rate exists for this vendor/program. If an override exists, then that value will be used. If the value is set to 0, the program standard discount rate is used.",
            "example":"1.6",
            "nullable":false
        },
        "enrollmentDate":{
            "type":"string",
            "description":"Date of enrollment agreement. If not provided, the current datetime is used. (YYYY-MM-DD)",
            "example":"2025-04-08",
            "nullable":true
        },
        "gcUpdatedBy":{
            "type":"object",
            "properties":{
                "firstName":{
                    "type":"string",
                    "description":"First name of contact representing the General Contractor.",
                    "example":"John",
                    "nullable":true
                },
                "lastName":{
                    "type":"string",
                    "description":"Last name of contact representing the General Contractor.",
                    "example":"Doe",
                    "nullable":true
                },
                "email":{
                    "type":"string",
                    "description":"Email of contact representing the General Contractor.",
                    "example":"[e-mail]",
                    "nullable":true
                },
                "phone":{
                    "type":"string",
                    "description":"Phone number of contact representing the General Contractor.",
                    "example":"555-555-5555",
                    "nullable":true
                }
            }
        },
        "vendorAgreedToBy":{
            "type":"object",
            "properties":{
                "firstName":{
                    "type":"string",
                    "description":"First name of vendor contact",
                    "example":"Pablo",
                    "nullable":true
                },
                "lastName":{
                    "type":"string",
                    "description":"Last name of vendor contact",
                    "example":"Picasso",
                    "nullable":true
                },
                "email":{
                    "type":"string",
                    "description":"E-mail of vendor contact",
                    "example":"[e-mail]",
                    "nullable":true
                },
                "phone":{
                    "type":"string",
                    "description":"Phone number of vendor contact",
                    "example":"555-555-1881",
                    "nullable":true
                }
            }
        },
        "status":{
            "type":"string",
            "description":"Status of the vendor in the program. The available values are decline, select, accept and null. Decline will unenroll the vendor from the provided program if enrolled. Select will enroll the vendor with the option to select invoices for acceleration. Accept will enroll the vendor with the option for all the invoices to be accelerated. If Null, only a rate override will be performed.",
            "example":"accept",
            "nullable":true
        },
        "declineReason":{
            "type":"string",
            "description":"Description of reasoning for declining the program enrollment, required if the program enrollment is declined.",
            "example":"My company does not need financing.",
            "nullable":true
        }
    }
}

Nested Schema : gcUpdatedBy

Type: object

Show Source

• email: string
  Email of contact representing the General Contractor.

  Example: [e-mail]
• firstName: string
  First name of contact representing the General Contractor.

  Example: John
• lastName: string
  Last name of contact representing the General Contractor.

  Example: Doe
• phone: string
  Phone number of contact representing the General Contractor.

  Example: 555-555-5555

{
    "type":"object",
    "properties":{
        "firstName":{
            "type":"string",
            "description":"First name of contact representing the General Contractor.",
            "example":"John",
            "nullable":true
        },
        "lastName":{
            "type":"string",
            "description":"Last name of contact representing the General Contractor.",
            "example":"Doe",
            "nullable":true
        },
        "email":{
            "type":"string",
            "description":"Email of contact representing the General Contractor.",
            "example":"[e-mail]",
            "nullable":true
        },
        "phone":{
            "type":"string",
            "description":"Phone number of contact representing the General Contractor.",
            "example":"555-555-5555",
            "nullable":true
        }
    }
}

Nested Schema : vendorAgreedToBy

Type: object

Show Source

• email: string
  E-mail of vendor contact

  Example: [e-mail]
• firstName: string
  First name of vendor contact

  Example: Pablo
• lastName: string
  Last name of vendor contact

  Example: Picasso
• phone: string
  Phone number of vendor contact

  Example: 555-555-1881

{
    "type":"object",
    "properties":{
        "firstName":{
            "type":"string",
            "description":"First name of vendor contact",
            "example":"Pablo",
            "nullable":true
        },
        "lastName":{
            "type":"string",
            "description":"Last name of vendor contact",
            "example":"Picasso",
            "nullable":true
        },
        "email":{
            "type":"string",
            "description":"E-mail of vendor contact",
            "example":"[e-mail]",
            "nullable":true
        },
        "phone":{
            "type":"string",
            "description":"Phone number of vendor contact",
            "example":"555-555-1881",
            "nullable":true
        }
    }
}

Examples

Select an example Import TPA Enrollment (Program Rate Override and Program Accept) Request Import TPA Enrollment (Default Program Rate and Program Select) Request Import TPA Enrollment (Default Program Rate and Program Select) Request Import TPA Enrollment (Program Rate Updated) Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

The job was successfully created.

Body ()

Root Schema : schema

Type: object

Show Source

• URI: string
  Endpoint for job-audit retrieval

  Example: https://services.texturacorp.com/ebis/api/v2/tpa/enrollment/3000

{
    "type":"object",
    "properties":{
        "URI":{
            "type":"string",
            "description":"Endpoint for job-audit retrieval",
            "example":"https://services.texturacorp.com/ebis/api/v2/tpa/enrollment/3000",
            "nullable":true
        }
    }
}

Examples

Select an example Production Server: Import TPA enrollment response Test Server: Import TPA enrolllment response

Default Response

Links to working URLs

Links

Production URL

https://services.texturacorp.com/ebis/api/v2/tpa/enrollment

Test URL

https://usint1.texturacorp.com/ebis/api/v2/tpa/enrollment

Back to Top