Ticket

Fetch Tickets

GET https://app.clubcollect.com/api/v2/invoices/:id/tickets

Path Parameters

Name	Type	Description
id*	string	ID of Invoice for which Tickets wish to be fetched.

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 application/json.

200

"tickets": [
  {
   "ticket_id": "...",
   "message": "I don't want to pay",
   "sender": "CUSTOMER",
   "date": "..."
  },
  {
   "ticket_id": "...",
   "message": "Please pay before the 30th",
   "sender": "COMPANY",
   "date": "..."
   }
]

404

{
  "error": "invalid_invoice_id"
}

Create Ticket

POST https://app.clubcollect.com/api/v2/invoices/:id/tickets

Create a support Ticket for an Invoice.

Path Parameters

Name	Type	Description
id*	string	ID for the Invoice to which the Ticket should be attached.

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 application/json.

Request Body

Name	Type	Description
message*	string	Contents of the Ticket.

200

{
  "ticket_id": "...",
  "message": "Please pay before the 30th",
  "sender": "COMPANY",
  "date": "..."
}

404

{
  "error": "invalid_invoice_id"
}

422

{
  "error": "invalid_message"
}

Archive Ticket

POST https://app.clubcollect.com/api/v2/invoices/:id/tickets/actions/archive

Archive all Tickets for an Invoice.

Path Parameters

Name	Type	Description
id*	string	ID of the Invoice for which Tickets should be archived.

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 application/json.

204

404

{
  "error": "invalid_invoice_id"
}

Assign Ticket to Support

POST https://app.clubcollect.com/api/v2/invoices/:id/tickets/actions/assign:to:support

Assign Tickets for an Invoice to ClubCollect Support Team.

Path Parameters

Name	Type	Description
id*	string	ID of Invoice for which Tickets should be assigned to Support.

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 application/json.

204

404

{
  "error": "invalid_invoice_id"
}

Fetch All Tickets

GET https://app.clubcollect.com/api/v2/companies/:id/tickets/:status

Returns the list of tickets linked to a company, filtered by Ticket status, paginated and sorted in ascending order, i.e. from oldest to newest.

Path Parameters

Name	Type	Description
status*	string	One of: { unanswered answered archived }
id*	string	ID of Company for which Tickets should be fetched.

Query Parameters

Name	Type	Description
api:key	string	Partner API Key (Deprecated)
page:number	integer	Page number. If it's not given, default to 1.
page:size	integer	Number of results per page. If it's not given, defaults to 30. Maximum permitted value is 100.

Headers

Name	Type	Description
Authorization*	string	ApiKey <api_key>

200

"tickets": [
  {
   "invoice_id": "...",
   "ticket_id": "...",
   "message": "I don't want to pay",
   "sender": "CUSTOMER",
   "date": "..."
  },
  {
   "invoice_id": "...",
   "ticket_id": "...",
   "message": "Please pay before the 30th",
   "sender": "COMPANY",
   "date": "..."
   }
]
"page": {
  "page_number": 1,
  "page_size": 12,
  "total_entries": 53,
  "total_pages": 5
}

404

{
  "error": "not_found"
}

422

{
  "error": "invalid_action"
}