Jump to

• Request
• Response

2 Owner Invoices (Deprecated)

post

/api/v1/invoice

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 particular API does not create a jobID or uri for the user. The audit response is provided immediately after the user submits the import payload to this API.

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

• description: string
  First line item for general construction

  Example:
• materialStored(required): 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: 02-02-2023
• retentionHeld(required): string
  Amount of retention held for this phase code and invoice

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

  Example: 0
• workCompleted(required): number
  Amount billed for this phase code, for this invoice

  Example: 2000

{
    "required":[
        "projectNumber",
        "phaseCode",
        "workCompleted",
        "materialStored",
        "retentionHeld",
        "retentionRequested"
    ],
    "type":"object",
    "properties":{
        "projectNumber":{
            "type":"string",
            "description":"The project this subcontract is written against",
            "example":"02-02-2023",
            "nullable":false
        },
        "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 Invoice

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : schema

Type: object

Show Source

• description: string
  First line item for general construction

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

  Example: 2000

{
    "type":"object",
    "properties":{
        "projectNumber":{
            "type":"string",
            "description":"The project this subcontract is written against",
            "example":"02-02-2023",
            "nullable":false
        },
        "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 Invoice audit response

Default Response

Links to working URLs

Links

Production URL

https://services.texturacorp.com/ebis/api/v1/invoice

Test URL

https://usint1.texturacorp.com/ebis/api/v1/invoice

Back to Top