Hello Claims Developer Portal

Represents a request for payment.

Structure

PaymentRequest:
"id": integer
"invoiceNumber": string
"invoiceDate": string
"totalExcludingTax": number
"totalTax": number
"totalIncludingTax": number
"excessCollected": number
"documentUrl": string
"metadata": object

id#

The unique identifier for the payment request.

Type:integer

Required:No

Format: int32

invoiceNumber#

The invoice number for the payment request.

Type:string

Required:No

Format: string

invoiceDate#

The date of the invoice.

Type:string

Required:No

Format: date

totalExcludingTax#

The total amount of the payment request, excluding tax.

Type:number

Required:No

Format: double

totalTax#

The total tax amount for the payment request.

Type:number

Required:No

Format: double

totalIncludingTax#

The total amount of the payment request, including tax.

Type:number

Required:No

Format: double

excessCollected#

The deductible amount collected.

Type:number

Required:No

Format: double

documentUrl#

The document URL for the invoice.

Type:string

Required:No

Format: string

metadata#

Metadata for the payment request.

Type:object

Required:No

Format:[string]: string

Note:

This will be formatted as an object with keys of the type string and values of type string.