Jump to

• Request
• Response

1b Owner Invoices Audit

get

/api/v2/owner-invoices/{jobID}

Records imported through this service will be created as an invoice from the General Contractor to an owner using the projectNumber and phaseCode on the record. The records will import against the earliest draw in the project that has not yet been sent to signer. This API is similar to the v1 Owner Invoices, except that a jobID and uri are created for the user after a file is imported. The uri provided will supply the audit response for the import.

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

• audit: string
  Example: invoice imported
• code: number
  Status code

  Example: 200
• description: string
  First line item for general construction

  Example:
• invoiceNumber: string
  The invoice number

  Example: 100022
• jobID: string
  Job ID of the import

  Example: 3698
• materialStored: number
  Amount stored, for the phase code and this invoice

  Example: 1000
• phaseCode: string
  SOV phase code from prime contract SOV

  Example: 001
• projectNumber: string
  The project this subcontract is written against

  Example: 02-02-2023
• retentionHeld: string
  Amount of retention held for this phase code and invoice

  Example: 300
• retentionRequested: string
  Amount of retention requested for this phase code and invoice

  Example: 0
• total: string
  Number of imported records

  Example:
• totalDuplicate: string
  Number of imported records that were duplicates

  Example:
• totalError: string
  Number of imported records that had an error

  Example:
• totalInfo: string
  Example:
• totalSuccess: string
  Number of succsssful records imported

  Example:
• workCompleted: number
  Amount billed for this phase code, for this invoice

  Example: 2000

{
    "type":"object",
    "properties":{
        "audit":{
            "type":"string",
            "description":"",
            "example":"invoice imported",
            "nullable":false
        },
        "code":{
            "type":"number",
            "description":"Status code",
            "example":"200",
            "nullable":false
        },
        "projectNumber":{
            "type":"string",
            "description":"The project this subcontract is written against",
            "example":"02-02-2023",
            "nullable":false
        },
        "invoiceNumber":{
            "type":"string",
            "description":"The invoice number",
            "example":"100022",
            "nullable":true
        },
        "phaseCode":{
            "type":"string",
            "description":"SOV phase code from prime contract SOV",
            "example":"001",
            "nullable":false
        },
        "workCompleted":{
            "type":"number",
            "description":"Amount billed for this phase code, for this invoice",
            "example":2000,
            "nullable":false
        },
        "materialStored":{
            "type":"number",
            "description":"Amount stored, for the phase code and this invoice",
            "example":1000,
            "nullable":false
        },
        "retentionHeld":{
            "type":"string",
            "description":"Amount of retention held for this phase code and invoice",
            "example":300,
            "nullable":false
        },
        "retentionRequested":{
            "type":"string",
            "description":"Amount of retention requested for this phase code and invoice",
            "example":0,
            "nullable":false
        },
        "description":{
            "type":"string",
            "description":"First line item for general construction",
            "example":"",
            "nullable":true
        },
        "jobID":{
            "type":"string",
            "description":"Job ID of the import",
            "example":"3698",
            "nullable":false
        },
        "total":{
            "type":"string",
            "description":"Number of imported records",
            "example":"",
            "nullable":false
        },
        "totalDuplicate":{
            "type":"string",
            "description":"Number of imported records that were duplicates",
            "example":"",
            "nullable":false
        },
        "totalError":{
            "type":"string",
            "description":"Number of imported records that had an error",
            "example":"",
            "nullable":false
        },
        "totalInfo":{
            "type":"string",
            "description":"",
            "example":"",
            "nullable":false
        },
        "totalSuccess":{
            "type":"string",
            "description":"Number of succsssful records imported",
            "example":"",
            "nullable":false
        }
    }
}

Examples

Select an example Owner invoices 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-invoices/{jobID}

Test URL

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

Back to Top