Invoice Line

Manage Invoice Line Items.

get
Fetch Invoice Lines

https://api.clubcollect.com/api/v2/invoices/:id/lines
Request
Response
Path Parameters
id
required
string
ID of Invoice for which Line Items wish to be retrieved.
Headers
Content-Type
required
string
Must be: application/json.
Query Parameters
api_key
required
string
Partner API Key.
200: OK
Invoice Lines fetched successfully.
{
"import_id": "...",
"invoice_id": "...",
"invoice_lines": [
{
"invoice_line_id": "...",
"type": "INVOICE-LINE",
"amount_cents": 10000,
"description": "Membership fee",
"date": "..."
},
{
"invoice_line_id": "...",
"type": "CREDIT-LINE",
"amount_cents": -1000,
"description": "Deduction",
"date": "..."
},
{
"invoice_line_id": "...",
"type": "PAYMENT-LINE",
"amount_cents": 123,
"description": null,
"date": "...",
"payment_method": "..."
},
{
"invoice_line_id": "...",
"type": "CHARGEBACK-LINE",
"amount_cents": 123,
"description": null,
"date": "..."
},
{
"invoice_line_id": "...",
"type": "CHARGEBACK-FEE-LINE",
"amount_cents": 123,
"description": null,
"date": "..."
},
{
"invoice_line_id": "...",
"type": "CHARGEBACK-FEE-PAYMENT-LINE",
"amount_cents": 123,
"description": null,
"date": "..."
},
{
"invoice_line_id": "...",
"type": "LATE-PAYMENT-FEE-LINE",
"amount_cents": 123,
"description": null,
"date": "..."
},
{
"invoice_line_id": "...",
"type": "LATE-PAYMENT-FEE-PAYMENT-LINE",
"amount_cents": 123,
"description": null,
"date": "...",
"payment_method": "..."
‚Äč
},
{
"invoice_line_id": "...",
"type": "INSTALLMENT-FEE-LINE",
"amount_cents": 123,
"description": null,
"date": "..."
},
{
"invoice_line_id": "...",
"type": "INSTALLMENT-FEE-PAYMENT-LINE",
"amount_cents": 123,
"description": null,
"date": "...",
"payment_method": "..."
}
],
"amount_total_cents": "..."
}
404: Not Found
Invoice not found.
{
"error": "invalid_invoice_id"
}

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

  • external