The fee objects describe one-off charges or groups of one-off charges. They might or might not be connected to a specific plan, but they must have their own name and price.
You can retrieve individual fee as well as query all the fees by location, company or member.
Here is the list of all properties the fee object has:
Fee
| Property | Type | Required | Description |
|---|---|---|---|
| name | string | true | The name of the charge. It will appear in the invoice line item. |
| price | number | true | The unit price of the item described by the fee. |
| quantity | number | false | The quantity described by the one-off charge. If omitted, 1 is assumed. |
| invoice.status | string | false | The status of the fee in terms of billing. Possible values: not_paid, paid, waived, invoiced. |
| invoice._id | string | false | Appears, if a fee has been invoiced. Fees should be invoiced only through the UI. |
| invoice.creditNote | string | false | Appears, if a fee was credited. Fees should be credited only through the UI. |
| team | Company | false | Reference to the company (required if no member). |
| member | Member | false | Reference to the company (required if no team). |
| office | Location | true | A reference to the location the fee is issued for. |
| plan | Plan | false | A reference to the price plan assigned to the fee. It is used to determine the sales account when generating an invoice. |
| refundable | boolean | false | If true, the one-off charge is counted as deposit and can be refunded later on. |
| billInAdvance | boolean | false | If true, the one-off charge is billed in advance (respecting its date). By default one-off charges are billed in arears. |
| shouldUseValueCredits | boolean | false | In order for a fee to use coins you need to set this to true. By default it's set to false. |
| isPersonal | boolean | false | If true, the one-off charge is billed to the assigned member and not to the company. |
| source | string | false | The origin/source of the fee. |
| createdAt | date | readonly | The date when the fee has been created. |
| createdBy | id | readonly | The user that created the fee. |
| modifiedAt | date | readonly | The user that did the last modification to the fee. If no update is made this field will match the createdBy field. |
| modifiedBy | id | readonly | The user that did the last modification to the fee. Before the first modification, this field equals to the createdBy field. |