xero-node
Version:
Xero NodeJS OAuth 2.0 client for xero-node
91 lines (90 loc) • 3.52 kB
TypeScript
/**
* Accounting API
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 2.0.0
* Contact: api@xero.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { Account } from './account';
import { Payment } from './payment';
export declare class BatchPayment {
'account'?: Account;
/**
* (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.
*/
'reference'?: string;
/**
* (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.
*/
'particulars'?: string;
/**
* (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.
*/
'code'?: string;
/**
* (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
*/
'details'?: string;
/**
* (UK Only) Only shows on the statement line in Xero. Max length =18
*/
'narrative'?: string;
/**
* The Xero generated unique identifier for the bank transaction (read-only)
*/
'batchPaymentID'?: string;
/**
* Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06
*/
'dateString'?: string;
/**
* Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06
*/
'date'?: string;
/**
* The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00
*/
'amount'?: number;
'payments'?: Array<Payment>;
/**
* PAYBATCH for bill payments or RECBATCH for sales invoice payments (read-only)
*/
'type'?: BatchPayment.TypeEnum;
/**
* 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.
*/
'status'?: string;
/**
* The total of the payments that make up the batch (read-only)
*/
'totalAmount'?: string;
/**
* UTC timestamp of last update to the payment
*/
'updatedDateUTC'?: Date;
/**
* Booelan that tells you if the batch payment has been reconciled (read-only)
*/
'isReconciled'?: string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
export declare namespace BatchPayment {
enum TypeEnum {
PAYBATCH,
RECBATCH
}
}