ClubCollect
Search…
Invoice
Manage Invoices.
get
https://api.clubcollect.com/api
/v2/invoices/:id
Show Invoice
Note the date format is ISO 8601.
Note a Partner usually calls the GET /v2/invoices/:id method in response to a notification sent by ClubCollect about an update to an Invoice.
Note To get a list of possible values for invoice lines types see the Invoice Line documentation.
post
https://api.clubcollect.com/api
/v2/invoices
Create Invoice

Example Request Body

1
{
2
"import_id": "...",
3
"external_invoice_number": "2014-342-545",
4
"reference": "ba6fe77",
5
"direct_debit_iban": "...",
6
"federation_membership_number": "...",
7
"club_membership_number": "...",
8
"member_external_id": "...",
9
"external_membership_number": "...",
10
"locale": "en",
11
"customer": {
12
"name": {
13
"prefix": "Mr",
14
"first_name": "Joe",
15
"infix": "van der",
16
"last_name": "Doe",
17
"organization": "TheClub"
18
},
19
"address": {
20
"address1": "3rd Avenue",
21
"address2": "",
22
"locality": "",
23
"house_number": "1500",
24
"state": "",
25
"zipcode": "10010",
26
"city": "Amsterdam",
27
"country_code": "NL"
28
},
29
"email": {
30
"email_address": "[email protected]"
31
},
32
"phone": {
33
"phone_number": "562-756-2233",
34
"country_code": "NL"
35
}
36
},
37
"invoice_lines": [
38
{
39
"invoice_line_id": "...",
40
"amount_cents": 10000,
41
"description": "Membership fee",
42
"date": "..."
43
},
44
{
45
"invoice_line_id": "...",
46
"amount_cents": -1000,
47
"description": "Deduction",
48
"date": "..."
49
}
50
],
51
"amount_total_cents": 9000
52
}
Copied!

Error Messages

  • invalid_import_id: No import with this ID could be found.
  • invalid_external_invoice_number: formatting error: min. 1 character.
  • invalid_customer_last_name: Last name may not be empty.
  • invalid_customer_email: Email address may not be empty if no phone number is provided.
  • invalid_customer_phone: Phone number may not be empty if no email address is provided.
  • invalid_customer_address: Address may not be empty if neither an email address nor phone number is provided.
  • invalid_amount_total_cents: amount_total_cents is not equal to the total of all invoice line amounts.
  • duplicate_invoice_line_id: The duplicate_invoice_line_id provided was already used for another invoice line.
  • invalid_content_type: Content-Type: application/json must be provided.
Note the total may be zero (nothing to receive) or negative (something to receive).
Note at least one of:
  • customer.email.email_address
  • customer.phone.*
  • customer.address.*
must be provided. i.e. there must be a way for us to contact the Customer via email, phone or postal mail.
Note It's not possible to add or delete invoice lines for an existing invoice. If an invoice is incorrectly created with a wrong amount outstanding (or the invoice becomes invalid for some reason after it's transmitted), the partner can credit it using /credit_and_retract endpoint.
put
https://api.clubcollect.com/api
/v2/invoices/:id
Update Invoice

Example Request Body

1
{
2
"external_invoice_number": "2014-342-545",
3
"reference": "ba6fe77",
4
"direct_debit_iban": "...",
5
"federation_membership_number": "...",
6
"club_membership_number": "...",
7
"member_external_id": "...",
8
"external_membership_number": "...",
9
"customer": {
10
"name": {
11
"prefix": "Mr",
12
"first_name": "Joe",
13
"infix": "van der",
14
"last_name": "Doe",
15
"organization": "TheClub"
16
},
17
"address": {
18
"address1": "3rd Avenue",
19
"address2": "",
20
"locality": "",
21
"house_number": "1500",
22
"state": "",
23
"zipcode": "10010",
24
"city": "Amsterdam",
25
"country_code": "NL"
26
},
27
"email": {
28
"email_address": "[email protected]"
29
},
30
"phone": {
31
"phone_number": "562-756-2233",
32
"country_code": "NL"
33
}
34
},
35
}
Copied!

Error Messages

  • invalid_invoice_id: No invoice with this invoice_id could be found.
  • invalid_external_invoice_number: formatting error: min. 1 character.
  • invalid_customer_last_name: Last name may not be empty.
  • invalid_customer_email: Email address may not be empty if no phone number is provided.
  • invalid_customer_phone: Phone number may not be empty if no email address is provided.
  • invalid_content_type: Content-Type: application/json must be provided.
post
https://api.clubcollect.com/api
/v2/invoices/:id/credit_and_retract
Credit and Retract Invoice

Example Request Body

1
{
2
"external_invoice_number": "2014-342-545",
3
"description": "Cash payment",
4
"retraction_reason": "Paid by cash",
5
"show_retraction_reason_to_customer": true
6
}
Copied!

Error Messages

  • invalid_invoice_id: No invoice with this ID could be found.
  • invalid_external_invoice_number: min. 1 character
  • invalid_description: description must be provided.
  • already_retracted: The invoice with this ID has already been retracted.
  • invalid_content_type: Content-Type: application/json must be provided.
  • payment_in_progress: An invoice can't be credited or retracted if there's a payment in progress
delete
https://api.clubcollect.com/api
/v2/invoices/:id
Delete Invoice
Last modified 5mo ago