Invoice Line
Manage Invoice Line Items.
Fetch Invoice Lines
GET
https://app.clubcollect.com/api/v2/invoices/:id/lines
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | ID of Invoice for which Line Items wish to be retrieved. |
Query Parameters
Name | Type | Description |
---|---|---|
api:key | string | Partner API Key (Deprecated) |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | ApiKey <api_key> |
Content-Type* | string | Must be: |
Note the date format isISO 8601
.
Note that description
is not null
only for regular Invoice Lines and Credit Lines.
Note that payment_method
is present only for Payment Lines and its value can be one of:
ideal
sdd
bank_transfer
credit_card
bancontact
bacs
sofort
paypal
external
Line types
The invoice lines can either increase the invoice outstanding (positive amount), e.g. regular lines, fees, chargebacks; or decrease the outstanding (negative amount), e.g. payments, credits. Furthermore lines can be categorised by their type.
The type of an invoice line is determined by the type
attributes (always present) and the optional subtype
attributes. Below you can find a description of the possible values for invoice lines types.
Regular Lines
This line type is used for lines added to the invoice at creation time, when increasing the invoice amount from the ClubCollect web interface or when a member adds a donation to the invoice (if enabled).
Type | Subtype | Description |
---|---|---|
| Amounts added by the partner when an invoice is created will be of this type | |
|
| Donation added to an invoice |
|
| Payment fee charged to the receiver of the invoice |
|
| Administrative fee charged to the receiver of the invoice |
Fees Lines
At certain points of the life cycle of an invoice fees can be added to the invoice (e.g. Member initiating a payment in installments).
Type | Subtype | Description |
---|---|---|
| These fees are added to the invoice when it is paid in installments | |
| When a payment is charged back a fee might be added to the invoice | |
| Late payment fees are penalties that might be added when the invoice is overdue |
Payment Lines
Payment lines are added to register new payments happening for an invoice. payment invoice lines will are added to the invoice.
Type | Subtype | Description |
---|---|---|
| Payment for the amount invoiced by the partner | |
|
| Payments towards donation invoice lines |
|
| Jeugdfonds payment |
| Payments for installment fees | |
| Payments for chargeback fees | |
| Payments for late payment fees | |
| Payment for penalty fees (Legacy) |
Chargeback Lines
When a successful payment (usually Sepa Direct Debit) is charged back, chargeback lines are added to the invoice to cancel the amount of the payment that has been charged back.
Type | Subtype | Description |
---|---|---|
| Chargeback for the amount invoiced by the partner | |
|
| Chargeback line for a donation invoice lines |
|
| Chargeback line for an administrative fee invoice lines |
| Chargeback for installment fees | |
| Chargeback for late payment fee | |
| Chargeback for paid chargeback fees | |
| Chargeback for penalty fees |
Credit Lines
Credit lines are added to the invoice to discount an amount from the amount outstanding. a new invoice line to the invoice.
Type | Subtype | Description |
---|---|---|
| Discount applied to the amount invoiced by the partner | |
|
| Credit for donation lines |
|
| Credits for the payment fee |
|
| Credits for the administrative fee |
| Credits for a chargeback fee | |
| Credit for an installment fee | |
| Credit for a late payment fee | |
| Credit for a Penalty fee |
Note: penalty lines are a legacy type. You might see some of them for older invoices but no new invoice lines of this type are created. with have this type.
Last updated