Import

Manage Imports, which are collections of Invoices.
get
Show Import
https://api.clubcollect.com/api/v2/imports/:id
Fetch an Import’s details.
Request
Response
Request
Path Parameters
id
required
string
Import ID, supplied by ClubCollect.
Headers
Authorization
required
string
ApiKey <api_key>
Query Parameters
api_key
optional
string
Partner API Key (Deprecated)
Response
200: OK
Import successfully retrieved.
{
  "import_id": "a1f3216863ba5d5424dcbace46ab37be98d70c92",
  "title": "Membership fees 2016/02",
  "transmitted": true|false,
  "transmitted_at": "2017-05-16T08:57:02+00:00",
  "prepaid_amount_cents": 123,
  "prepaid_amount_currency": "EUR|GBP|CHF",
  "settled_amount_cents": 456,
  "settled_amount_currency": "EUR|GBP|CHF",
  "expected_invoices_count": 3,
  "invoice_ids": [
    "47417520982b90764d0067d529691934e6ec3a42",
    "c0009400834121ded4cdd5a623da52f12c737262",
    "43cf319011497b1b40d81e341a652b04866a2d0b"
  ]
}
404: Not Found
Could not find an Import with this ID.
{
    "errors": "invalid_import_id"
}
post
Create Import
https://api.clubcollect.com/api/v2/imports
Create a new, empty Import.
Request
Response
Request
Headers
Authorization
required
string
ApiKey <api_key>
Query Parameters
api_key
optional
string
Partner API Key (Deprecated)
Body Parameters
title
optional
string
​
company_id
required
string
Company to which the Import should belong.
expected_invoices_count
optional
string
Number of invoices expected to be added to this import. If provided the Import cannot be transmitted from the ClubCollect User Interface until all invoices are created.
Response
200: OK
{
  "import_id": "a1f3216863ba5d5424dcbace46ab37be98d70c92",
  "title": "Membership fees 2016/02",
  "transmitted": false,
  "transmitted_at": null,
  "prepaid_amount_cents": 0,
  "prepaid_amount_currency": "EUR",
  "settled_amount_cents": 0,
  "settled_amount_currency": "EUR",
  "expected_invoices_count": 0,
  "invoice_ids": [
  ]
}
422: Unprocessable Entity
{
  "error": "invalid_company_id"
}
The following /imports/:id/transmit endpoint will be deprecated soon in favour of manually transmitting an Import via the ClubCollect User Interface. This gives treasurers the opportunity to configure settings correctly which is not possible via the API.
put
Transmit Import
https://api.clubcollect.com/api/v2/imports/:id/transmit
Instruct ClubCollect to transmit the Import, initiating the invoice collection process.
Request
Response
Request
Path Parameters
id
required
string
Import ID
Headers
Authorization
required
string
ApiKey <api_key>
Query Parameters
api_key
optional
string
Partner API Key (Deprecated)
Response
200: OK
Batch successfully transmitted.
{
  "import_id": "a1f3216863ba5d5424dcbace46ab37be98d70c92",
  "title": "Membership fees 2016/02",
  "transmitted": true,
  "transmitted_at": "2016-02-12T20:55:19Z",
  "prepaid_amount_cents": 0,
  "prepaid_amount_currency": "EUR",
  "settled_amount_cents": 0,
  "settled_amount_currency": "EUR",
  "expected_invoices_count": 0,
  "invoice_ids": [
  ]
}
404: Not Found
{
  "error": "invalid_import_id"
}
422: Unprocessable Entity
{
  "error": "import_already_transmitted"
}
Ensure you have finished creating all Invoices for this Import before calling this method. It is not possible to change or add more Invoices to an Import after the Import has been transmitted.
put
Update Import
https://api.clubcollect.com/api/v2/imports/:id
Update an import.
Request
Response
Request
Path Parameters
id
required
string
Import ID
Headers
Authorization
required
string
ApiKey <api_key>
Query Parameters
api_key
optional
string
Partner API Key (Deprecated)
Body Parameters
expected_invoices_count
optional
string
Number of invoices expected to be added to this import. If provided the Import cannot be transmitted from the ClubCollect User Interface until all invoices are created.
Response
200: OK
{
  "import_id": "a1f3216863ba5d5424dcbace46ab37be98d70c92",
  "title": "Membership fees 2016/02",
  "transmitted": false,
  "transmitted_at": null,
  "prepaid_amount_cents": 0,
  "prepaid_amount_currency": "EUR",
  "settled_amount_cents": 0,
  "settled_amount_currency": "EUR",
  "expected_invoices_count": 0,
  "invoice_ids": [
  ]
}
302: Found
{
  "error": "invalid_import_id"
}
404: Not Found
{
  "error": "invalid_company_id"
}
422: Unprocessable Entity
{
  "error": "import_already_transmitted"
}
delete
Delete Import
https://api.clubcollect.com/api/v2/imports/:id
Deletes an import and all the invoices that have been created for the import.
Request
Response
Request
Path Parameters
id
required
string
Import ID
Headers
Authorization
required
string
ApiKey <api_key>
Query Parameters
api_key
optional
string
Partner API Key (Deprecated)
Response
204: No Content
Batch successfully deleted.
​
404: Not Found
{
  "error": "invalid_import_id"
}
422: Unprocessable Entity
{
  "error": "import_already_transmitted"
}
get
Fetch Company Imports
https://api.clubcollect.com/api/v2/companies/:id/imports
Returns the list of import batches created by a company, paginated and sorted in ascending order, i.e. from oldest to newest.
Request
Response
Request
Path Parameters
id
required
string
ID of the company for which batches are requested.
page_number
optional
string
Page number requested. If not specified, default to 1.
page_size
optional
string
Number of results per page. If not specified, default to 30.
Headers
Authorization
required
string
ApiKey <api_key>
Query Parameters
api_key
optional
string
Partner API Key (Deprecated)
Response
200: OK
"imports": [
  {
   "company_id": "477b4e18deb43367449d1ca74dc7f67b91e68ad3",
   "import_id": "78d366d133d6e26e32106b645f92c899f410897c",
   "title": "Membership fee 2019/1",
   "transmitted": "true",
   "transmitted_at": "2019-09-12T20:55:19Z"
  },
  {
   "company_id": "477b4e18deb43367449d1ca74dc7f67b91e68ad3",
   "import_id": "bffce68a7d109a9de3bfd3f3baacd06516492272",
   "title": "Membership fee 2019/2",
   "transmitted": "true",
   "transmitted_at": "2019-09-116T15:53:08Z"
  },
]
"page": {
  "page_number": 1,
  "total_pages": 1
}
404: Not Found
Company ID does not exist.
{
  "error": "not_found"
}
API Documentation - Previous
Company
Next - API Documentation
Invoice
Last updated 2 months ago
Import

getShow Import

postCreate Import

putTransmit Import

putUpdate Import

deleteDelete Import

getFetch Company Imports

get
Show Import

post
Create Import

put
Transmit Import

put
Update Import

delete
Delete Import

get
Fetch Company Imports
