Jump to

• Request
• Response

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

• checkNumber(required): string
  2044512

  Example: Check number of off-system payment
• contractNumber(required): string
  Example: 1
• datePaid(required): string
  Date the payment was paid

  Example: 2023-02-10
• invoiceNumber(required): string
  Subcontractor invoice number

  Example: Inv-1
• paymentAmount(required): number
  Amount of payment made

  Example: 23400.34
• projectNumber(required): string
  Users unique project number

  Example: 01-441-1EE
• vendorId: string
  Example: AEGIS

{
    "required":[
        "projectNumber",
        "invoiceNumber",
        "contractNumber",
        "checkNumber",
        "datePaid",
        "paymentAmount"
    ],
    "type":"object",
    "properties":{
        "projectNumber":{
            "type":"string",
            "description":"Users unique project number",
            "example":"01-441-1EE",
            "nullable":false
        },
        "invoiceNumber":{
            "type":"string",
            "description":"Subcontractor invoice number",
            "example":"Inv-1",
            "nullable":false
        },
        "contractNumber":{
            "type":"string",
            "description":"",
            "example":"1",
            "nullable":false
        },
        "checkNumber":{
            "type":"string",
            "description":"2044512",
            "example":"Check number of off-system payment",
            "nullable":false
        },
        "datePaid":{
            "type":"string",
            "description":"Date the payment was paid",
            "example":"2023-02-10",
            "nullable":false
        },
        "paymentAmount":{
            "type":"number",
            "description":"Amount of payment made",
            "example":"23400.34",
            "nullable":false
        },
        "vendorId":{
            "type":"string",
            "description":"",
            "example":"AEGIS",
            "nullable":false
        }
    }
}

Examples

Select an example Import off-system payments 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/off-system-payments/3000

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

Examples

Select an example Production Server: Import off-system payments response Test Server: Import off-system payments response

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

Back to Top