POST /reporting/financial/trial-balance/\{book_id\}/numbers/export/\{format\}

POST 
/reporting/financial/trial-balance/:book_id/numbers/export/:format

POST /reporting/financial/trial-balance/{book_id}/numbers/export/{format}

Request

Path Parameters

book_id int32required
format stringrequired

Query Parameters

date_posting string

Custom date range syntax. Equal: 2020-01-01; From: [2020-01-01;]; To: [;2025-12-31]; Between: [2020-01-01;2025-12-31]. Custom date range syntax. Equal: 2020-01-01; From: [2020-01-01;]; To: [;2025-12-31]; Between: [2020-01-01;2025-12-31].

period string

Custom string range syntax. Equal: A; From: [A;]; To: [;Z]; Between: [A;Z]. Custom string range syntax. Equal: A; From: [A;]; To: [;Z]; Between: [A;Z].

application/json-patch+json

Body

title stringnullable

columns

object[]

nullable

Array [

id stringnullable

label stringnullable

]

application/json

Body

title stringnullable

columns

object[]

nullable

Array [

id stringnullable

label stringnullable

]

text/json

Body

title stringnullable

columns

object[]

nullable

Array [

id stringnullable

label stringnullable

]

application/*+json

Body

title stringnullable

columns

object[]

nullable

Array [

id stringnullable

label stringnullable

]

Responses

200

OK

text/plain

Schema

Schema

currency stringnullable
period_from stringnullable
period_to stringnullable
date_from datenullable
date_to datenullable

rows

object[]

nullable

Array [

category stringnullable

ob double

cb double

debit double

credit double

ytd_debit double

ytd_credit double

rows undefined[]nullable

gl_account

object

id int64nullable

number stringnullable

name stringnullable

description stringnullable

]

Example (from schema)

{
  "currency": "string",
  "period_from": "string",
  "period_to": "string",
  "date_from": "2024-07-29",
  "date_to": "2024-07-29",
  "rows": [
    {
      "category": "string",
      "ob": 0,
      "cb": 0,
      "debit": 0,
      "credit": 0,
      "ytd_debit": 0,
      "ytd_credit": 0,
      "rows": [
        null
      ],
      "gl_account": {
        "id": 0,
        "number": "string",
        "name": "string",
        "description": "string"
      }
    }
  ]
}

application/json

Schema

Schema

currency stringnullable
period_from stringnullable
period_to stringnullable
date_from datenullable
date_to datenullable

rows

object[]

nullable

Array [

category stringnullable

ob double

cb double

debit double

credit double

ytd_debit double

ytd_credit double

rows undefined[]nullable

gl_account

object

id int64nullable

number stringnullable

name stringnullable

description stringnullable

]

Example (from schema)

{
  "currency": "string",
  "period_from": "string",
  "period_to": "string",
  "date_from": "2024-07-29",
  "date_to": "2024-07-29",
  "rows": [
    {
      "category": "string",
      "ob": 0,
      "cb": 0,
      "debit": 0,
      "credit": 0,
      "ytd_debit": 0,
      "ytd_credit": 0,
      "rows": [
        null
      ],
      "gl_account": {
        "id": 0,
        "number": "string",
        "name": "string",
        "description": "string"
      }
    }
  ]
}

text/json

Schema

Schema

currency stringnullable
period_from stringnullable
period_to stringnullable
date_from datenullable
date_to datenullable

rows

object[]

nullable

Array [

category stringnullable

ob double

cb double

debit double

credit double

ytd_debit double

ytd_credit double

rows undefined[]nullable

gl_account

object

id int64nullable

number stringnullable

name stringnullable

description stringnullable

]

Example (from schema)

{
  "currency": "string",
  "period_from": "string",
  "period_to": "string",
  "date_from": "2024-07-29",
  "date_to": "2024-07-29",
  "rows": [
    {
      "category": "string",
      "ob": 0,
      "cb": 0,
      "debit": 0,
      "credit": 0,
      "ytd_debit": 0,
      "ytd_credit": 0,
      "rows": [
        null
      ],
      "gl_account": {
        "id": 0,
        "number": "string",
        "name": "string",
        "description": "string"
      }
    }
  ]
}

Loading...