Skip to content
/
List all payments

Kanbert (v1)

Download OpenAPI description
api.json
api.yaml
Languages
Servers
https://api.kanbert.com/api/v1

Users

Operations

Clients

Operations

Projects

Operations

Tasks

Operations
Webhooks

Task Comments

Operations
Webhooks

Efforts

Operations

Contacts

Operations

Companies

Operations
Webhooks

Offers

Operations

Outgoing Invoices

Operations

Payments

Operations

List all payment accounts

Request

Required scopes: payments:read

Security
http or oauth2
Query
page[size]integer

The number of results that will be returned per page.

Default 30
page[cursor]string

The cursor to start the pagination from.

filterstring

Allowed filter fields (with allowed operators):

FieldTypeOperators
archivedenum: with, only, withouteq
titlestringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
typeenum<PaymentAccountType>eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
organisationstringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
created_atdatetimeeq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, isnull, isnotnull, notnull
owner.idid<UserData>eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
owner.emailstringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull

Filtering expression. Accepts either JSON (array/tree of conditions) or a readable string DSL.

You can check the full syntax at Docs Filtering section.

Special values:

  • me.id — current authenticated user id (usable on fields of type id). Example: id eq me.id
  • now — current date-time. Example: dueOn lt now
  • sow/eow — start/end of week. Examples: dueOn gt sow, dueOn lt eow
  • som/eom — start/end of month. Examples: dueOn gt som, dueOn lt eom
  • today — special date for today; with eq it expands to the whole day range. Example: dueOn eq today
  • today±Nd — relative day offset. Examples: today-30d, today+5d.
Example: filter=title contains "Acme" and (created_at >= "2024-01-01" or client.name contains "Corp")
sortstring

Available sorts are title, type, organization, identifier, created_at.
You can sort by multiple options by separating them with a comma. To sort in descending order, use - sign in front of the sort, for example: -title.

Example: sort=sort=-created_at,title
curl -i -X GET \
  'https://api.kanbert.com/api/v1/payment-accounts?page%5Bsize%5D=30&page%5Bcursor%5D=string&filter=title+contains+%22Acme%22+and+%28created_at+%3E%3D+%222024-01-01%22+or+client.name+contains+%22Corp%22%29&sort=sort%3D-created_at%2Ctitle' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The cursor paginated collection of PaymentAccountData

Bodyapplication/json
dataArray of objects(PaymentAccountData)required

The list of items

data[].​idstringrequired
data[].​is_defaultbooleanrequired
data[].​titlestringrequired
data[].​organizationstring or nullrequired
data[].​identifierstring or nullrequired
data[].​typestring(PaymentAccountType)required
Enum"account""employee_expenses"
data[].​ownerUserData (object) or nullrequired
Any of:
data[].​owner.​idstringrequired
data[].​owner.​first_namestringrequired
data[].​owner.​last_namestringrequired
data[].​owner.​emailstringrequired
data[].​owner.​typestring(UserType)required
Enum"user""guest""tax_advisor""integration"
data[].​owner.​spaceobject(SpaceData)required
data[].​owner.​space.​idstringrequired
data[].​owner.​space.​namestringrequired
data[].​updated_atstring or null(date-time)required
data[].​created_atstring(date-time)required
data[].​deleted_atstring or null(date-time)required
linksArray of stringsrequired
metaobjectrequired
meta.​pathstring or nullrequired

Base path for paginator generated URLs.

meta.​per_pageintegerrequired

Number of items shown per page.

meta.​next_cursorstring or nullrequired
meta.​next_cursor_urlstring or nullrequired
meta.​prev_cursorstring or nullrequired
meta.​prev_cursor_urlstring or nullrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "links": [
    "string"
  ],
  "meta": {
    "path": "string",
    "per_page": 0,
    "next_cursor": "string",
    "next_cursor_url": "string",
    "prev_cursor": "string",
    "prev_cursor_url": "string"
  }
}

List all payments

Request

Required scopes: payments:read

Security
http or oauth2
Query
page[size]integer

The number of results that will be returned per page.

Default 30
page[cursor]string

The cursor to start the pagination from.

filterstring

Allowed filter fields (with allowed operators):

FieldTypeOperators
archivedenum: with, only, withouteq
referencestringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
typeenumeq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
ibanstringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
payment_account.idid<PaymentAccountData>eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
payment_account.typeenum<PaymentAccountType>eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
payment_account.ibanstringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
outgoing_invoice.idid<OutgoingInvoiceData>eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
date_of_paymentdateeq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, isnull, isnotnull, notnull

