MAINHACK

Viewing / Editing File: Invoice.md

# # Invoice
An object representing details for an invoice.

```php
use Xendit\Invoice\Invoice;
```

## Properties

| Name | Type | Required | Description | Examples |
|------------|:-------------:|:-------------:|-------------|:-------------:|
| **id** | **string** |  | The unique identifier for the invoice. | null |
| **external_id** | **string** | ☑️ | The external identifier for the invoice. | null |
| **user_id** | **string** | ☑️ | The user ID associated with the invoice. | null |
| **payer_email** | **string** |  | The email address of the payer. | null |
| **description** | **string** |  | A description of the invoice. | null |
| **payment_method** | [**InvoicePaymentMethod**](InvoicePaymentMethod.md) |  |  | null |
| **status** | [**InvoiceStatus**](InvoiceStatus.md) | ☑️ |  | null |
| **merchant_name** | **string** | ☑️ | The name of the merchant. | null |
| **merchant_profile_picture_url** | **string** | ☑️ | The URL of the merchant&#39;s profile picture. | null |
| **locale** | **string** |  | The locale or language used for the invoice. | null |
| **amount** | **float** | ☑️ | The total amount of the invoice. | null |
| **expiry_date** | **\DateTime** | ☑️ | Representing a date and time in ISO 8601 format. | 2016-08-29T09:12:33.001Z |
| **invoice_url** | **string** | ☑️ | The URL to view the invoice. | null |
| **available_banks** | [**array**](Bank.md) | ☑️ | An array of available banks for payment. | null |
| **available_retail_outlets** | [**array**](RetailOutlet.md) | ☑️ | An array of available retail outlets for payment. | null |
| **available_ewallets** | [**array**](Ewallet.md) | ☑️ | An array of available e-wallets for payment. | null |
| **available_qr_codes** | [**array**](QrCode.md) | ☑️ | An array of available QR codes for payment. | null |
| **available_direct_debits** | [**array**](DirectDebit.md) | ☑️ | An array of available direct debit options for payment. | null |
| **available_paylaters** | [**array**](Paylater.md) | ☑️ | An array of available pay-later options for payment. | null |
| **should_exclude_credit_card** | **bool** |  | Indicates whether credit card payments should be excluded. | null |
| **should_send_email** | **bool** | ☑️ | Indicates whether email notifications should be sent. | null |
| **created** | **\DateTime** | ☑️ | Representing a date and time in ISO 8601 format. | 2016-08-29T09:12:33.001Z |
| **updated** | **\DateTime** | ☑️ | Representing a date and time in ISO 8601 format. | 2016-08-29T09:12:33.001Z |
| **success_redirect_url** | **string** |  | The URL to redirect to on successful payment. | null |
| **failure_redirect_url** | **string** |  | The URL to redirect to on payment failure. | null |
| **should_authenticate_credit_card** | **bool** |  | Indicates whether credit card authentication is required. | null |
| **currency** | [**InvoiceCurrency**](InvoiceCurrency.md) |  |  | null |
| **items** | [**array**](InvoiceItem.md) |  | An array of items included in the invoice. | null |
| **fixed_va** | **bool** |  | Indicates whether the virtual account is fixed. | null |
| **reminder_date** | **\DateTime** |  | Representing a date and time in ISO 8601 format. | 2016-08-29T09:12:33.001Z |
| **customer** | [**CustomerObject**](CustomerObject.md) |  |  | null |
| **customer_notification_preference** | [**NotificationPreference**](NotificationPreference.md) |  |  | null |
| **fees** | [**array**](InvoiceFee.md) |  | An array of fees associated with the invoice. | null |

[[Back to README]](../../README.md)

Cancel / Back

[ MAINHACK ]

Viewing / Editing File: Invoice.md

Server Info

System Features

User Info