3a Off-System Payments
post
/api/v2/off-system-payments
This API allows for the record of off-system payments made to the SubContractor (SC). In certain situations, a General Contractor (GC) may pay an SC outside of the TPM system. If payment information is saved within an ERP system, the details can be sent and recorded within TPM. The payload must contain explicit information regarding the payment made, including the check number, check paid, and check amount. The API will not accept payments that exceed the net invoice amount. For payments that are less than or equal to the net invoice amount, a new line is created within the payment menu. The payment will be referred to as a check and the invoice payment will be identified through a split payment method.
Request
Header Parameters
-
Authentification(required):
The protocol for the API requires a valid username and password for TPM.
Supported Media Types
- application/json
- application/json
Root Schema : schema
Type:
Show Source
object
-
checkNumber(required): string
2044512Example:
Check number of off-system payment
-
contractNumber(required): string
Example:
1
-
datePaid(required): string
Date the payment was paidExample:
2023-02-10
-
invoiceNumber(required): string
Subcontractor invoice numberExample:
Inv-1
-
paymentAmount(required): number
Amount of payment madeExample:
23400.34
-
projectNumber(required): string
Users unique project numberExample:
01-441-1EE
-
vendorId: string
Example:
AEGIS
Examples
Back to Top
Response
Supported Media Types
- application/json
200 Response
The job was successfully created.
Root Schema : schema
Type:
Show Source
object
-
URI: string
Endpoint for job-audit retrievalExample:
https://services.texturacorp.com/ebis/api/v2/off-system-payments/3000
Examples
Default Response
Links to working URLs
Links
- Production URL
-
https://services.texturacorp.com/ebis/api/v2/off-system-payments
- Test URL
-
https://usint1.texturacorp.com/ebis/api/v2/off-system-payments