Filtering expression. Accepts either JSON (array/tree of conditions) or a readable string DSL.

You can check the full syntax at Docs Filtering section.

Special values:

  • me.id — current authenticated user id (usable on fields of type id). Example: id eq me.id
  • now — current date-time. Example: dueOn lt now
  • sow/eow — start/end of week. Examples: dueOn gt sow, dueOn lt eow
  • som/eom — start/end of month. Examples: dueOn gt som, dueOn lt eom
  • today — special date for today; with eq it expands to the whole day range. Example: dueOn eq today
  • today±Nd — relative day offset. Examples: today-30d, today+5d.
Example: filter=title contains "Acme" and (created_at >= "2024-01-01" or client.name contains "Corp")
sortstring

Available sorts are reference, iban, date_of_payment, created_at.
You can sort by multiple options by separating them with a comma. To sort in descending order, use - sign in front of the sort, for example: -title.

Example: sort=sort=-created_at,title
curl -i -X GET \
  'https://api.kanbert.com/api/v1/payments?page%5Bsize%5D=30&page%5Bcursor%5D=string&filter=title+contains+%22Acme%22+and+%28created_at+%3E%3D+%222024-01-01%22+or+client.name+contains+%22Corp%22%29&sort=sort%3D-created_at%2Ctitle' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The cursor paginated collection of PaymentData

Bodyapplication/json
dataArray of objects(PaymentData)required

The list of items

data[].​idstringrequired
data[].​typestringrequired
data[].​date_of_paymentstring or null(date)required
data[].​referencestringrequired
data[].​ibanstring or nullrequired
data[].​bicstring or nullrequired
data[].​valuenumberrequired
data[].​payment_accountobject(PaymentAccountData)required
data[].​payment_account.​idstringrequired
data[].​payment_account.​is_defaultbooleanrequired
data[].​payment_account.​titlestringrequired
data[].​payment_account.​organizationstring or nullrequired
data[].​payment_account.​identifierstring or nullrequired
data[].​payment_account.​typestring(PaymentAccountType)required
Enum"account""employee_expenses"
data[].​payment_account.​ownerUserData (object) or nullrequired
Any of:
data[].​payment_account.​owner.​idstringrequired
data[].​payment_account.​owner.​first_namestringrequired
data[].​payment_account.​owner.​last_namestringrequired
data[].​payment_account.​owner.​emailstringrequired
data[].​payment_account.​owner.​typestring(UserType)required
Enum"user""guest""tax_advisor""integration"
data[].​payment_account.​owner.​spaceobject(SpaceData)required
data[].​payment_account.​owner.​space.​idstringrequired
data[].​payment_account.​owner.​space.​namestringrequired
data[].​payment_account.​updated_atstring or null(date-time)required
data[].​payment_account.​created_atstring(date-time)required
data[].​payment_account.​deleted_atstring or null(date-time)required
data[].​bookingsArray of objects(PaymentBookingData)required
data[].​bookings[].​idstringrequired
data[].​bookings[].​payment_typestringrequired
data[].​bookings[].​referencestringrequired
data[].​bookings[].​valuenumberrequired
data[].​bookings[].​outgoing_invoice_idstring or nullrequired
data[].​bookings[].​updated_atstring or null(date-time)required
data[].​bookings[].​created_atstring(date-time)required
data[].​bookings[].​deleted_atstring or null(date-time)required
data[].​updated_atstring or null(date-time)required
data[].​created_atstring(date-time)required
data[].​deleted_atstring or null(date-time)required
linksArray of stringsrequired
metaobjectrequired
meta.​pathstring or nullrequired

Base path for paginator generated URLs.

meta.​per_pageintegerrequired

Number of items shown per page.

meta.​next_cursorstring or nullrequired
meta.​next_cursor_urlstring or nullrequired
meta.​prev_cursorstring or nullrequired
meta.​prev_cursor_urlstring or nullrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "links": [
    "string"
  ],
  "meta": {
    "path": "string",
    "per_page": 0,
    "next_cursor": "string",
    "next_cursor_url": "string",
    "prev_cursor": "string",
    "prev_cursor_url": "string"
  }
}

Add payment for an outgoing invoice

Request

Required scopes: payments:write

Security
http or oauth2
Bodyapplication/jsonrequired
typestringrequired
Enum"in""out"
payment_account_idstringrequired
referencestring<= 255 charactersrequired
date_of_paymentstring(date-time)required
customer_namestring<= 255 characters
ibanstring<= 255 characters
bicstring<= 255 characters
bookingsArray of objectsrequired
bookings[].​outgoing_invoice_idstringrequired

