Jump to

• Request
• Response

1a ERP Records

post

/api/v2/erp-records

This API will import data related to any Invoice, Rejection, or Payment records that are created within the ERP, by Textura Integration. The ERP records can be imported in situations where there is no match with an export header or an invoice contract. In this situation, certain fields within Textura will denote "No matching invoice contract found" and retrieval of the audit records for the import job, will show that the records were imported successfully.

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

• actionType(required): string
  Type of record: invoice, rejection, or payment.

  Example: invoice
• drawNumber: number
  This is a deprecated field for the draw number.

  Example: 1
• erpRecordID: number (string)
  Unique identifier of the record in the ERP.

  Example: 5.555789123E9
• erpReleaseRecordID: string
  This is a deprecated field for the release record ID.

  Example: 213
• invoiceAmount: number
  Gross amount of invoice from ERP.

  Example: 8005.5
• invoiceNumber(required): string
  Invoice number from ERP.

  Example: A05-3330001140
• mainJobNumber(required): string
  Project number.

  Example: 2877330250-312200
• paymentAmount: number
  Payment amount from the ERP.

  Example: 0
• postDate: string
  Posting date of record in the ERP.

  Example: 2023-01-01
• releaseAmount: number
  Deprecated field for release amount.

  Example: 50
• revisionNumber: string
  Deprecated field for revision number.

  Example: a
• subContractNumber: string
  Subcontract or PO number related to the record.

  Example: 3330001140
• vendorID(required): string
  Vendor number, from the ERP, related to the record.

  Example: 234555

{
    "required":[
        "actionType",
        "mainJobNumber",
        "invoiceNumber",
        "vendorID"
    ],
    "type":"object",
    "properties":{
        "erpRecordID":{
            "type":"number",
            "description":"Unique identifier of the record in the ERP.",
            "format":"string",
            "example":5.555789123E9,
            "nullable":true
        },
        "erpReleaseRecordID":{
            "type":"string",
            "description":"This is a deprecated field for the release record ID.",
            "example":"213",
            "nullable":true
        },
        "drawNumber":{
            "type":"number",
            "description":"This is a deprecated field for the draw number.",
            "example":"1",
            "nullable":true
        },
        "actionType":{
            "type":"string",
            "description":"Type of record: invoice, rejection, or payment.",
            "example":"invoice",
            "nullable":false
        },
        "postDate":{
            "type":"string",
            "description":"Posting date of record in the ERP.",
            "example":"2023-01-01",
            "nullable":true
        },
        "mainJobNumber":{
            "type":"string",
            "description":"Project number.",
            "example":"2877330250-312200",
            "nullable":false
        },
        "subContractNumber":{
            "type":"string",
            "description":"Subcontract or PO number related to the record.",
            "example":"3330001140",
            "nullable":true
        },
        "invoiceNumber":{
            "type":"string",
            "description":"Invoice number from ERP.",
            "example":"A05-3330001140",
            "nullable":false
        },
        "revisionNumber":{
            "type":"string",
            "description":"Deprecated field for revision number.",
            "example":"a",
            "nullable":true
        },
        "vendorID":{
            "type":"string",
            "description":"Vendor number, from the ERP, related to the record.",
            "example":"234555",
            "nullable":false
        },
        "invoiceAmount":{
            "type":"number",
            "description":"Gross amount of invoice from ERP.",
            "example":8005.5,
            "nullable":true
        },
        "releaseAmount":{
            "type":"number",
            "description":"Deprecated field for release amount.",
            "example":50,
            "nullable":true
        },
        "paymentAmount":{
            "type":"number",
            "description":"Payment amount from the ERP.",
            "example":0,
            "nullable":true
        }
    }
}

Examples

Select an example Import ERP Records

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/erp-records/6712

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

Examples

Select an example Import ERP records response Import ERP records response

Default Response

Links to working URLs

Links

Production URL

https://services.texturacorp.com/ebis/api/v2/erp-records

Test URL

https://usint1.texturacorp.com/ebis/api/v2/erp-records

Back to Top