Jump to

• Request
• Response

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): string
  The protocol for the API requires a valid username and password for TPM.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Audit data included in response payload.

Body ()

Root Schema : schema

Type: object

Show Source

• audit: string
  Example: Manual check imported
• checkNumber: string
  Example: 2044512
• code: number
  Status code

  Example: 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

{
    "type":"object",
    "properties":{
        "jobID":{
            "type":"number",
            "description":"",
            "example":"34889284",
            "nullable":false
        },
        "total":{
            "type":"number",
            "description":"",
            "example":"1",
            "nullable":false
        },
        "totalInfo":{
            "type":"number",
            "description":"",
            "example":"0",
            "nullable":false
        },
        "totalDuplicate":{
            "type":"number",
            "description":"",
            "example":"0",
            "nullable":false
        },
        "totalError":{
            "type":"number",
            "description":"",
            "example":"0",
            "nullable":false
        },
        "totalSuccess":{
            "type":"number",
            "description":"",
            "example":"1",
            "nullable":false
        },
        "audit":{
            "type":"string",
            "description":"",
            "example":"Manual check imported",
            "nullable":false
        },
        "status":{
            "type":"string",
            "description":"",
            "example":"SUCCESS",
            "nullable":false
        },
        "code":{
            "type":"number",
            "description":"Status code",
            "example":"200",
            "nullable":false
        },
        "checkNumber":{
            "type":"string",
            "description":"",
            "example":"2044512",
            "nullable":false
        },
        "contractNumber":{
            "type":"string",
            "description":"",
            "example":"1",
            "nullable":false
        },
        "datePaid":{
            "type":"string",
            "description":"",
            "example":"2023-02-10",
            "nullable":false
        },
        "invoiceNumber":{
            "type":"string",
            "description":"",
            "example":"Inv-1",
            "nullable":false
        },
        "paymentAmount":{
            "type":"number",
            "description":"",
            "example":"23400.34",
            "nullable":false
        },
        "projectNumber":{
            "type":"string",
            "description":"",
            "example":"101-441-1EE",
            "nullable":false
        },
        "vendorId":{
            "type":"string",
            "description":"",
            "example":"AEGIS",
            "nullable":false
        }
    }
}

Examples

Select an example Import off-system payments audit response

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}

Back to Top