Transactions

GET 
/api/accounting/transactions

Transactions

Request

Query Parameters

contact_id integer
Example: 106
account_id integer
Example: 1
type TransactionTypeEnum

Possible values: [income, expense, order, reservation]

Header Parameters

X-Company-Slug stringrequired

Responses

200

Successful response

application/json

Schema

Schema

meta

object

required

total numberrequired

per_page numberrequired

current_page numberrequired

last_page numberrequired

first_page numberrequired

first_page_url stringrequired

last_page_url stringrequired

next_page_url stringnullablerequired

previous_page_url stringnullablerequired

data

get_transaction_single[]

required

Array [

id string

document_id stringnullable

account_id string

contact_id stringnullable

created_by_id string

amount numbernullable

currency CurrencyEnum (string)

Possible values: [EUR, USD, GBP, TRY]

type TransactionTypeEnum (string)

Possible values: [income, expense, order, reservation]

reference stringnullable

description stringnullable

paid_at string

created_at string

updated_at string

order_id stringnullable

reservation_id stringnullable

tips numbernullable

discount numbernullable

payment_method TransactionPaymentMethodEnums (string)

Possible values: [cash, credit_card, bank_transfer, qr]

account

object

id stringrequired

created_by_id stringrequired

name stringrequired

number stringnullablerequired

currency CurrencyEnum (string)required

Possible values: [EUR, USD, GBP, TRY]

bank_name stringnullablerequired

bank_phone stringnullablerequired

bank_address stringnullablerequired

enabled booleanrequired

created_at date-timerequired

updated_at date-timerequired

deleted_at date-timenullablerequired

total integerrequired

]

Example (from schema)

{
  "meta": {
    "total": 0,
    "per_page": 0,
    "current_page": 0,
    "last_page": 0,
    "first_page": 0,
    "first_page_url": "string",
    "last_page_url": "string",
    "next_page_url": "string",
    "previous_page_url": "string"
  },
  "data": [
    {
      "id": "string",
      "document_id": "string",
      "account_id": "string",
      "contact_id": "string",
      "created_by_id": "string",
      "amount": 0,
      "currency": "EUR",
      "type": "income",
      "reference": "string",
      "description": "string",
      "paid_at": "string",
      "created_at": "string",
      "updated_at": "string",
      "order_id": "string",
      "reservation_id": "string",
      "tips": 0,
      "discount": 0,
      "payment_method": "cash",
      "account": {
        "id": "2",
        "created_by_id": "1",
        "name": "YAPI KREDI (KMH)",
        "number": "TR3284972923473",
        "currency": "EUR",
        "bank_name": "yapı kredi",
        "bank_phone": 2521111111,
        "bank_address": "İstanbul",
        "enabled": true,
        "created_at": "2024-07-16T20:35:36.937+03:00",
        "updated_at": "2024-07-16T20:35:36.937+03:00",
        "deleted_at": "2024-07-16T20:35:36.937+03:00",
        "total": 0
      }
    }
  ]
}

Loading...