Returns a list of all transactions in the specified date range. Note: One payment can be split into multiple transactions when applying to multiple invoices, in which case these results will have multiple transactions per payment.
HEADERS: X-Auth-Token:{YourAPIToken}, X-Auth-Realm:{YourFirmId} HTTP GET: /payment/history?startDate={YYYY-MM-DD}&endDate={YYYY-MM-DD} HTTP RESPONSE: (array of payments -- see below for details)
Field | Type | Description |
---|---|---|
PaymentSid | long | Payment Unique SID code. |
PayerName | string | |
PaymentNumber | string | |
DueDate | string | Due date of payment on associated invoice. |
InvoiceSid | long | Invoice Unique SID code. |
InvoiceNumber | string | |
TotalAmount | double | Total amount of payment (before invoice splitting) |
PaidDate | DateTime | Date payment was applied to invoice |
AppliedAmount | double | Total amount of payment applied to invoice |
AppliedDate | DateTime | Date payment transaction was applied |
BalanceDue | string | Current remaining balance on associated invoice |
ClientName | string | |
ClientSid | string | |
ProjectSid | string | |
BatchDepositDate | DateTime | Date when the deposit was dispursed (BT Wallet field) |
DepositDate | DateTime | Deposit date of payment (BT Wallet field) |
PaymentMethod | string | |
PaymentSettlementStatus | string | The current status of the payment (BT Wallet field) |
PaymentSettlementStatusMsg | string | Reason for payment rejection (BT Wallet field) |
WalletTransactionSid | long | |
IsAutoPay | bool | True if payment was made via auto pay (BT Wallet field) |