Dokumentasi API

Cash Flows

# Cash Flows Endpoint

> **info:** Mengolah data aliran dana pribadi (catatan keuangan).

---

-   [Base URL](#section-1)
-   [Add New Cash Flow](#section-2)
-   [Update Cash Flow](#section-3)
-   [Get All Cash Flows](#section-4)
-   [Detail Cash Flow](#section-5)
-   [Delete Cash Flow](#section-6)
-   [Get Your Labels](#section-7)
-   [Get Stats Daily](#section-8)
-   [Get Stats Monthly](#section-9)
-   [Delete All Cash Flows](#section-10)

## Base URL

`https://open-api.delcom.org/api/v1`

## Add New Cash Flow

> Mencatat transaksi arus kas baru (pemasukan atau pengeluaran).

-   URL
    -   `/cash-flows`
-   Method
    -   POST
-   Headers
    -   `Content-Type`: `application/json`
    -   `Authorization`: `Bearer <token>`
-   Request Body
    -   `type` as `inflow | outflow`
    -   `source` as `cash | savings | loans`
    -   `label` as `string`
    -   `description` as `string`
    -   `nominal` as `number`
-   Contoh Request
    ```http
    POST {{BaseURL}}/cash-flows
    Accept: application/json
    Authorization: Bearer <token>
    Content-Type: application/json
    
    {
        "type": "inflow",
        "source": "cash",
        "label": "Gaji Bulanan",
        "description": "Contoh deskripsi",
        "nominal": 1
    }
    ```
-   Response Berhasil
    ```json
    {
        "status": "success",
        "message": "Berhasil menambahkan data",
        "data": {
            "cash_flow_id": 1
        }
    }
    ```
-   Response Gagal
    ```json
    {
        "status": "fail",
        "message": "Data tidak valid",
        "data": {
            "field": [
                "Pesan validasi"
            ]
        }
    }
    ```

## Update Cash Flow

> Memperbarui data transaksi arus kas yang telah tercatat.

-   URL
    -   `/cash-flows/:id`
-   Method
    -   PUT
-   Headers
    -   `Content-Type`: `application/json`
    -   `Authorization`: `Bearer <token>`
-   Request Body
    -   `type` as `inflow | outflow`
    -   `source` as `cash | savings | loans`
    -   `label` as `string`
    -   `description` as `string`
    -   `nominal` as `number`
-   Contoh Request
    ```http
    PUT {{BaseURL}}/cash-flows/1
    Accept: application/json
    Authorization: Bearer <token>
    Content-Type: application/json
    
    {
        "type": "inflow",
        "source": "cash",
        "label": "Gaji Bulanan",
        "description": "Contoh deskripsi",
        "nominal": 1
    }
    ```
-   Response Berhasil
    ```json
    {
        "status": "success",
        "message": "Berhasil mengubah data"
    }
    ```
-   Response Gagal
    ```json
    {
        "status": "fail",
        "message": "Data tidak valid",
        "data": {
            "field": [
                "Pesan validasi"
            ]
        }
    }
    ```

## Get All Cash Flows

> Mengambil daftar seluruh riwayat pencatatan arus kas keuangan.

-   URL
    -   `/cash-flows`
-   Parameters
    -   `type` as `inflow | outflow`
    -   `source` as `cash | savings | loans`
    -   `label` as `string`
    -   `start_date` as `timestamp`, example: `2024-10-05 00:00:00`
    -   `end_date` as `timestamp`, example: `2024-10-05 23:59:59`
-   Method
    -   GET
-   Headers
    -   `Authorization`: `Bearer <token>`
-   Contoh Request
    ```http
    GET {{BaseURL}}/cash-flows
    Accept: application/json
    Authorization: Bearer <token>
    ```
-   Response Berhasil
    ```json
    {
        "status": "success",
        "message": "Berhasil mengambil data",
        "data": {
            "cash_flows": [
                {
                    "id": 4,
                    "user_id": 1,
                    "type": "outflow",
                    "source": "savings",
                    "label": "alat-elektronik",
                    "description": "Membeli kebutuhan keyboard dan mouse",
                    "nominal": 400000,
                    "created_at": "2024-10-05T12:09:16.000000Z",
                    "updated_at": "2024-10-05T12:09:16.000000Z"
                },
                {
                    "id": 3,
                    "user_id": 1,
                    "type": "outflow",
                    "source": "cash",
                    "label": "alat-mandi",
                    "description": "Membeli kebutuhan alat mandi seperti sabun, odol.",
                    "nominal": 100000,
                    "created_at": "2024-10-05T11:28:02.000000Z",
                    "updated_at": "2024-10-05T11:28:02.000000Z"
                },
                {
                    "id": 2,
                    "user_id": 1,
                    "type": "inflow",
                    "source": "cash",
                    "label": "gaji",
                    "description": "Gaji bulanan",
                    "nominal": 2500000,
                    "created_at": "2024-10-05T11:26:45.000000Z",
                    "updated_at": "2024-10-05T11:26:48.000000Z"
                }
            ],
            "stats": {
                "cashflow": 2000000,
                "total_outflow": 500000,
                "total_outflow_savings": 400000,
                "total_outflow_savings_alat-elektronik": 400000,
                "total_outflow_label_alat-elektronik": 400000,
                "total_outflow_cash": 100000,
                "total_outflow_cash_alat-mandi": 100000,
                "total_outflow_label_alat-mandi": 100000,
                "total_inflow": 2500000,
                "total_inflow_cash": 2500000,
                "total_inflow_cash_gaji": 2500000,
                "total_inflow_label_gaji": 2500000
            }
        }
    }
    ```
-   Response Gagal
    ```json
    {
        "status": "fail",
        "message": "Data tidak valid",
        "data": {
            "field": [
                "Pesan validasi"
            ]
        }
    }
    ```

## Detail Cash Flow

> Mendapatkan rincian lengkap dari suatu transaksi arus kas berdasarkan ID.

-   URL
    -   `/cash-flows/:id`
-   Method
    -   GET
-   Headers
    -   `Authorization`: `Bearer <token>`
-   Contoh Request
    ```http
    GET {{BaseURL}}/cash-flows/1
    Accept: application/json
    Authorization: Bearer <token>
    ```
-   Response Berhasil
    ```json
    {
        "status": "success",
        "message": "Berhasil mengambil data",
        "data": {
            "cash_flow": {
                "id": 4,
                "user_id": 1,
                "type": "outflow",
                "source": "savings",
                "label": "alat-elektronik",
                "description": "Membeli kebutuhan keyboard dan mouse",
                "nominal": 400000,
                "created_at": "2024-10-05T12:09:16.000000Z",
                "updated_at": "2024-10-05T12:09:16.000000Z"
            }
        }
    }
    ```
-   Response Gagal
    ```json
    {
        "status": "fail",
        "message": "Data tidak valid",
        "data": {
            "field": [
                "Pesan validasi"
            ]
        }
    }
    ```

## Delete Cash Flow

> Menghapus catatan transaksi arus kas dari sistem.

-   URL
    -   `/cash-flows/:id`
-   Method
    -   DELETE
-   Headers
    -   `Authorization`: `Bearer <token>`
-   Contoh Request
    ```http
    DELETE {{BaseURL}}/cash-flows/1
    Accept: application/json
    Authorization: Bearer <token>
    ```
-   Response Berhasil
    ```json
    {
        "status": "success",
        "message": "Berhasil menghapus data"
    }
    ```
-   Response Gagal
    ```json
    {
        "status": "fail",
        "message": "Data tidak valid",
        "data": {
            "field": [
                "Pesan validasi"
            ]
        }
    }
    ```

## Get Your Labels

> Mengambil daftar label atau kategori yang digunakan pada catatan arus kas.

-   URL
    -   `/cash-flows/labels`
-   Method
    -   GET
-   Headers
    -   `Authorization`: `Bearer <token>`
-   Contoh Request
    ```http
    GET {{BaseURL}}/cash-flows/labels
    Accept: application/json
    Authorization: Bearer <token>
    ```
-   Response Berhasil
    ```json
    {
        "status": "success",
        "message": "Berhasil mengambil data",
        "data": {
            "labels": ["gaji", "alat-mandi"]
        }
    }
    ```
-   Response Gagal
    ```json
    {
        "status": "fail",
        "message": "Data tidak valid",
        "data": {
            "field": [
                "Pesan validasi"
            ]
        }
    }
    ```

## Get Stats Daily

> Mendapatkan statistik ringkasan arus kas harian (total pemasukan & pengeluaran).

-   URL
    -   `/cash-flows/stats/daily`
-   Parameters
    -   `end_date` as `timestamp`, example: `2024-10-05 23:59:59`
    -   `total_data` as `number`
-   Method
    -   GET
-   Headers
    -   `Authorization`: `Bearer <token>`
-   Contoh Request
    ```http
    GET {{BaseURL}}/cash-flows/stats/daily
    Accept: application/json
    Authorization: Bearer <token>
    ```
-   Response Berhasil
    ```json
    {
        "status": "success",
        "message": "Berhasil mengambil data",
        "data": {
            "stats_inflow": {
                "01-10-2024": 0,
                "02-10-2024": 0,
                "03-10-2024": 0,
                "04-10-2024": 0,
                "05-10-2024": 2500000,
                "06-10-2024": 0,
                "07-10-2024": 0
            },
            "stats_outflow": {
                "01-10-2024": 0,
                "02-10-2024": 0,
                "03-10-2024": 0,
                "04-10-2024": 0,
                "05-10-2024": 500000,
                "06-10-2024": 0,
                "07-10-2024": 0
            },
            "stats_cashflow": {
                "01-10-2024": 0,
                "02-10-2024": 0,
                "03-10-2024": 0,
                "04-10-2024": 0,
                "05-10-2024": 2000000,
                "06-10-2024": 0,
                "07-10-2024": 0
            }
        }
    }
    ```
-   Response Gagal
    ```json
    {
        "status": "fail",
        "message": "Data tidak valid",
        "data": {
            "field": [
                "Pesan validasi"
            ]
        }
    }
    ```

## Get Stats Monthly

> Mendapatkan statistik ringkasan arus kas bulanan.

-   URL
    -   `/cash-flows/stats/monthly`
-   Parameters
    -   `end_date` as `timestamp`, example: `2024-10-05 23:59:59`
    -   `total_data` as `number`
-   Method
    -   GET
-   Headers
    -   `Authorization`: `Bearer <token>`
-   Contoh Request
    ```http
    GET {{BaseURL}}/cash-flows/stats/monthly
    Accept: application/json
    Authorization: Bearer <token>
    ```
-   Response Berhasil
    ```json
    {
        "status": "success",
        "message": "Berhasil mengambil data",
        "data": {
            "stats_inflow": {
                "01-2024": 0,
                "02-2024": 0,
                "03-2024": 0,
                "04-2024": 0,
                "05-2024": 0,
                "06-2024": 0,
                "07-2024": 0,
                "08-2024": 0,
                "09-2024": 0,
                "10-2024": 2500000,
                "11-2024": 0,
                "12-2024": 0
            },
            "stats_outflow": {
                "01-2024": 0,
                "02-2024": 0,
                "03-2024": 0,
                "04-2024": 0,
                "05-2024": 0,
                "06-2024": 0,
                "07-2024": 0,
                "08-2024": 0,
                "09-2024": 0,
                "10-2024": 500000,
                "11-2024": 0,
                "12-2024": 0
            },
            "stats_cashflow": {
                "01-2024": 0,
                "02-2024": 0,
                "03-2024": 0,
                "04-2024": 0,
                "05-2024": 0,
                "06-2024": 0,
                "07-2024": 0,
                "08-2024": 0,
                "09-2024": 0,
                "10-2024": 2000000,
                "11-2024": 0,
                "12-2024": 0
            }
        }
    }
    ```
-   Response Gagal
    ```json
    {
        "status": "fail",
        "message": "Data tidak valid",
        "data": {
            "field": [
                "Pesan validasi"
            ]
        }
    }
    ```

## Delete All Cash Flows

> Menghapus semua data catatan aliran kas (cash flows) milik pengguna saat ini secara permanen.

-   URL
    -   `/cash-flows`
-   Method
    -   DELETE
-   Headers
    -   `Authorization`: `Bearer <token>`
-   Contoh Request
    ```http
    DELETE {{BaseURL}}/cash-flows
    Accept: application/json
    Authorization: Bearer <token>
    ```
-   Response Berhasil
    ```json
    {
        "status": "success",
        "message": "Berhasil menghapus semua data cash flow"
    }
    ```
-   Response Gagal
    ```json
    {
        "status": "fail",
        "message": "Unauthenticated."
    }
    ```

Cash Flows Endpoint

info: Mengolah data aliran dana pribadi (catatan keuangan).

Base URL
Add New Cash Flow
Update Cash Flow
Get All Cash Flows
Detail Cash Flow
Delete Cash Flow
Get Your Labels
Get Stats Daily
Get Stats Monthly
Delete All Cash Flows

Base URL

https://open-api.delcom.org/api/v1

Add New Cash Flow

Mencatat transaksi arus kas baru (pemasukan atau pengeluaran).

URL
- /cash-flows
Method
- POST
Headers
- Content-Type: application/json
- Authorization: Bearer <token>
Request Body
- type as inflow | outflow
- source as cash | savings | loans
- label as string
- description as string
- nominal as number

Contoh Request

POST {{BaseURL}}/cash-flows
Accept: application/json
Authorization: Bearer <token>
Content-Type: application/json

{
    "type": "inflow",
    "source": "cash",
    "label": "Gaji Bulanan",
    "description": "Contoh deskripsi",
    "nominal": 1
}

Response Berhasil

{
    "status": "success",
    "message": "Berhasil menambahkan data",
    "data": {
        "cash_flow_id": 1
    }
}

Response Gagal

{
    "status": "fail",
    "message": "Data tidak valid",
    "data": {
        "field": [
            "Pesan validasi"
        ]
    }
}

Update Cash Flow

Memperbarui data transaksi arus kas yang telah tercatat.

URL
- /cash-flows/:id
Method
- PUT
Headers
- Content-Type: application/json
- Authorization: Bearer <token>
Request Body
- type as inflow | outflow
- source as cash | savings | loans
- label as string
- description as string
- nominal as number

Contoh Request

PUT {{BaseURL}}/cash-flows/1
Accept: application/json
Authorization: Bearer <token>
Content-Type: application/json

{
    "type": "inflow",
    "source": "cash",
    "label": "Gaji Bulanan",
    "description": "Contoh deskripsi",
    "nominal": 1
}

Response Berhasil

{
    "status": "success",
    "message": "Berhasil mengubah data"
}

Response Gagal

{
    "status": "fail",
    "message": "Data tidak valid",
    "data": {
        "field": [
            "Pesan validasi"
        ]
    }
}

Get All Cash Flows

Mengambil daftar seluruh riwayat pencatatan arus kas keuangan.

URL
- /cash-flows
Parameters
- type as inflow | outflow
- source as cash | savings | loans
- label as string
- start_date as timestamp, example: 2024-10-05 00:00:00
- end_date as timestamp, example: 2024-10-05 23:59:59
Method
- GET
Headers
- Authorization: Bearer <token>

Contoh Request

GET {{BaseURL}}/cash-flows
Accept: application/json
Authorization: Bearer <token>

Response Berhasil

{
    "status": "success",
    "message": "Berhasil mengambil data",
    "data": {
        "cash_flows": [
            {
                "id": 4,
                "user_id": 1,
                "type": "outflow",
                "source": "savings",
                "label": "alat-elektronik",
                "description": "Membeli kebutuhan keyboard dan mouse",
                "nominal": 400000,
                "created_at": "2024-10-05T12:09:16.000000Z",
                "updated_at": "2024-10-05T12:09:16.000000Z"
            },
            {
                "id": 3,
                "user_id": 1,
                "type": "outflow",
                "source": "cash",
                "label": "alat-mandi",
                "description": "Membeli kebutuhan alat mandi seperti sabun, odol.",
                "nominal": 100000,
                "created_at": "2024-10-05T11:28:02.000000Z",
                "updated_at": "2024-10-05T11:28:02.000000Z"
            },
            {
                "id": 2,
                "user_id": 1,
                "type": "inflow",
                "source": "cash",
                "label": "gaji",
                "description": "Gaji bulanan",
                "nominal": 2500000,
                "created_at": "2024-10-05T11:26:45.000000Z",
                "updated_at": "2024-10-05T11:26:48.000000Z"
            }
        ],
        "stats": {
            "cashflow": 2000000,
            "total_outflow": 500000,
            "total_outflow_savings": 400000,
            "total_outflow_savings_alat-elektronik": 400000,
            "total_outflow_label_alat-elektronik": 400000,
            "total_outflow_cash": 100000,
            "total_outflow_cash_alat-mandi": 100000,
            "total_outflow_label_alat-mandi": 100000,
            "total_inflow": 2500000,
            "total_inflow_cash": 2500000,
            "total_inflow_cash_gaji": 2500000,
            "total_inflow_label_gaji": 2500000
        }
    }
}

Response Gagal

{
    "status": "fail",
    "message": "Data tidak valid",
    "data": {
        "field": [
            "Pesan validasi"
        ]
    }
}

Detail Cash Flow

Mendapatkan rincian lengkap dari suatu transaksi arus kas berdasarkan ID.

URL
- /cash-flows/:id
Method
- GET
Headers
- Authorization: Bearer <token>

Contoh Request

GET {{BaseURL}}/cash-flows/1
Accept: application/json
Authorization: Bearer <token>

Response Berhasil

{
    "status": "success",
    "message": "Berhasil mengambil data",
    "data": {
        "cash_flow": {
            "id": 4,
            "user_id": 1,
            "type": "outflow",
            "source": "savings",
            "label": "alat-elektronik",
            "description": "Membeli kebutuhan keyboard dan mouse",
            "nominal": 400000,
            "created_at": "2024-10-05T12:09:16.000000Z",
            "updated_at": "2024-10-05T12:09:16.000000Z"
        }
    }
}

Response Gagal

{
    "status": "fail",
    "message": "Data tidak valid",
    "data": {
        "field": [
            "Pesan validasi"
        ]
    }
}

Delete Cash Flow

Menghapus catatan transaksi arus kas dari sistem.

URL
- /cash-flows/:id
Method
- DELETE
Headers
- Authorization: Bearer <token>

Contoh Request

DELETE {{BaseURL}}/cash-flows/1
Accept: application/json
Authorization: Bearer <token>

Response Berhasil

{
    "status": "success",
    "message": "Berhasil menghapus data"
}

Response Gagal

{
    "status": "fail",
    "message": "Data tidak valid",
    "data": {
        "field": [
            "Pesan validasi"
        ]
    }
}

Get Your Labels

Mengambil daftar label atau kategori yang digunakan pada catatan arus kas.

URL
- /cash-flows/labels
Method
- GET
Headers
- Authorization: Bearer <token>

Contoh Request

GET {{BaseURL}}/cash-flows/labels
Accept: application/json
Authorization: Bearer <token>

Response Berhasil

{
    "status": "success",
    "message": "Berhasil mengambil data",
    "data": {
        "labels": ["gaji", "alat-mandi"]
    }
}

Response Gagal

{
    "status": "fail",
    "message": "Data tidak valid",
    "data": {
        "field": [
            "Pesan validasi"
        ]
    }
}

Get Stats Daily

Mendapatkan statistik ringkasan arus kas harian (total pemasukan & pengeluaran).

URL
- /cash-flows/stats/daily
Parameters
- end_date as timestamp, example: 2024-10-05 23:59:59
- total_data as number
Method
- GET
Headers
- Authorization: Bearer <token>

Contoh Request

GET {{BaseURL}}/cash-flows/stats/daily
Accept: application/json
Authorization: Bearer <token>

Response Berhasil

{
    "status": "success",
    "message": "Berhasil mengambil data",
    "data": {
        "stats_inflow": {
            "01-10-2024": 0,
            "02-10-2024": 0,
            "03-10-2024": 0,
            "04-10-2024": 0,
            "05-10-2024": 2500000,
            "06-10-2024": 0,
            "07-10-2024": 0
        },
        "stats_outflow": {
            "01-10-2024": 0,
            "02-10-2024": 0,
            "03-10-2024": 0,
            "04-10-2024": 0,
            "05-10-2024": 500000,
            "06-10-2024": 0,
            "07-10-2024": 0
        },
        "stats_cashflow": {
            "01-10-2024": 0,
            "02-10-2024": 0,
            "03-10-2024": 0,
            "04-10-2024": 0,
            "05-10-2024": 2000000,
            "06-10-2024": 0,
            "07-10-2024": 0
        }
    }
}

Response Gagal

{
    "status": "fail",
    "message": "Data tidak valid",
    "data": {
        "field": [
            "Pesan validasi"
        ]
    }
}

Get Stats Monthly

Mendapatkan statistik ringkasan arus kas bulanan.

URL
- /cash-flows/stats/monthly
Parameters
- end_date as timestamp, example: 2024-10-05 23:59:59
- total_data as number
Method
- GET
Headers
- Authorization: Bearer <token>

Contoh Request

GET {{BaseURL}}/cash-flows/stats/monthly
Accept: application/json
Authorization: Bearer <token>

Response Berhasil

{
    "status": "success",
    "message": "Berhasil mengambil data",
    "data": {
        "stats_inflow": {
            "01-2024": 0,
            "02-2024": 0,
            "03-2024": 0,
            "04-2024": 0,
            "05-2024": 0,
            "06-2024": 0,
            "07-2024": 0,
            "08-2024": 0,
            "09-2024": 0,
            "10-2024": 2500000,
            "11-2024": 0,
            "12-2024": 0
        },
        "stats_outflow": {
            "01-2024": 0,
            "02-2024": 0,
            "03-2024": 0,
            "04-2024": 0,
            "05-2024": 0,
            "06-2024": 0,
            "07-2024": 0,
            "08-2024": 0,
            "09-2024": 0,
            "10-2024": 500000,
            "11-2024": 0,
            "12-2024": 0
        },
        "stats_cashflow": {
            "01-2024": 0,
            "02-2024": 0,
            "03-2024": 0,
            "04-2024": 0,
            "05-2024": 0,
            "06-2024": 0,
            "07-2024": 0,
            "08-2024": 0,
            "09-2024": 0,
            "10-2024": 2000000,
            "11-2024": 0,
            "12-2024": 0
        }
    }
}

Response Gagal

{
    "status": "fail",
    "message": "Data tidak valid",
    "data": {
        "field": [
            "Pesan validasi"
        ]
    }
}

Delete All Cash Flows

Menghapus semua data catatan aliran kas (cash flows) milik pengguna saat ini secara permanen.

URL
- /cash-flows
Method
- DELETE
Headers
- Authorization: Bearer <token>

Contoh Request

DELETE {{BaseURL}}/cash-flows
Accept: application/json
Authorization: Bearer <token>

Response Berhasil

{
    "status": "success",
    "message": "Berhasil menghapus semua data cash flow"
}

Response Gagal

{
    "status": "fail",
    "message": "Unauthenticated."
}