| Name | Type | Description | Notes |
|---|---|---|---|
| account | Account | [optional] | |
| reference | str | (NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. | [optional] |
| particulars | str | (NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. | [optional] |
| code | str | (NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. | [optional] |
| details | str | (Non-NZ Only) These details are sent to the org’s bank as a reference for the batch payment transaction. They will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement imported into Xero. Maximum field length = 18 | [optional] |
| narrative | str | (UK Only) Only shows on the statement line in Xero. Max length =18 | [optional] |
| batch_payment_id | str | The Xero generated unique identifier for the bank transaction (read-only) | [optional] |
| date_string | str | Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06 | [optional] |
| date | date | Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06 | [optional] |
| amount | float | The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00 | [optional] |
| payments | list[Payment] | An array of payments | [optional] |
| type | str | PAYBATCH for bill payments or RECBATCH for sales invoice payments (read-only) | [optional] |
| status | str | AUTHORISED or DELETED (read-only). New batch payments will have a status of AUTHORISED. It is not possible to delete batch payments via the API. | [optional] |
| total_amount | float | The total of the payments that make up the batch (read-only) | [optional] |
| updated_date_utc | datetime | UTC timestamp of last update to the payment | [optional] |
| is_reconciled | bool | Booelan that tells you if the batch payment has been reconciled (read-only) | [optional] |
| validation_errors | list[ValidationError] | Displays array of validation error messages from the API | [optional] |