The Transactions resource describes a transaction in the Fusebill system. Transactions include charges, and their components such as taxes, refunds, reversals and payments. All items which appear on an invoice, such as plan charges, products, taxes, etc, will generate a Transaction record. Likewise, all actions taken against an invoice, including payments, refunds and reversals, write offs, etc, will also generate a Transaction record.
The list of Transactions can be used as a record of billing activity for a given customer account.
Transaction Object Fields
| Property | Type | Description |
|---|---|---|
effectiveTimestamp | Timestamp | The effective timestamp of this transaction |
transactionType | Enum. See below for list | Indicates the type of AR activity |
name | String | A Fusebill generated label to describe the transaction |
description | String | The description of the associated product. Possibly null |
productCode | String | The code of the associated product. Possibly null |
paymentActivityId | Integer | The Fusebill generated ID of the associated payment activity. Possibly null |
reference | String | The authorization code from the gateway if applicable. Possibly null |
manualReference | String | For payments and credits, this is the manual reference which can be provided at the time of credit/payment creation. |
quantity | Decimal | The quantity used to determine the amount of money moving in the transaction (the arDebit or arCredit) |
unitPrice | Decimal | The amount multiplied with the quantity to determine the amount of money moving in the transaction (the arDebit or arCredit) |
arDebit | Decimal | The debit to accounts receivable |
arCredit | Decimal | The credit to accounts receivable |
glCode | String | The general ledger code being used for this transaction. Can be null |
invoiceAllocation | List of objects. Defined below | defines how this transaction was allocated across multiple invoices if applicable |
associatedId | Integer | The ID of the associated transaction. For example, the associated transaction of a reverse credit is the original credit transaction. If the transaction does not have an associated transaction (such as a charge) then this field is equal to id |
id | Integer | The Fusebill generated ID that uniquely identifies this transaction |
uri | String | The full string path to this resource |
Invoice Allocation Fields
| Property | Type | Description |
|---|---|---|
invoiceId | Integer | The Fusebill generated ID that uniquely identifies this invoice |
invoiceNumber | Integer | The invoice number |
amount | Decimal | The amount of the transaction that was allocated to this invoice |
outstandingBalance | Decimal | The current outstanding balance of the invoice. Not the amount that was outstanding at the time of the transaction |
invoiceTotal | Decimal | The total of the invoice |
uri | String | The full string path to the invoice |
Possible transactionType values are:
1 - Charge
2 - Setup fee
3 - Payment
4 - Full refund
5 - Partial refund
6 - Earning
7 - Reverse charge
8 - Reverse setup fee
9 - Reverse earning
10 - Write off
11 - Tax
12 - Reverse Tax
13 - Disputed
14 - Discount
15 - Reverse Discount
16 - Opening balance
17 - Credit
18 - Reverse Credit
19 - Opening balance owing
20 - Purchase
21 - Deferred Discount
22 - Reversed Deferred Discount
23 - Earning Discount
24 - Reverse charge earned
25 - NSF
26 - Opening Deferred Revenue
27 - Earning Opening Deferred Revenue