Invoice needs to be booked

bookings[].​valuenumberrequired
curl -i -X POST \
  https://api.kanbert.com/api/v1/payments/outgoing-invoice \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "in",
    "payment_account_id": "string",
    "reference": "string",
    "date_of_payment": "2019-08-24T14:15:22Z",
    "customer_name": "string",
    "iban": "string",
    "bic": "string",
    "bookings": [
      {
        "outgoing_invoice_id": "string",
        "value": 0
      }
    ]
  }'

Responses

PaymentData

Bodyapplication/json
idstringrequired
typestringrequired
date_of_paymentstring or null(date)required
referencestringrequired
ibanstring or nullrequired
bicstring or nullrequired
valuenumberrequired
payment_accountobject(PaymentAccountData)required
payment_account.​idstringrequired
payment_account.​is_defaultbooleanrequired
payment_account.​titlestringrequired
payment_account.​organizationstring or nullrequired
payment_account.​identifierstring or nullrequired
payment_account.​typestring(PaymentAccountType)required
Enum"account""employee_expenses"
payment_account.​ownerUserData (object) or nullrequired
Any of:
payment_account.​owner.​idstringrequired
payment_account.​owner.​first_namestringrequired
payment_account.​owner.​last_namestringrequired
payment_account.​owner.​emailstringrequired
payment_account.​owner.​typestring(UserType)required
Enum"user""guest""tax_advisor""integration"
payment_account.​owner.​spaceobject(SpaceData)required
payment_account.​owner.​space.​idstringrequired
payment_account.​owner.​space.​namestringrequired
payment_account.​updated_atstring or null(date-time)required
payment_account.​created_atstring(date-time)required
payment_account.​deleted_atstring or null(date-time)required
bookingsArray of objects(PaymentBookingData)required
bookings[].​idstringrequired
bookings[].​payment_typestringrequired
bookings[].​referencestringrequired
bookings[].​valuenumberrequired
bookings[].​outgoing_invoice_idstring or nullrequired
bookings[].​updated_atstring or null(date-time)required
bookings[].​created_atstring(date-time)required
bookings[].​deleted_atstring or null(date-time)required
updated_atstring or null(date-time)required
created_atstring(date-time)required
deleted_atstring or null(date-time)required
Response
application/json
{
  "id": "string",
  "type": "string",
  "date_of_payment": "2019-08-24",
  "reference": "string",
  "iban": "string",
  "bic": "string",
  "value": 0,
  "payment_account": {
    "id": "string",
    "is_default": true,
    "title": "string",
    "organization": "string",
    "identifier": "string",
    "type": "account",
    "owner": { … },
    "updated_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "deleted_at": "2019-08-24T14:15:22Z"
  },
  "bookings": [
    { … }
  ],
  "updated_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z"
}

Associate an outgoing invoice with an outgoing credit

Request

Required scopes: payments:write

Security
http or oauth2
Bodyapplication/jsonrequired
referencestring<= 255 charactersrequired
date_of_paymentstring(date-time)required
outgoing_invoice_idstringrequired

Invoice needs to be booked & is_credit = false

outgoing_credit_idstringrequired

Invoice needs to be booked & is_credit = true

valuenumberrequired
curl -i -X POST \
  https://api.kanbert.com/api/v1/payments/outgoing-invoice-credit \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "reference": "string",
    "date_of_payment": "2019-08-24T14:15:22Z",
    "outgoing_invoice_id": "string",
    "outgoing_credit_id": "string",
    "value": 0
  }'

Responses

The collection of OutgoingInvoicePaymentBookingData

Bodyapplication/jsonArray [
idstringrequired
typestringrequired
payment_typestringrequired
referencestringrequired
valuenumberrequired
outgoing_invoice_idstring or nullrequired
reference_outgoing_invoice_idstring or nullrequired
updated_atstring or null(date-time)required
created_atstring(date-time)required
deleted_atstring or null(date-time)required
]
Response
application/json
[
  {
    "id": "string",
    "type": "string",
    "payment_type": "string",
    "reference": "string",
    "value": 0,
    "outgoing_invoice_id": "string",
    "reference_outgoing_invoice_id": "string",
    "updated_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "deleted_at": "2019-08-24T14:15:22Z"
  }
]

Usergroups & Teams

Operations

Settings

Operations

Integration

Operations

Files

Operations

Custom Fields

Operations

Webhook Management

Operations

Schemas

Schemas