Jump to

• Request
• Response

1a Owner Invoices

post

/api/v2/owner-invoices

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

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

• description: string
  First line item for general construction

  Example:
• invoiceNumber: string
  The invoice number

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

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

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

  Example: 01-441-1BZ
• 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
• workCompleted: number
  Amount billed for this phase code, for this invoice

  Example: 2000

{
    "required":[
        "projectNumber",
        "invoiceLines",
        "phaseCode"
    ],
    "type":"object",
    "properties":{
        "projectNumber":{
            "type":"string",
            "description":"The project this subcontract is written against",
            "example":"01-441-1BZ",
            "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
        }
    }
}

Examples

Select an example Import owner invoices 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/owner-invoices/3698

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

Examples

Select an example Production Server: Import owner invoices response Test Server: Import owner invoices response

Default Response

Links to working URLs

Links

Production URL

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

Test URL

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

Back to Top