Jump to

• Request
• Response

2b Cash Receipts Audit

get

/api/v2/owner-funding-checks/{jobID}

This API, also known as Owner Funding Checks, 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

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 Top

Response

Supported Media Types

• application/json

200 Response

Audit data included in response payload.

Body ()

Root Schema : schema

Type: object

Show Source

• arInvoiceNumber: string
  Example: 2112200010
• audit: string
  Includes import status messaging

  Example:
• checkAmount: number
  Amount from check

  Example: 210659.83
• checkDate: string
  Date the check was created

  Example: 02-02-2023
• checkNumber: string
  Check number

  Example: 2003315
• code: number
  Status code

  Example:
• drawNumber: number
  Unique draw number to apply the check to

  Example: 1
• ownerFundingComment: string
  Comment

  Example:
• projectNumber: string
  Project number

  Example: 01-441-1BZ
• status: string
  Status message

  Example: SUCCESS

{
    "type":"object",
    "properties":{
        "audit":{
            "type":"string",
            "description":"Includes import status messaging",
            "example":"",
            "nullable":false
        },
        "code":{
            "type":"number",
            "description":"Status code",
            "example":"",
            "nullable":false
        },
        "status":{
            "type":"string",
            "description":"Status message",
            "example":"SUCCESS",
            "nullable":false
        },
        "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 Cash receipts 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/owner-funding-checks/{jobID}

Test URL

https://usint1.textura.oraclecloud.com/ebis/api/v2/owner-funding-checks/{jobID}

Back to Top