Headers

• WEAL-TOKEN Required

  API token (can be retrieved from account settings)

• TARGET-ORGANIZATION-ID

  ID of organization, for which the operation must be performed

Query parameters

• pageNumber integer

  Page Number

  Default value is 1.

• sortingField string

  Field to sort by

• direction string

  Sorting direction

  Values are ASC or DESC. Default value is ASC.

• sizePerPage integer

  Size per page

  Default value is 60.

• lastYearStartDate string(date-time)

  Last Year start date

• lastYearEndDate string(date-time)

  Last Year end date

• lastYear boolean

  Include information for last year

• startDate string(date-time) Required

  Start date

• endDate string(date-time) Required

  End date

• id string

  Chart of accounts ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• accountNumber string

  Account number filter.
  
  Multi-value supported. Example: value1;value2
  
  

• accountType string

  Account type filter

  Values are BALANCE_SHEET, PL, or SYSTEM.

• account string

  Account name filter

• debit string

  Debit amount filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• credit string

  Credit amount filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• endingBalance string

  Ending balance filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• lastYearDebit string

  Prior year debit amount filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• lastYearCredit string

  Prior year credit amount filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• lastYearEndingBalance string

  Prior year ending balance filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • id integer(int64)
  • organizationId integer(int64)
  • accountNumber integer(int64)
  • accountType string

    Values are BALANCE_SHEET, PL, or SYSTEM.

  • account object
    Hide account attributes Show account attributes object

    • en string
    • fr string
    • de string
    • it string
  • debit number
  • credit number
  • endingBalance number
  • lastYearDebit number
  • lastYearCredit number
  • lastYearEndingBalance number
  • warnings string
  • accountId integer(int64)
  • tenantId integer(int64)
• 400

  400 Bad Request

• 401

  401 Unauthorized

• 403

  403 Access Denied

• 404

  404 Not Found

• 500

  500 Internal Server Error