Jump to

• Request
• Response

2a Cash Receipts

post

/api/v2/owner-funding-checks

This API allows for an owner to fund draws within a project. Submitting the appropriate details will update the draw coverage, within TPM. The returned audit response will provide a message on whether the draw was fully funded. To use this API, these conditions must be met:

• The project must have the Track Owner Funding setting enabled
• Payment Due Date is checked in the Contract Settings and set to Owner Funding Date

Request

Header Parameters

• Authentification(required):
  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

• arInvoiceNumber: string
  Example: 2112200010
• checkAmount(required): number
  Amount from check

  Example: 210659.83
• checkDate(required): string
  Date the check was created

  Example: 02-02-2023
• checkNumber(required): string
  Check number

  Example: 2003315
• drawNumber(required): number
  Unique draw number to apply the check to

  Example: 1
• ownerFundingComment: string
  Comment

  Example:
• projectNumber(required): string
  Project number

  Example: 01-441-1BZ

{
    "required":[
        "checkDate",
        "checkNumber",
        "checkAmount",
        "drawNumber",
        "projectNumber"
    ],
    "type":"object",
    "properties":{
        "checkDate":{
            "type":"string",
            "description":"Date the check was created",
            "example":"02-02-2023",
            "nullable":false
        },
        "checkNumber":{
            "type":"string",
            "description":"Check number",
            "example":"2003315",
            "nullable":false
        },
        "checkAmount":{
            "type":"number",
            "description":"Amount from check",
            "example":210659.83,
            "nullable":false
        },
        "drawNumber":{
            "type":"number",
            "description":"Unique draw number to apply the check to",
            "example":1,
            "nullable":false
        },
        "projectNumber":{
            "type":"string",
            "description":"Project number",
            "example":"01-441-1BZ",
            "nullable":false
        },
        "ownerFundingComment":{
            "type":"string",
            "description":"Comment",
            "example":"",
            "nullable":true
        },
        "arInvoiceNumber":{
            "type":"string",
            "description":"",
            "example":"2112200010",
            "nullable":true
        }
    }
}

Examples

Select an example Import Cash Receipts

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/owner-funding-checks/2400

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

Examples

Select an example Import cash receipts response Import cash receipts response

Default Response

Links to working URLs

Links

Production URL

https://services.texturacorp.com/ebis/api/v2/owner-funding-checks

Test URL

https://usint1.texturacorp.com/ebis/api/v2/owner-funding-checks

Back to Top