GET /finance/payouts

GET 
/finance/payouts

GET /finance/payouts

Request

Query Parameters

stripe_object_id string[]
from int32
take int32
search string
sort string[]

Responses

200

OK

text/plain

Schema

Schema

total int64nullable
from int64nullable
take int64nullable

entities

object[]

nullable

Array [

id int64nullable

uid uuidnullable

transaction_type

object

id int32nullable

name stringnullable

associated_payment_cards string[]nullable

created_at date-timenullable

edited_at date-timenullable

is_locked boolean

currency stringrequired

Possible values: non-empty

date_issued datenullable

description stringnullable

total_amount doublenullable

stripe_object_id stringnullable

no stringnullable

copy_from_id int64nullable

lines

object[]

nullable

Array [

id int64nullable

description stringnullable

amount double

amount_original doublenullable

payment_amount doublenullable

date_transaction datenullable

date_accounting datenullable

currency stringnullable

order int32nullable

paid_record

object

id int64nullable

no stringnullable

type stringnullable

contact

object

id int64nullable

business_name stringnullable

gl_account

object

id int64nullable

number stringnullable

name stringnullable

description stringnullable

]

]

aggregations undefined[]nullable

Example (from schema)

{
  "total": 0,
  "from": 0,
  "take": 0,
  "entities": [
    {
      "id": 0,
      "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "transaction_type": {
        "id": 0,
        "name": "string",
        "associated_payment_cards": [
          "string"
        ]
      },
      "created_at": "2024-07-29T15:51:28.071Z",
      "edited_at": "2024-07-29T15:51:28.071Z",
      "is_locked": true,
      "currency": "string",
      "date_issued": "2024-07-29",
      "description": "string",
      "total_amount": 0,
      "stripe_object_id": "string",
      "no": "string",
      "copy_from_id": 0,
      "lines": [
        {
          "id": 0,
          "description": "string",
          "amount": 0,
          "amount_original": 0,
          "payment_amount": 0,
          "date_transaction": "2024-07-29",
          "date_accounting": "2024-07-29",
          "currency": "string",
          "order": 0,
          "paid_record": {
            "id": 0,
            "no": "string",
            "type": "string",
            "contact": {
              "id": 0,
              "business_name": "string"
            }
          },
          "gl_account": {
            "id": 0,
            "number": "string",
            "name": "string",
            "description": "string"
          }
        }
      ]
    }
  ],
  "aggregations": [
    null
  ]
}

application/json

Schema

Schema

total int64nullable
from int64nullable
take int64nullable

entities

object[]

nullable

Array [

id int64nullable

uid uuidnullable

transaction_type

object

id int32nullable

name stringnullable

associated_payment_cards string[]nullable

created_at date-timenullable

edited_at date-timenullable

is_locked boolean

currency stringrequired

Possible values: non-empty

date_issued datenullable

description stringnullable

total_amount doublenullable

stripe_object_id stringnullable

no stringnullable

copy_from_id int64nullable

lines

object[]

nullable

Array [

id int64nullable

description stringnullable

amount double

amount_original doublenullable

payment_amount doublenullable

date_transaction datenullable

date_accounting datenullable

currency stringnullable

order int32nullable

paid_record

object

id int64nullable

no stringnullable

type stringnullable

contact

object

id int64nullable

business_name stringnullable

gl_account

object

id int64nullable

number stringnullable

name stringnullable

description stringnullable

]

]

aggregations undefined[]nullable

Example (from schema)

{
  "total": 0,
  "from": 0,
  "take": 0,
  "entities": [
    {
      "id": 0,
      "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "transaction_type": {
        "id": 0,
        "name": "string",
        "associated_payment_cards": [
          "string"
        ]
      },
      "created_at": "2024-07-29T15:51:28.071Z",
      "edited_at": "2024-07-29T15:51:28.071Z",
      "is_locked": true,
      "currency": "string",
      "date_issued": "2024-07-29",
      "description": "string",
      "total_amount": 0,
      "stripe_object_id": "string",
      "no": "string",
      "copy_from_id": 0,
      "lines": [
        {
          "id": 0,
          "description": "string",
          "amount": 0,
          "amount_original": 0,
          "payment_amount": 0,
          "date_transaction": "2024-07-29",
          "date_accounting": "2024-07-29",
          "currency": "string",
          "order": 0,
          "paid_record": {
            "id": 0,
            "no": "string",
            "type": "string",
            "contact": {
              "id": 0,
              "business_name": "string"
            }
          },
          "gl_account": {
            "id": 0,
            "number": "string",
            "name": "string",
            "description": "string"
          }
        }
      ]
    }
  ],
  "aggregations": [
    null
  ]
}

text/json

Schema

Schema

total int64nullable
from int64nullable
take int64nullable

entities

object[]

nullable

Array [

id int64nullable

uid uuidnullable

transaction_type

object

id int32nullable

name stringnullable

associated_payment_cards string[]nullable

created_at date-timenullable

edited_at date-timenullable

is_locked boolean

currency stringrequired

Possible values: non-empty

date_issued datenullable

description stringnullable

total_amount doublenullable

stripe_object_id stringnullable

no stringnullable

copy_from_id int64nullable

lines

object[]

nullable

Array [

id int64nullable

description stringnullable

amount double

amount_original doublenullable

payment_amount doublenullable

date_transaction datenullable

date_accounting datenullable

currency stringnullable

order int32nullable

paid_record

object

id int64nullable

no stringnullable

type stringnullable

contact

object

id int64nullable

business_name stringnullable

gl_account

object

id int64nullable

number stringnullable

name stringnullable

description stringnullable

]

]

aggregations undefined[]nullable

Example (from schema)

{
  "total": 0,
  "from": 0,
  "take": 0,
  "entities": [
    {
      "id": 0,
      "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "transaction_type": {
        "id": 0,
        "name": "string",
        "associated_payment_cards": [
          "string"
        ]
      },
      "created_at": "2024-07-29T15:51:28.071Z",
      "edited_at": "2024-07-29T15:51:28.071Z",
      "is_locked": true,
      "currency": "string",
      "date_issued": "2024-07-29",
      "description": "string",
      "total_amount": 0,
      "stripe_object_id": "string",
      "no": "string",
      "copy_from_id": 0,
      "lines": [
        {
          "id": 0,
          "description": "string",
          "amount": 0,
          "amount_original": 0,
          "payment_amount": 0,
          "date_transaction": "2024-07-29",
          "date_accounting": "2024-07-29",
          "currency": "string",
          "order": 0,
          "paid_record": {
            "id": 0,
            "no": "string",
            "type": "string",
            "contact": {
              "id": 0,
              "business_name": "string"
            }
          },
          "gl_account": {
            "id": 0,
            "number": "string",
            "name": "string",
            "description": "string"
          }
        }
      ]
    }
  ],
  "aggregations": [
    null
  ]
}

Loading...