Jump to

• Request
• Response

1b Payments Response

get

/api/v1/export/payments/{jobID}

This API will output subcontractor invoice payment records, for disbursements, made electronically through Textura. When requesting payment data, there are no parameters to filter or select a range of payments. Export details include information regarding payee, payer, payment amounts, and usage of early payment or partial payment methods. All payments that have been processed since the last payment export are available for export and will be in the request response.

Request

Path Parameters

• jobID(required): integer(int64)
  Unique identifier of the job number.

Header Parameters

• Authentification(required): string
  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

The job was successfully created.

Body ()

Root Schema : export-payments

Type: object

Show Source

• BankCode: string
  Designated bank code.

  Example: 6XXXXX1
• BankName: number
  Name of bank related to payment.

  Example: 693831
• CheckAmount: number
  Check amount, in the organization's currency.

  Example: 10000
• CheckNumber: number
  Check number.

  Example: 55555
• CISAmount: number
  Example: 0
• DrawNumber: number
  Draw number in TPM

  Example: 23
• EppEnrolled: boolean
  Status of EPP, early payment, enrollment.

  Example: true
• EppPaid: boolean
  Status of EPP being used in transaction.

  Example: true
• ExportExternalID: string
  Categorical ID for transaction.

  Example: 1000dd59-8759-40b7-b877-590446a8976a
• InvoiceNumber: string
  Invoice Number.

  Example: 70000-02020-222022
• ItemGrossAmount: number
  Item Gross Amount, in the organization's currency.

  Example: 10000
• MainJobNumber: string
  Internal project number, specified in project settings.

  Example: 70000-02020
• ModifiedInvoiceNumber: string
  Modified invoice number.

  Example: 70000-02020-222022
• PartialPayment: boolean
  Status of partial payment used in transaction.

  Example: false
• PayDiscountTaken: number
  Pay discount.

  Example: 0
• PayeeName: string
  Payee of the payment transaction.

  Example: Break Check Co
• PayFromOrgId: number
  Organization acting as payer of the payment transaction.

  Example: 213980
• PaymentDate: string
  Payment date.

  Example: 02022023
• ProjectName: string
  Payment name.

  Example: Imagine Tech
• RetentionAmount: number
  Retention amount.

  Example: 0
• RevisionNumber: string
  Revision number.

  Example:
• SettlementDate: string
  Settlement Date.

  Example: 02032023
• SubcontractNumber: string
  Subcontract number.

  Example: 70000-02020
• SubcontractorName: string
  Subcontractor name.

  Example: Break Check Co
• TaxAmount: number
  Tax amount.

  Example: 0
• TPA: string
  TPA.

  Example: oracle.doceng.json.BetterJsonNull@3a7704c
• VendorID: string
  Vendor ID.

  Example: brch002
• VendorOfPayee: string
  Vendor of payee.

  Example: brch002

{
    "type":"object",
    "properties":{
        "BankCode":{
            "type":"string",
            "description":"Designated bank code.",
            "example":"6XXXXX1"
        },
        "BankName":{
            "type":"number",
            "description":"Name of bank related to payment.",
            "example":"693831"
        },
        "CISAmount":{
            "type":"number",
            "description":"",
            "example":"0"
        },
        "CheckAmount":{
            "type":"number",
            "description":"Check amount, in the organization's currency.",
            "example":"10000"
        },
        "CheckNumber":{
            "type":"number",
            "description":"Check number.",
            "example":"55555"
        },
        "DrawNumber":{
            "type":"number",
            "description":"Draw number in TPM",
            "example":"23"
        },
        "EppEnrolled":{
            "type":"boolean",
            "description":"Status of EPP, early payment, enrollment.",
            "example":true
        },
        "EppPaid":{
            "type":"boolean",
            "description":"Status of EPP being used in transaction.",
            "example":true
        },
        "ExportExternalID":{
            "type":"string",
            "description":"Categorical ID for transaction.",
            "example":"1000dd59-8759-40b7-b877-590446a8976a"
        },
        "InvoiceNumber":{
            "type":"string",
            "description":"Invoice Number.",
            "example":"70000-02020-222022"
        },
        "ItemGrossAmount":{
            "type":"number",
            "description":"Item Gross Amount, in the organization's currency.",
            "example":"10000"
        },
        "MainJobNumber":{
            "type":"string",
            "description":"Internal project number, specified in project settings.",
            "example":"70000-02020"
        },
        "ModifiedInvoiceNumber":{
            "type":"string",
            "description":"Modified invoice number.",
            "example":"70000-02020-222022"
        },
        "PartialPayment":{
            "type":"boolean",
            "description":"Status of partial payment used in transaction.",
            "example":false
        },
        "PayDiscountTaken":{
            "type":"number",
            "description":"Pay discount.",
            "example":"0"
        },
        "PayFromOrgId":{
            "type":"number",
            "description":"Organization acting as payer of the payment transaction.",
            "example":"213980"
        },
        "PayeeName":{
            "type":"string",
            "description":"Payee of the payment transaction.",
            "example":"Break Check Co"
        },
        "PaymentDate":{
            "type":"string",
            "description":"Payment date.",
            "example":"02022023"
        },
        "ProjectName":{
            "type":"string",
            "description":"Payment name.",
            "example":"Imagine Tech"
        },
        "RetentionAmount":{
            "type":"number",
            "description":"Retention amount.",
            "example":"0"
        },
        "RevisionNumber":{
            "type":"string",
            "description":"Revision number.",
            "example":""
        },
        "SettlementDate":{
            "type":"string",
            "description":"Settlement Date.",
            "example":"02032023"
        },
        "SubcontractNumber":{
            "type":"string",
            "description":"Subcontract number.",
            "example":"70000-02020"
        },
        "SubcontractorName":{
            "type":"string",
            "description":"Subcontractor name.",
            "example":"Break Check Co"
        },
        "TPA":{
            "type":"string",
            "description":"TPA.",
            "example":null
        },
        "TaxAmount":{
            "type":"number",
            "description":"Tax amount.",
            "example":"0"
        },
        "VendorID":{
            "type":"string",
            "description":"Vendor ID.",
            "example":"brch002"
        },
        "VendorOfPayee":{
            "type":"string",
            "description":"Vendor of payee.",
            "example":"brch002"
        }
    }
}

Examples

Select an example Export payments 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/v1/export/payments/{jobID}

Test URL

https://usint1.textura.oraclecloud.com/ebis/api/v1/export/payments/{jobID}

Back to Top