3b Off-System Payments Audit
get
/api/v2/off-system-payments/{jobID}
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
Path Parameters
-
jobID(required): integer(int64)
Unique identifier of the job number.
Header Parameters
-
Authentification(required):
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:
Manual check imported
-
checkNumber: string
Example:
2044512
-
code: number
Status codeExample:
200
-
contractNumber: string
Example:
1
-
datePaid: string
Example:
2023-02-10
-
invoiceNumber: string
Example:
Inv-1
-
jobID: number
Example:
34889284
-
paymentAmount: number
Example:
23400.34
-
projectNumber: string
Example:
101-441-1EE
-
status: string
Example:
SUCCESS
-
total: number
Example:
1
-
totalDuplicate: number
Example:
0
-
totalError: number
Example:
0
-
totalInfo: number
Example:
0
-
totalSuccess: number
Example:
1
-
vendorId: string
Example:
AEGIS
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/off-system-payments/{jobID}
- Test URL
-
https://usint1.textura.oraclecloud.com/ebis/api/v2/off-system-payments/{jobID}