Revenue Management

The Gotransverse API used for retrieving and storing objects for AR Ledger purposes. Learn more about Revenue Management with the API and UI guides.

For more information, please search through the Gotransverse online documentation:

Terms of Service: Public use
Request Content-Types: application/json
Response Content-Types: application/json
Version: 3.10.0.3

Authentication

api_key_header

An authorization key that is assigned to perform an action in the system. Passed in the form of a X-Api-Key header that is attached to the call. e.g 325509ed604449279d4587c5e35e3235

type
apiKey
name
X-Api-Key
in
header

AR Ledger Run

Get AR Ledger Runs

GET /glruns

Retrieves all AR Ledger Runs of all available ledgers by page.

page_number: integer x ≥ 1 1
in query

The page number for listing. The default value is 1.

page_size: integer 1 ≤ x ≤ 50 25
in query

The page size for listing. The default number of items per page is 25, the maximum is 50.

status: string
in query

The status of the AR Ledger Run. Possible values are NOT_STARTED, RUNNING, ERROR, and COMPLETE.

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

409 Conflict

Conflict

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer (int64)",
    "date_started": "string (date-time)",
    "date_ended": "string (date-time)",
    "status": "string",
    "num_errors": "number",
    "run_trigger_type": "string",
    "gl_run_mode_id": "integer (int64)",
    "ledger_id": "integer (int64)",
    "run_to_date": "string (date-time)"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-Elements-Count

The total results returned in this request. Used to drive paging requests.

integer (int64)
X-Total-Pages

The total pages available for the particular query. Used to drive paging requests.

integer (int64)
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Create AR Ledger run

POST /glruns

Creates a new AR Ledger Run and runs it.

The payload for creating and running an AR Ledger Run.

Request Content-Types: application/json
Request Example
{
  "gl_run_mode_id": "integer (int64)",
  "ledger_id": "integer (int64)",
  "run_to_date": "string (date-time)"
}
201 Created

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

409 Conflict

Conflict

412 Precondition Failed

Precondition failed.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (201 Created)
{
  "id": "integer (int64)",
  "date_started": "string (date-time)",
  "date_ended": "string (date-time)",
  "status": "string",
  "num_errors": "number",
  "run_trigger_type": "string",
  "gl_run_mode_id": "integer (int64)",
  "ledger_id": "integer (int64)",
  "run_to_date": "string (date-time)"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (412 Precondition Failed)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Get AR Ledger runs by AR Ledger

GET /ledgers/{ledger_id}/glruns

Retrieves all AR Ledger Runs for a certain AR Ledger with the associated ID.

ledger_id: integer (int64)
in path

The ID of the AR Ledger.

Success

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

404 Not Found

Entity not found.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer (int64)",
    "date_started": "string (date-time)",
    "date_ended": "string (date-time)",
    "status": "string",
    "num_errors": "number",
    "run_trigger_type": "string",
    "gl_run_mode_id": "integer (int64)",
    "ledger_id": "integer (int64)",
    "run_to_date": "string (date-time)"
  }
]
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Get AR Ledger Run by ID

GET /glruns/{id}

Retrieves the AR Ledger Run associated with the specified ID.

id: integer (int64)
in path

The ID of the AR Ledger Run.

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

404 Not Found

Entity not found.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "date_started": "string (date-time)",
  "date_ended": "string (date-time)",
  "status": "string",
  "num_errors": "number",
  "run_trigger_type": "string",
  "gl_run_mode_id": "integer (int64)",
  "ledger_id": "integer (int64)",
  "run_to_date": "string (date-time)"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Delete AR Ledger Run

DELETE /glruns/{id}

Deletes the AR Ledger Run together with all processing results by the associated ID.

id: integer (int64)
in path

The ID of the AR Ledger Run.

200 OK

Success

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

404 Not Found

Entity not found.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Get errors by AR Ledger Run

GET /glruns/{id}/errors

Retrieves errors for a certain AR Ledger Run associated with the specified ID by page.

id: integer (int64)
in path

The ID of the AR Ledger Run.

page_number: integer x ≥ 1 1
in query

The page number for listing. The default value is 1.

page_size: integer 1 ≤ x ≤ 50 25
in query

The page size for listing. The default number of items per page is 25, the maximum is 50.

200 OK

Success

type
401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

404 Not Found

Entity not found.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer (int64)",
    "collector_run_id": "integer (int64)",
    "gl_run_id": "integer (int64)",
    "error_message": "string"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-Elements-Count

The total results returned in this request. Used to drive paging requests.

integer (int64)
X-Total-Pages

The total pages available for the particular query. Used to drive paging requests.

integer (int64)
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Collectors

Get collectors

GET /collectors

Retrieves a list of all supported collectors by page.

group: string
in query

The group of the collector.

category: string
in query

The category of the collector.

page_number: integer x ≥ 1 1
in query

The page number for listing. The default value is 1.

page_size: integer 1 ≤ x ≤ 50 25
in query

The page size for listing. The default number of items per page is 25, the maximum is 50.

200 OK

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

409 Conflict

Conflict

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "name": "string",
    "friendly_name": "string",
    "description": "string",
    "group": "string",
    "category": "string"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-Elements-Count

The total results returned in this request. Used to drive paging requests.

integer (int64)
X-Total-Pages

The total pages available for the particular query. Used to drive paging requests.

integer (int64)
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Get collector runs

GET /collector-runs

Retrieves collector runs with details by page.

page_number: integer x ≥ 1 1
in query

The page number for listing. The default value is 1.

page_size: integer 1 ≤ x ≤ 50 25
in query

The page size for listing. The default number of items per page is 25, the maximum is 50.

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

409 Conflict

Conflict

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer (int64)",
    "tenant_id": "integer (int64)",
    "gl_run_mode_id": "integer (int64)",
    "date_started": "string (date-time)",
    "date_ended": "string (date-time)",
    "status": "string",
    "run_trigger_type": "string",
    "num_errors": "integer",
    "type": "string",
    "collector_operations": [
      "string"
    ],
    "data_fetch_from_date": "string (date-time)",
    "data_fetch_to_date": "string (date-time)",
    "overlap_fetch_time": "integer (int64)"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-Elements-Count

The total results returned in this request. Used to drive paging requests.

integer (int64)
X-Total-Pages

The total pages available for the particular query. Used to drive paging requests.

integer (int64)
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Create and run collector runs

POST /collector-runs

Creates collector runs and runs them.

The payload for creating and running collector runs.

Request Content-Types: application/json
Request Example
{
  "type": "string",
  "collector_operations": [
    "string"
  ],
  "data_fetch_from_date": "string (date-time)",
  "data_fetch_to_date": "string (date-time)",
  "overlap_fetch_time": "integer (int64)"
}

Success

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

409 Conflict

Conflict

412 Precondition Failed

Precondition failed.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (201 Created)
{
  "id": "integer (int64)",
  "tenant_id": "integer (int64)",
  "gl_run_mode_id": "integer (int64)",
  "date_started": "string (date-time)",
  "date_ended": "string (date-time)",
  "status": "string",
  "run_trigger_type": "string",
  "num_errors": "integer",
  "type": "string",
  "collector_operations": [
    "string"
  ],
  "data_fetch_from_date": "string (date-time)",
  "data_fetch_to_date": "string (date-time)",
  "overlap_fetch_time": "integer (int64)"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (412 Precondition Failed)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Get collector run by ID

GET /collector-runs/{id}

Retrieves the collector run associated with the specified ID.

id: integer (int64)
in path

The ID of the collector run.

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

404 Not Found

Entity not found.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "tenant_id": "integer (int64)",
  "gl_run_mode_id": "integer (int64)",
  "date_started": "string (date-time)",
  "date_ended": "string (date-time)",
  "status": "string",
  "run_trigger_type": "string",
  "num_errors": "integer",
  "type": "string",
  "collector_operations": [
    "string"
  ],
  "data_fetch_from_date": "string (date-time)",
  "data_fetch_to_date": "string (date-time)",
  "overlap_fetch_time": "integer (int64)"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Get errors by collector run

GET /collector-runs/{id}/errors

Retrieves errors for a certain collector run associated with the specified ID.

id: integer (int64)
in path

The ID of the collector run.

page_number: integer x ≥ 1 1
in query

The page number for listing. The default value is 1.

page_size: integer 1 ≤ x ≤ 50 25
in query

The page size for listing. The default number of items per page is 25, the maximum is 50.

200 OK

Success

type
401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

404 Not Found

Entity not found.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer (int64)",
    "collector_run_id": "integer (int64)",
    "gl_run_id": "integer (int64)",
    "error_message": "string"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-Elements-Count

The total results returned in this request. Used to drive paging requests.

integer (int64)
X-Total-Pages

The total pages available for the particular query. Used to drive paging requests.

integer (int64)
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Replication

Replicate SVS data to Snowflake

POST /replication/svs

Copies the SVS data from Postgres to Snowflake.

batch_size: integer
in query

The batch size for the replication.

201 Created

Success

401 Unauthorized

Authentication failed.

409 Conflict

Conflict

412 Precondition Failed

Precondition failed.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (412 Precondition Failed)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

AR Ledger

Get AR Ledger by ID

GET /ledgers/{id}

Retrieves the AR Ledger associated with the specified ID.

id: integer (int64)
in path

The ID of the AR Ledger.

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

404 Not Found

Entity not found.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
{
  "timezone_name": "string",
  "valid": "boolean",
  "calendar": {
    "years": [
      {
        "accounting-periods": [
          {
            "type": "string",
            "id": "integer (int64)",
            "name": "string",
            "description": "string",
            "path": [
              "integer"
            ],
            "quarter": "string",
            "start_date": "string",
            "end_date": "string",
            "time_zone": "string",
            "open": "boolean",
            "parent_id": "integer (int64)"
          }
        ],
        "type": "string",
        "id": "integer (int64)",
        "name": "string",
        "description": "string",
        "path": [
          "integer"
        ],
        "start_date": "string",
        "end_date": "string",
        "time_zone": "string",
        "parent_id": "integer (int64)",
        "open": "boolean",
        "complete": "boolean"
      }
    ],
    "type": "string",
    "id": "integer (int64)",
    "path": [
      "integer"
    ],
    "start_date": "string",
    "end_date": "string",
    "time_zone": "string",
    "complete": "boolean"
  },
  "id": "integer (int64)",
  "name": "string",
  "description": "string",
  "status": "string",
  "convert_currency": "string",
  "conversion_currency": "string",
  "chart_of_account_id": "integer (int64)",
  "rule_set_id": "integer (int64)",
  "run_mode_actuals_id": "integer (int64)",
  "conversion_rate_set_id": "string",
  "currency_exchange_version": "string",
  "billing_account_category_ids": [
    "integer (int64)"
  ],
  "expected_customer_lifetime": "integer",
  "create_zero_amount_entries": "boolean"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Update AR Ledger

PUT /ledgers/{id}

Updates the AR Ledger associated with the specified ID.

The payload for updating the AR Ledger with the specified ID.

id: integer (int64)
in path

The ID of the AR Ledger.

Request Content-Types: application/json
Request Example
{
  "id": "integer (int64)",
  "name": "string",
  "description": "string",
  "status": "string",
  "convert_currency": "string",
  "conversion_currency": "string",
  "chart_of_account_id": "integer (int64)",
  "rule_set_id": "integer (int64)",
  "run_mode_actuals_id": "integer (int64)",
  "conversion_rate_set_id": "string",
  "currency_exchange_version": "string",
  "billing_account_category_ids": [
    "integer (int64)"
  ],
  "expected_customer_lifetime": "integer",
  "create_zero_amount_entries": "boolean"
}

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

404 Not Found

Entity not found.

409 Conflict

Conflict

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
{
  "timezone_name": "string",
  "valid": "boolean",
  "calendar": {
    "years": [
      {
        "accounting-periods": [
          {
            "type": "string",
            "id": "integer (int64)",
            "name": "string",
            "description": "string",
            "path": [
              "integer"
            ],
            "quarter": "string",
            "start_date": "string",
            "end_date": "string",
            "time_zone": "string",
            "open": "boolean",
            "parent_id": "integer (int64)"
          }
        ],
        "type": "string",
        "id": "integer (int64)",
        "name": "string",
        "description": "string",
        "path": [
          "integer"
        ],
        "start_date": "string",
        "end_date": "string",
        "time_zone": "string",
        "parent_id": "integer (int64)",
        "open": "boolean",
        "complete": "boolean"
      }
    ],
    "type": "string",
    "id": "integer (int64)",
    "path": [
      "integer"
    ],
    "start_date": "string",
    "end_date": "string",
    "time_zone": "string",
    "complete": "boolean"
  },
  "id": "integer (int64)",
  "name": "string",
  "description": "string",
  "status": "string",
  "convert_currency": "string",
  "conversion_currency": "string",
  "chart_of_account_id": "integer (int64)",
  "rule_set_id": "integer (int64)",
  "run_mode_actuals_id": "integer (int64)",
  "conversion_rate_set_id": "string",
  "currency_exchange_version": "string",
  "billing_account_category_ids": [
    "integer (int64)"
  ],
  "expected_customer_lifetime": "integer",
  "create_zero_amount_entries": "boolean"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Delete AR Ledger

DELETE /ledgers/{id}

Deletes the AR Ledger associated with the specified ID.

id: integer (int64)
in path

The ID of the AR Ledger.

200 OK

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

404 Not Found

Entity not found.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Get AR Ledgers

GET /ledgers

Retrieves a list of AR Ledgers by page.

id: integer (int64)
in query

The ID of the AR Ledger.

name: string
in query

The name of the AR Ledger.

status: string ACTIVE, INACTIVE
in query

The filter parameter used for retrieving AR Ledgers by the specified status. Possible values are ACTIVE and INACTIVE.

convert_currency: string NONE, GL, ACCOUNT_CATEGORY
in query

A filter parameter used to retrieve AR Ledgers by values specified for the convert currency property. Possible parameter values are NONE, GL, and ACCOUNT CATEGORY.

conversion_currency: string USD, GBP, EUR, SEK, NOK, DKK, CAD, AUD, ZAR, NZD, MXN, INR, JPY, SAR, QAR, EGP, AED, BHD, KWD, OMR, HKD, CHF, BRL, PLN, CNY, ILS, COP, PEN, RUB, SGD, IDR, MYR, KRW, TWD, PKR, ARS, CLP, CRC, CZK, HUF, ISK, PHP, RON, THB, TRY, BWP, NGN
in query

A filter parameter used to retrieve AR Ledgers by currency. Currency is specified with the ISO 4217 code.

chart_of_account_id: integer (int64)
in query

The ID of the chart of accounts.

rule_set_id: integer (int64)
in query

The ID of the posting rule set.

page_number: integer x ≥ 1 1
in query

The page number for listing. The default value is 1.

page_size: integer 1 ≤ x ≤ 50 25
in query

The page size for listing. The default number of items per page is 25, the maximum is 50.

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

409 Conflict

Conflict

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "timezone_name": "string",
    "chart_of_account_name": "string",
    "rule_set_name": "string",
    "accounting_calendar_name": "string",
    "valid": "boolean",
    "calendar": {
      "years": [
        {
          "accounting-periods": [
            {
              "type": "string",
              "id": "integer (int64)",
              "name": "string",
              "description": "string",
              "path": [
                "integer"
              ],
              "quarter": "string",
              "start_date": "string",
              "end_date": "string",
              "time_zone": "string",
              "open": "boolean",
              "parent_id": "integer (int64)"
            }
          ],
          "type": "string",
          "id": "integer (int64)",
          "name": "string",
          "description": "string",
          "path": [
            "integer"
          ],
          "start_date": "string",
          "end_date": "string",
          "time_zone": "string",
          "parent_id": "integer (int64)",
          "open": "boolean",
          "complete": "boolean"
        }
      ],
      "type": "string",
      "id": "integer (int64)",
      "path": [
        "integer"
      ],
      "start_date": "string",
      "end_date": "string",
      "time_zone": "string",
      "complete": "boolean"
    },
    "id": "integer (int64)",
    "name": "string",
    "description": "string",
    "status": "string",
    "convert_currency": "string",
    "conversion_currency": "string",
    "chart_of_account_id": "integer (int64)",
    "rule_set_id": "integer (int64)",
    "run_mode_actuals_id": "integer (int64)",
    "conversion_rate_set_id": "string",
    "currency_exchange_version": "string",
    "billing_account_category_ids": [
      "integer (int64)"
    ],
    "expected_customer_lifetime": "integer",
    "create_zero_amount_entries": "boolean"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-Elements-Count

The total results returned in this request. Used to drive paging requests.

integer (int64)
X-Total-Pages

The total pages available for the particular query. Used to drive paging requests.

integer (int64)
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Create AR Ledger

POST /ledgers

Creates a new AR Ledger.

The payload for creating a new AR Ledger.

Request Content-Types: application/json
Request Example
{
  "id": "integer (int64)",
  "name": "string",
  "description": "string",
  "convert_currency": "string",
  "conversion_currency": "string",
  "chart_of_account_id": "integer (int64)",
  "rule_set_id": "integer (int64)",
  "run_mode_actuals_id": "integer (int64)",
  "conversion_rate_set_id": "string",
  "currency_exchange_version": "string",
  "billing_account_category_ids": [
    "integer (int64)"
  ],
  "expected_customer_lifetime": "integer",
  "create_zero_amount_entries": "boolean"
}
201 Created

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

409 Conflict

Conflict

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (201 Created)
{
  "timezone_name": "string",
  "valid": "boolean",
  "calendar": {
    "years": [
      {
        "accounting-periods": [
          {
            "type": "string",
            "id": "integer (int64)",
            "name": "string",
            "description": "string",
            "path": [
              "integer"
            ],
            "quarter": "string",
            "start_date": "string",
            "end_date": "string",
            "time_zone": "string",
            "open": "boolean",
            "parent_id": "integer (int64)"
          }
        ],
        "type": "string",
        "id": "integer (int64)",
        "name": "string",
        "description": "string",
        "path": [
          "integer"
        ],
        "start_date": "string",
        "end_date": "string",
        "time_zone": "string",
        "parent_id": "integer (int64)",
        "open": "boolean",
        "complete": "boolean"
      }
    ],
    "type": "string",
    "id": "integer (int64)",
    "path": [
      "integer"
    ],
    "start_date": "string",
    "end_date": "string",
    "time_zone": "string",
    "complete": "boolean"
  },
  "id": "integer (int64)",
  "name": "string",
  "description": "string",
  "status": "string",
  "convert_currency": "string",
  "conversion_currency": "string",
  "chart_of_account_id": "integer (int64)",
  "rule_set_id": "integer (int64)",
  "run_mode_actuals_id": "integer (int64)",
  "conversion_rate_set_id": "string",
  "currency_exchange_version": "string",
  "billing_account_category_ids": [
    "integer (int64)"
  ],
  "expected_customer_lifetime": "integer",
  "create_zero_amount_entries": "boolean"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Add accounting year

POST /ledgers/{id}/calendar/years

Adds a new accounting year to the given calendar by the associated AR Ledger ID.

The payload for adding a new accounting year or a year with accounting periods to the calendar.

id: integer (int64)
in path

The ID of the AR Ledger.

generate-periods: boolean false
in query

Specifies whether the accounting periods are created together with accounting years. To auto-generate accounting periods, the start and end dates of the accounting year must start on the first day of the month; and the end date of the accounting year must be one or two years after the start date.

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "start_date": "string",
  "end_date": "string",
  "accounting-periods": [
    {
      "name": "string",
      "quarter": "string",
      "start_date": "string",
      "end_date": "string",
      "open": "boolean"
    }
  ]
}

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

404 Not Found

Entity not found.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
{
  "timezone_name": "string",
  "valid": "boolean",
  "calendar": {
    "years": [
      {
        "accounting-periods": [
          {
            "type": "string",
            "id": "integer (int64)",
            "name": "string",
            "description": "string",
            "path": [
              "integer"
            ],
            "quarter": "string",
            "start_date": "string",
            "end_date": "string",
            "time_zone": "string",
            "open": "boolean",
            "parent_id": "integer (int64)"
          }
        ],
        "type": "string",
        "id": "integer (int64)",
        "name": "string",
        "description": "string",
        "path": [
          "integer"
        ],
        "start_date": "string",
        "end_date": "string",
        "time_zone": "string",
        "parent_id": "integer (int64)",
        "open": "boolean",
        "complete": "boolean"
      }
    ],
    "type": "string",
    "id": "integer (int64)",
    "path": [
      "integer"
    ],
    "start_date": "string",
    "end_date": "string",
    "time_zone": "string",
    "complete": "boolean"
  },
  "id": "integer (int64)",
  "name": "string",
  "description": "string",
  "status": "string",
  "convert_currency": "string",
  "conversion_currency": "string",
  "chart_of_account_id": "integer (int64)",
  "rule_set_id": "integer (int64)",
  "run_mode_actuals_id": "integer (int64)",
  "conversion_rate_set_id": "string",
  "currency_exchange_version": "string",
  "billing_account_category_ids": [
    "integer (int64)"
  ],
  "expected_customer_lifetime": "integer",
  "create_zero_amount_entries": "boolean"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Get accounting year

GET /ledgers/{id}/calendar/years/{yid}

Retrieves the accounting year that belongs to a certain calendar by the associated AR Ledger ID and year ID.

id: integer (int64)
in path

The ID of the AR Ledger.

yid: integer (int64)
in path

The ID of the accounting year.

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

404 Not Found

Entity not found.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
{
  "accounting-periods": [
    {
      "type": "string",
      "id": "integer (int64)",
      "name": "string",
      "description": "string",
      "path": [
        "integer"
      ],
      "quarter": "string",
      "start_date": "string",
      "end_date": "string",
      "time_zone": "string",
      "open": "boolean",
      "parent_id": "integer (int64)"
    }
  ],
  "type": "string",
  "id": "integer (int64)",
  "name": "string",
  "description": "string",
  "path": [
    "integer"
  ],
  "start_date": "string",
  "end_date": "string",
  "time_zone": "string",
  "parent_id": "integer (int64)",
  "open": "boolean",
  "complete": "boolean"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Update accounting year

PUT /ledgers/{id}/calendar/years/{yid}

Updates the accounting year that belongs to a certain calendar by the associated AR Ledger and accounting year IDs.

The payload for updating the accounting year that belongs to a certain calendar.

id: integer (int64)
in path

The ID of the AR Ledger.

yid: integer (int64)
in path

The ID of the accounting year.

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "description": "string",
  "start_date": "string",
  "end_date": "string",
  "accounting-periods": [
    {
      "name": "string",
      "quarter": "string",
      "start_date": "string",
      "end_date": "string",
      "open": "boolean"
    }
  ]
}

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

404 Not Found

Entity not found.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
{
  "timezone_name": "string",
  "valid": "boolean",
  "calendar": {
    "years": [
      {
        "accounting-periods": [
          {
            "type": "string",
            "id": "integer (int64)",
            "name": "string",
            "description": "string",
            "path": [
              "integer"
            ],
            "quarter": "string",
            "start_date": "string",
            "end_date": "string",
            "time_zone": "string",
            "open": "boolean",
            "parent_id": "integer (int64)"
          }
        ],
        "type": "string",
        "id": "integer (int64)",
        "name": "string",
        "description": "string",
        "path": [
          "integer"
        ],
        "start_date": "string",
        "end_date": "string",
        "time_zone": "string",
        "parent_id": "integer (int64)",
        "open": "boolean",
        "complete": "boolean"
      }
    ],
    "type": "string",
    "id": "integer (int64)",
    "path": [
      "integer"
    ],
    "start_date": "string",
    "end_date": "string",
    "time_zone": "string",
    "complete": "boolean"
  },
  "id": "integer (int64)",
  "name": "string",
  "description": "string",
  "status": "string",
  "convert_currency": "string",
  "conversion_currency": "string",
  "chart_of_account_id": "integer (int64)",
  "rule_set_id": "integer (int64)",
  "run_mode_actuals_id": "integer (int64)",
  "conversion_rate_set_id": "string",
  "currency_exchange_version": "string",
  "billing_account_category_ids": [
    "integer (int64)"
  ],
  "expected_customer_lifetime": "integer",
  "create_zero_amount_entries": "boolean"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Delete accounting year

DELETE /ledgers/{id}/calendar/years/{yid}

Deletes the accounting year that belongs to a certain calendar by the associated AR Ledger and accounting year IDs.

id: integer (int64)
in path

The ID of the AR Ledger.

yid: integer (int64)
in path

The ID of the accounting year.

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

404 Not Found

Entity not found.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
{
  "timezone_name": "string",
  "valid": "boolean",
  "calendar": {
    "years": [
      {
        "accounting-periods": [
          {
            "type": "string",
            "id": "integer (int64)",
            "name": "string",
            "description": "string",
            "path": [
              "integer"
            ],
            "quarter": "string",
            "start_date": "string",
            "end_date": "string",
            "time_zone": "string",
            "open": "boolean",
            "parent_id": "integer (int64)"
          }
        ],
        "type": "string",
        "id": "integer (int64)",
        "name": "string",
        "description": "string",
        "path": [
          "integer"
        ],
        "start_date": "string",
        "end_date": "string",
        "time_zone": "string",
        "parent_id": "integer (int64)",
        "open": "boolean",
        "complete": "boolean"
      }
    ],
    "type": "string",
    "id": "integer (int64)",
    "path": [
      "integer"
    ],
    "start_date": "string",
    "end_date": "string",
    "time_zone": "string",
    "complete": "boolean"
  },
  "id": "integer (int64)",
  "name": "string",
  "description": "string",
  "status": "string",
  "convert_currency": "string",
  "conversion_currency": "string",
  "chart_of_account_id": "integer (int64)",
  "rule_set_id": "integer (int64)",
  "run_mode_actuals_id": "integer (int64)",
  "conversion_rate_set_id": "string",
  "currency_exchange_version": "string",
  "billing_account_category_ids": [
    "integer (int64)"
  ],
  "expected_customer_lifetime": "integer",
  "create_zero_amount_entries": "boolean"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Open accounting period

PUT /ledgers/{id}/calendar/years/{yid}/accounting-periods/{pid}/open

Opens the specified accounting period by the associated AR Ledger, accounting year, and accounting period IDs.

id: integer (int64)
in path

The ID of the AR Ledger.

yid: integer (int64)
in path

The ID of the accounting year.

pid: integer (int64)
in path

The ID of the accounting period.

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
{
  "timezone_name": "string",
  "valid": "boolean",
  "calendar": {
    "years": [
      {
        "accounting-periods": [
          {
            "type": "string",
            "id": "integer (int64)",
            "name": "string",
            "description": "string",
            "path": [
              "integer"
            ],
            "quarter": "string",
            "start_date": "string",
            "end_date": "string",
            "time_zone": "string",
            "open": "boolean",
            "parent_id": "integer (int64)"
          }
        ],
        "type": "string",
        "id": "integer (int64)",
        "name": "string",
        "description": "string",
        "path": [
          "integer"
        ],
        "start_date": "string",
        "end_date": "string",
        "time_zone": "string",
        "parent_id": "integer (int64)",
        "open": "boolean",
        "complete": "boolean"
      }
    ],
    "type": "string",
    "id": "integer (int64)",
    "path": [
      "integer"
    ],
    "start_date": "string",
    "end_date": "string",
    "time_zone": "string",
    "complete": "boolean"
  },
  "id": "integer (int64)",
  "name": "string",
  "description": "string",
  "status": "string",
  "convert_currency": "string",
  "conversion_currency": "string",
  "chart_of_account_id": "integer (int64)",
  "rule_set_id": "integer (int64)",
  "run_mode_actuals_id": "integer (int64)",
  "conversion_rate_set_id": "string",
  "currency_exchange_version": "string",
  "billing_account_category_ids": [
    "integer (int64)"
  ],
  "expected_customer_lifetime": "integer",
  "create_zero_amount_entries": "boolean"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Close accounting period

PUT /ledgers/{id}/calendar/years/{yid}/accounting-periods/{pid}/close

Closes the specified accounting period by the associated AR Ledger, accounting year, and accounting period IDs.

id: integer (int64)
in path

The ID of the AR Ledger.

yid: integer (int64)
in path

The ID of the accounting year.

pid: integer (int64)
in path

The ID of the accounting period.

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
{
  "timezone_name": "string",
  "valid": "boolean",
  "calendar": {
    "years": [
      {
        "accounting-periods": [
          {
            "type": "string",
            "id": "integer (int64)",
            "name": "string",
            "description": "string",
            "path": [
              "integer"
            ],
            "quarter": "string",
            "start_date": "string",
            "end_date": "string",
            "time_zone": "string",
            "open": "boolean",
            "parent_id": "integer (int64)"
          }
        ],
        "type": "string",
        "id": "integer (int64)",
        "name": "string",
        "description": "string",
        "path": [
          "integer"
        ],
        "start_date": "string",
        "end_date": "string",
        "time_zone": "string",
        "parent_id": "integer (int64)",
        "open": "boolean",
        "complete": "boolean"
      }
    ],
    "type": "string",
    "id": "integer (int64)",
    "path": [
      "integer"
    ],
    "start_date": "string",
    "end_date": "string",
    "time_zone": "string",
    "complete": "boolean"
  },
  "id": "integer (int64)",
  "name": "string",
  "description": "string",
  "status": "string",
  "convert_currency": "string",
  "conversion_currency": "string",
  "chart_of_account_id": "integer (int64)",
  "rule_set_id": "integer (int64)",
  "run_mode_actuals_id": "integer (int64)",
  "conversion_rate_set_id": "string",
  "currency_exchange_version": "string",
  "billing_account_category_ids": [
    "integer (int64)"
  ],
  "expected_customer_lifetime": "integer",
  "create_zero_amount_entries": "boolean"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Get history for an accounting period

GET /ledgers/{id}/calendar/years/{yid}/accounting-periods/{pid}/history

Get the open and close history for an accounting period.

id: integer (int64)
in path

The ID of the AR Ledger.

yid: integer (int64)
in path

The ID of the accounting year.

pid: integer (int64)
in path

The ID of the accounting period.

page_number: integer x ≥ 1 1
in query

The page number for listing. The default value is 1.

page_size: integer 1 ≤ x ≤ 50 25
in query

The page size for listing. The default number of items per page is 25, the maximum is 50.

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer (int64)",
    "open": "boolean",
    "start_date": "string",
    "end_date": "string"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-Elements-Count

The total results returned in this request. Used to drive paging requests.

integer (int64)
X-Total-Pages

The total pages available for the particular query. Used to drive paging requests.

integer (int64)
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Get charge info

GET /ledgers/chargeinfos

Retrieves the charge info records by pages.

page_number: integer x ≥ 1 1
in query

The page number for listing. The default value is 1.

page_size: integer 1 ≤ x ≤ 50 25
in query

The page size for listing. The default number of items per page is 25, the maximum is 50.

billing_account: string
in query

The number of the billing account.

invoice_number: string
in query

The number of the invoice.

charge_info_type: string
in query

The type of transaction as specified on the charge info record.

charge_category: string
in query

The name of the charge category.

created_from: string (date-time)
in query

A filter parameter used to retrieve charge info records created since the specified date. The date is defined in the ISO 8601 format. Records created on this date are also included in the response. Here are examples of how the date can be presented 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

created_to: string (date-time)
in query

A filter parameter used to retrieve charge info records created until the specified date. The date is defined in the ISO 8601 format. Records created on this date are not included in the response. Here are examples of how the date can be presented 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

is_parent: boolean
in query

Parent or child charge information records.

service_id: integer (int64)
in query

The service ID.

product_id: integer (int64)
in query

The product ID.

order_number: string
in query

The order number.

parent_id: integer (int64)
in query

The parent charge information ID.

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

409 Conflict

Conflict

412 Precondition Failed

Precondition failed.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer",
    "created_on": "string",
    "updated_on": "string",
    "created_by": "string",
    "updated_by": "string",
    "billing_account_num": "string",
    "tract_id": "string",
    "ci_values": "object"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-Elements-Count

The total results returned in this request. Used to drive paging requests.

integer (int64)
X-Total-Pages

The total pages available for the particular query. Used to drive paging requests.

integer (int64)
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (412 Precondition Failed)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Delete charge info

DELETE /ledgers/chargeinfos

Deletes a set of charge info records.

undefined

Request Content-Types: application/json
Request Example
{
  "ids": [
    "integer (int64)"
  ]
}
200 OK

Success

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

404 Not Found

Entity not found.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Get merged charge info

GET /ledgers/merged-chargeinfos

Retrieves the merged charge info records by pages.

page_number: integer x ≥ 1 1
in query

The page number for listing. The default value is 1.

page_size: integer 1 ≤ x ≤ 50 25
in query

The page size for listing. The default number of items per page is 25, the maximum is 50.

billing_account: string
in query

The number of the billing account.

invoice_number: string
in query

The number of the invoice.

charge_info_type: string
in query

The type of transaction as specified on the charge info record.

charge_category: string
in query

The name of the charge category.

created_from: string (date-time)
in query

A filter parameter used to retrieve charge info records created since the specified date. The date is defined in the ISO 8601 format. Records created on this date are also included in the response. Here are examples of how the date can be presented 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

created_to: string (date-time)
in query

A filter parameter used to retrieve charge info records created until the specified date. The date is defined in the ISO 8601 format. Records created on this date are not included in the response. Here are examples of how the date can be presented 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

service_id: integer (int64)
in query

The service ID.

product_id: integer (int64)
in query

The product ID.

order_number: string
in query

The order number.

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

409 Conflict

Conflict

412 Precondition Failed

Precondition failed.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer",
    "created_on": "string",
    "updated_on": "string",
    "created_by": "string",
    "updated_by": "string",
    "billing_account_num": "string",
    "tract_id": "string",
    "ci_values": "object"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-Elements-Count

The total results returned in this request. Used to drive paging requests.

integer (int64)
X-Total-Pages

The total pages available for the particular query. Used to drive paging requests.

integer (int64)
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (412 Precondition Failed)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Get charge info

GET /ledgers/{ledger_id}/chargeinfos

Retrieves the charge info records by pages associated with the specified AR Ledger ID.

page_number: integer x ≥ 1 1
in query

The page number for listing. The default value is 1.

page_size: integer 1 ≤ x ≤ 50 25
in query

The page size for listing. The default number of items per page is 25, the maximum is 50.

ledger_id: integer (int64)
in path

The ID of the AR Ledger.

gl_event_id: integer
in query

The ID of the AR Ledger event.

created_from: string (date-time)
in query

A filter parameter used to retrieve charge info records created since the specified date. The date is defined in the ISO 8601 format. Records created on this date are also included in the response. Here are examples of how the date can be presented 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

created_to: string (date-time)
in query

A filter parameter used to retrieve charge info records created until the specified date in the ISO 8601 format. Records created on this date are not included in the response. Here are examples of how the date can be presented 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

updated_from: string (date-time)
in query

A filter parameter used to retrieve charge info records updated since the specified date. The date is defined in the ISO 8601 format. Records updated on this date are also included in the response. Here are examples of how the date can be presented 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

updated_to: string (date-time)
in query

A filter parameter used to retrieve charge info records updated until the specified date. The date is defined in the ISO 8601 format. Records updated on this date are not included in the response. Here are examples of how the date can be presented 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

200 OK

Success

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

404 Not Found

Entity not found.

409 Conflict

Conflict

412 Precondition Failed

Precondition failed.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer",
    "created_on": "string",
    "updated_on": "string",
    "created_by": "string",
    "updated_by": "string",
    "billing_account_num": "string",
    "tract_id": "string",
    "ci_values": "object",
    "charge_info_state_values": "string"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-Elements-Count

The total results returned in this request. Used to drive paging requests.

integer (int64)
X-Total-Pages

The total pages available for the particular query. Used to drive paging requests.

integer (int64)
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (412 Precondition Failed)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Delete charge info state and journal entries

DELETE /ledgers/{ledger_id}/chargeinfos/state

Deletes the state of charge info records and all journal entries associated with them by AR Ledger ID.

undefined

ledger_id: integer (int64)
in path

The ID of the AR Ledger.

Request Content-Types: application/json
Request Example
{
  "ids": [
    "integer (int64)"
  ]
}
200 OK

Success

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

Response Content-Types: application/json
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}

Get charge info by ID

GET /ledgers/{ledger_id}/chargeinfos/{id}

Retrieves the specified charge info record by the associated charge info and AR Ledger IDs.

ledger_id: integer (int64)
in path

The ID of the AR Ledger.

id: integer (int64)
in path

The ID of the charge info.

200 OK

Success

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

404 Not Found

Entity not found.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer",
  "created_on": "string",
  "updated_on": "string",
  "created_by": "string",
  "updated_by": "string",
  "billing_account_num": "string",
  "tract_id": "string",
  "ci_values": "object",
  "charge_info_state_values": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Get charge info types

GET /ledgers/chargeinfos/types

Retrieves the supported charge info types.

200 OK

Success

type
400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "key": "string",
    "label": "string"
  }
]
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}

Get time zones

GET /ledgers/time-zones
page_number: integer x ≥ 1 1
in query

The page number for listing. The default value is 1.

page_size: integer 1 ≤ x ≤ 50 25
in query

The page size for listing. The default number of items per page is 25, the maximum is 50.

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

409 Conflict

Conflict

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "name": "string",
    "friendly_name": "string"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-Elements-Count

The total results returned in this request. Used to drive paging requests.

integer (int64)
X-Total-Pages

The total pages available for the particular query. Used to drive paging requests.

integer (int64)
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Get draft accounting transactions

GET /ledgers/{ledger_id}/draft-accounting-transactions

Retrieves a list of draft accounting transactions for a certain AR Ledger with the associated ID.

page_number: integer x ≥ 1 1
in query

The page number for listing. The default value is 1.

page_size: integer 1 ≤ x ≤ 50 25
in query

The page size for listing. The default number of items per page is 25, the maximum is 50.

ledger_id: integer (int64)
in path

The ID of the AR Ledger.

billing_account_num: string
in query

The filter parameter for retrieving accounting transactions for the particular billing account number.

transaction_date_from: string (date-time)
in query

The filter parameter for retrieving accounting transactions that occurred since the specified date. The date is defined in the ISO 8601 format. Here are examples of how the date can be presented 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

transaction_date_to: string (date-time)
in query

The filter parameter for retrieving accounting transactions that occurred until the specified date. The date is defined in the ISO 8601 format. Here are examples of how the date can be presented 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

source_transaction_reference: string
in query

The filter parameter for retrieving accounting transactions for the particular source transaction reference.

source_batch_reference: string
in query

The filter parameter for retrieving accounting transactions for the particular source batch reference.

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

409 Conflict

Conflict

412 Precondition Failed

Precondition failed.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer (int64)",
    "target_batch_key": "string",
    "source_batch_reference": "string",
    "source_transaction_reference": "string",
    "ledger_id": "integer (int64)",
    "entries": [
      {
        "tenant_id": "integer (int64)",
        "accounting_period_id": "integer (int64)",
        "occurred_on": "string (date-time)",
        "event_date": "string (date-time)",
        "posted_on": "string (date-time)",
        "credit": "boolean",
        "amount": {
          "amount": "number (decimal)",
          "currency": "string"
        },
        "converted_amount": {
          "amount": "number (decimal)",
          "currency": "string"
        },
        "convert_currency": "boolean",
        "conversion_rate": "number (double)",
        "conversion_date": "string (date-time)",
        "description": "string",
        "gl_account_id": "integer (int64)",
        "gl_account_num": "string",
        "gl_account_name": "string",
        "billing_account_num": "string",
        "billing_account_name": "string",
        "ledger_id": "integer (int64)",
        "gl_run_type": "string",
        "manual": "boolean",
        "charge_info_type": "string",
        "target_batch_key": "string",
        "source_batch_reference": "string",
        "source_transaction_reference": "string",
        "entry_values": "object"
      }
    ]
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-Elements-Count

The total results returned in this request. Used to drive paging requests.

integer (int64)
X-Total-Pages

The total pages available for the particular query. Used to drive paging requests.

integer (int64)
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (412 Precondition Failed)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Create draft accounting transaction

POST /ledgers/{ledger_id}/draft-accounting-transactions

Creates a new draft accounting transaction for a certain AR Ledger with the associated ID.

The payload for creating a new accounting transaction.

ledger_id: integer (int64)
in path

The ID of the AR Ledger.

Request Content-Types: application/json
Request Example
{
  "entries": [
    {
      "gl_account_id": "integer (int64)",
      "description": "string",
      "billing_account_num": "string",
      "occurred_on": "string (date-time)",
      "event_date": "string (date-time)",
      "credit": "boolean",
      "amount": {
        "amount": "number (decimal)",
        "currency": "string"
      },
      "converted_amount": {
        "amount": "number (decimal)",
        "currency": "string"
      },
      "conversion_date": "string (date-time)",
      "entry_values": "object"
    }
  ]
}
400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

409 Conflict

Conflict

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (201 Created)
{
  "id": "integer (int64)",
  "target_batch_key": "string",
  "source_batch_reference": "string",
  "source_transaction_reference": "string",
  "ledger_id": "integer (int64)",
  "entries": [
    {
      "tenant_id": "integer (int64)",
      "accounting_period_id": "integer (int64)",
      "occurred_on": "string (date-time)",
      "event_date": "string (date-time)",
      "posted_on": "string (date-time)",
      "credit": "boolean",
      "amount": {
        "amount": "number (decimal)",
        "currency": "string"
      },
      "converted_amount": {
        "amount": "number (decimal)",
        "currency": "string"
      },
      "convert_currency": "boolean",
      "conversion_rate": "number (double)",
      "conversion_date": "string (date-time)",
      "description": "string",
      "gl_account_id": "integer (int64)",
      "gl_account_num": "string",
      "gl_account_name": "string",
      "billing_account_num": "string",
      "billing_account_name": "string",
      "ledger_id": "integer (int64)",
      "gl_run_type": "string",
      "manual": "boolean",
      "charge_info_type": "string",
      "target_batch_key": "string",
      "source_batch_reference": "string",
      "source_transaction_reference": "string",
      "entry_values": "object"
    }
  ]
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Create manual accounting transactions

POST /ledgers/{ledger_id}/accounting-transactions/bulk

Creates manual accounting transactions for a certain ledger.

The payload for creating new manual accounting transactions.

in_gl_accounting_transaction_for_bulk
ledger_id: integer (int64)
in path

The ID of the ledger.

auto_post: boolean false
in query

Specifies whether the entry is automatically posted. If set to True, the entry is automatically posted. If set to False, a draft entry is created. The default value is False.

Request Content-Types: application/json
Request Example
[
  {
    "source_batch_reference": "string",
    "source_transaction_reference": "string",
    "entries": [
      {
        "gl_account_num": "string",
        "description": "string",
        "billing_account_num": "string",
        "occurred_on": "string (date-time)",
        "event_date": "string (date-time)",
        "credit": "boolean",
        "amount": {
          "amount": "number (decimal)",
          "currency": "string"
        },
        "converted_amount": {
          "amount": "number (decimal)",
          "currency": "string"
        },
        "conversion_date": "string (date-time)",
        "entry_values": "object"
      }
    ]
  }
]
400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

409 Conflict

Conflict

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer (int64)",
    "target_batch_key": "string",
    "source_batch_reference": "string",
    "source_transaction_reference": "string",
    "code": "integer",
    "error_message": "string",
    "entries": [
      {
        "tenant_id": "integer (int64)",
        "accounting_period_id": "integer (int64)",
        "occurred_on": "string (date-time)",
        "event_date": "string (date-time)",
        "posted_on": "string (date-time)",
        "credit": "boolean",
        "amount": {
          "amount": "number (decimal)",
          "currency": "string"
        },
        "converted_amount": {
          "amount": "number (decimal)",
          "currency": "string"
        },
        "convert_currency": "boolean",
        "conversion_rate": "number (double)",
        "conversion_date": "string (date-time)",
        "description": "string",
        "gl_account_id": "integer (int64)",
        "gl_account_num": "string",
        "gl_account_name": "string",
        "billing_account_num": "string",
        "billing_account_name": "string",
        "ledger_id": "integer (int64)",
        "gl_run_type": "string",
        "manual": "boolean",
        "charge_info_type": "string",
        "target_batch_key": "string",
        "source_batch_reference": "string",
        "source_transaction_reference": "string",
        "entry_values": "object"
      }
    ]
  }
]
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Delete draft manual accounting transactions in bulk

DELETE /ledgers/{ledger_id}/accounting-transactions/bulk

Deletes draft manual accounting transactions in a bulk for the specified AR ledger ID.

The list of IDs to post.

string
ledger_id: integer (int64)
in path

The ID of the AR ledger.

id_type: string TRANSACTION_ID, SOURCE_TRANSACTION_REFERENCE
in query

The type of IDs in the body. TRANSACTION_ID stands for the ID of the draft transaction. SOURCE_TRANSACTION_REFERENCE stands for the source transaction reference of the draft transaction.

Request Content-Types: application/json
Request Example
[
  "string"
]
200 OK

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

409 Conflict

Conflict

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Post draft manual accounting transactions in bulk

POST /ledgers/{ledger_id}/accounting-transactions/bulk/post

Posts draft manual accounting transactions in a bulk for the specified ledger ID.

The list of IDs to post.

string
ledger_id: integer (int64)
in path

The ID of the ledger.

id_type: string TRANSACTION_ID, SOURCE_TRANSACTION_REFERENCE
in query

The type of IDs in the body. TRANSACTION_ID for the id of the draft transaction. SOURCE_TRANSACTION_REFERENCE for the source transaction reference of the draft transaction.

Request Content-Types: application/json
Request Example
[
  "string"
]
400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

409 Conflict

Conflict

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer (int64)",
    "target_batch_key": "string",
    "source_batch_reference": "string",
    "source_transaction_reference": "string",
    "code": "integer",
    "error_message": "string",
    "entries": [
      {
        "tenant_id": "integer (int64)",
        "accounting_period_id": "integer (int64)",
        "occurred_on": "string (date-time)",
        "event_date": "string (date-time)",
        "posted_on": "string (date-time)",
        "credit": "boolean",
        "amount": {
          "amount": "number (decimal)",
          "currency": "string"
        },
        "converted_amount": {
          "amount": "number (decimal)",
          "currency": "string"
        },
        "convert_currency": "boolean",
        "conversion_rate": "number (double)",
        "conversion_date": "string (date-time)",
        "description": "string",
        "gl_account_id": "integer (int64)",
        "gl_account_num": "string",
        "gl_account_name": "string",
        "billing_account_num": "string",
        "billing_account_name": "string",
        "ledger_id": "integer (int64)",
        "gl_run_type": "string",
        "manual": "boolean",
        "charge_info_type": "string",
        "target_batch_key": "string",
        "source_batch_reference": "string",
        "source_transaction_reference": "string",
        "entry_values": "object"
      }
    ]
  }
]
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Get draft accounting transaction by ID

GET /ledgers/{ledger_id}/draft-accounting-transactions/{id}

Retrieves the specified draft accounting transaction for a certain AR Ledger by associated IDs.

id: integer (int64)
in path

The ID of the draft accounting transaction.

ledger_id: integer (int64)
in path

The ID of the AR Ledger.

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

404 Not Found

Entity not found.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "target_batch_key": "string",
  "source_batch_reference": "string",
  "source_transaction_reference": "string",
  "ledger_id": "integer (int64)",
  "entries": [
    {
      "tenant_id": "integer (int64)",
      "accounting_period_id": "integer (int64)",
      "occurred_on": "string (date-time)",
      "event_date": "string (date-time)",
      "posted_on": "string (date-time)",
      "credit": "boolean",
      "amount": {
        "amount": "number (decimal)",
        "currency": "string"
      },
      "converted_amount": {
        "amount": "number (decimal)",
        "currency": "string"
      },
      "convert_currency": "boolean",
      "conversion_rate": "number (double)",
      "conversion_date": "string (date-time)",
      "description": "string",
      "gl_account_id": "integer (int64)",
      "gl_account_num": "string",
      "gl_account_name": "string",
      "billing_account_num": "string",
      "billing_account_name": "string",
      "ledger_id": "integer (int64)",
      "gl_run_type": "string",
      "manual": "boolean",
      "charge_info_type": "string",
      "target_batch_key": "string",
      "source_batch_reference": "string",
      "source_transaction_reference": "string",
      "entry_values": "object"
    }
  ]
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Update draft accounting transaction

PUT /ledgers/{ledger_id}/draft-accounting-transactions/{id}

Updates the specified draft accounting transaction for a certain AR Ledger by associated IDs.

The payload for updating draft accounting transactions.

id: integer (int64)
in path

The ID of the draft accounting transaction.

ledger_id: integer (int64)
in path

The ID of the AR Ledger.

Request Content-Types: application/json
Request Example
{
  "entries": [
    {
      "gl_account_id": "integer (int64)",
      "description": "string",
      "billing_account_num": "string",
      "occurred_on": "string (date-time)",
      "event_date": "string (date-time)",
      "credit": "boolean",
      "amount": {
        "amount": "number (decimal)",
        "currency": "string"
      },
      "converted_amount": {
        "amount": "number (decimal)",
        "currency": "string"
      },
      "conversion_date": "string (date-time)",
      "entry_values": "object"
    }
  ]
}
400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

404 Not Found

Entity not found.

409 Conflict

Conflict

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "target_batch_key": "string",
  "source_batch_reference": "string",
  "source_transaction_reference": "string",
  "ledger_id": "integer (int64)",
  "entries": [
    {
      "tenant_id": "integer (int64)",
      "accounting_period_id": "integer (int64)",
      "occurred_on": "string (date-time)",
      "event_date": "string (date-time)",
      "posted_on": "string (date-time)",
      "credit": "boolean",
      "amount": {
        "amount": "number (decimal)",
        "currency": "string"
      },
      "converted_amount": {
        "amount": "number (decimal)",
        "currency": "string"
      },
      "convert_currency": "boolean",
      "conversion_rate": "number (double)",
      "conversion_date": "string (date-time)",
      "description": "string",
      "gl_account_id": "integer (int64)",
      "gl_account_num": "string",
      "gl_account_name": "string",
      "billing_account_num": "string",
      "billing_account_name": "string",
      "ledger_id": "integer (int64)",
      "gl_run_type": "string",
      "manual": "boolean",
      "charge_info_type": "string",
      "target_batch_key": "string",
      "source_batch_reference": "string",
      "source_transaction_reference": "string",
      "entry_values": "object"
    }
  ]
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Delete draft accounting transaction

DELETE /ledgers/{ledger_id}/draft-accounting-transactions/{id}

Deletes the specified draft accounting transaction for a certain AR Ledger by associated IDs.

id: integer (int64)
in path

The ID of the draft accounting transaction.

ledger_id: integer (int64)
in path

The ID of the AR Ledger.

200 OK

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

404 Not Found

Entity not found.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Post draft accounting transaction

POST /ledgers/{ledger_id}/draft-accounting-transactions/{id}/post

Posts the specified accounting transaction for a certain AR Ledger by associated IDs.

id: integer (int64)
in path

The ID of the draft accounting transaction.

ledger_id: integer (int64)
in path

The ID of the AR Ledger.

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

404 Not Found

Entity not found.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "target_batch_key": "string",
  "source_batch_reference": "string",
  "source_transaction_reference": "string",
  "ledger_id": "integer (int64)",
  "entries": [
    {
      "tenant_id": "integer (int64)",
      "accounting_period_id": "integer (int64)",
      "occurred_on": "string (date-time)",
      "event_date": "string (date-time)",
      "posted_on": "string (date-time)",
      "credit": "boolean",
      "amount": {
        "amount": "number (decimal)",
        "currency": "string"
      },
      "converted_amount": {
        "amount": "number (decimal)",
        "currency": "string"
      },
      "convert_currency": "boolean",
      "conversion_rate": "number (double)",
      "conversion_date": "string (date-time)",
      "description": "string",
      "gl_account_id": "integer (int64)",
      "gl_account_num": "string",
      "gl_account_name": "string",
      "billing_account_num": "string",
      "billing_account_name": "string",
      "ledger_id": "integer (int64)",
      "gl_run_type": "string",
      "manual": "boolean",
      "charge_info_type": "string",
      "target_batch_key": "string",
      "source_batch_reference": "string",
      "source_transaction_reference": "string",
      "entry_values": "object"
    }
  ]
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Get accounting transactions

GET /ledgers/{ledger_id}/accounting-transactions

Retrieves a list of accounting transactions for the AR Ledger associated with the specified ID.

page_number: integer x ≥ 1 1
in query

The page number for listing. The default value is 1.

page_size: integer 1 ≤ x ≤ 50 25
in query

The page size for listing. The default number of items per page is 25, the maximum is 50.

ledger_id: integer (int64)
in path

The ID of the AR Ledger.

transaction_date_from: string (date-time)
in query

The filter parameter for retrieving accounting transactions that occurred since the specified date. The date is defined in the ISO 8601 format. Here are examples of how the date can be presented 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

transaction_date_to: string (date-time)
in query

The filter parameter for retrieving accounting transactions that occurred until the specified date. The date is defined in the ISO 8601 format. Here are examples of how the date can be presented 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

posted_on_from: string (date-time)
in query

The filter parameter for retrieving accounting transactions that are posted since the specified date. The date is defined in the ISO 8601 format. Here are examples of how the date can be presented 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

posted_on_to: string (date-time)
in query

The filter parameter for retrieving accounting transactions that are posted until the specified date. The date is defined in the ISO 8601 format. Here are examples of how the date can be presented 2015-12-12Z, 015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

accounting_period_from: string (date-time)
in query

The filter parameter for retrieving accounting transactions which accounting period started since the specified date. To appear in the response, both accounting period start and end dates should be included in the range. The date is defined in the ISO 8601 format. Here are examples of how the date can be presented 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

accounting_period_to: string (date-time)
in query

The filter parameter for retrieving accounting transactions which accounting period ended until the specified date. To appear in the response, both accounting period start and end dates should be included in the range. The date is defined in the ISO 8601 format. Here are examples of how the date can be presented 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

billing_account_number: string
in query

The number of the billing account.

billing_account_category_name: string
in query

The category name of the billing account.

gl_account_number: string
in query

The number of the GL account.

transaction_type: string
in query

A comma-separated collection of transaction types.

charge_info_id: integer (int64)
in query

The ID of the charge info.

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

409 Conflict

Conflict

412 Precondition Failed

Precondition failed.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer (int64)",
    "ledger_id": "integer (int64)",
    "target_batch_key": "string",
    "source_batch_reference": "string",
    "source_transaction_reference": "string",
    "entries": [
      {
        "id": "integer (int64)",
        "tenant_id": "integer (int64)",
        "accounting_period_id": "integer (int64)",
        "occurred_on": "string (date-time)",
        "event_date": "string (date-time)",
        "posted_on": "string (date-time)",
        "credit": "boolean",
        "amount": {
          "amount": "number (decimal)",
          "currency": "string"
        },
        "converted_amount": {
          "amount": "number (decimal)",
          "currency": "string"
        },
        "convert_currency": "boolean",
        "conversion_rate": "number (double)",
        "conversion_date": "string (date-time)",
        "charge_category": "string",
        "description": "string",
        "gl_account_id": "integer (int64)",
        "gl_account_num": "string",
        "transaction_id": "string",
        "charge_info_type": "string",
        "gl_posting_rule": "string",
        "gl_posting_rule_name": "string",
        "billing_account_num": "string",
        "billing_account_name": "string",
        "charge_info_id": "integer (int64)",
        "charge_info_state_id": "integer (int64)",
        "gl_run_id": "integer (int64)",
        "ledger_id": "integer (int64)",
        "gl_posting_rule_id": "integer (int64)",
        "gl_run_mode_id": "integer (int64)",
        "gl_run_type": "string",
        "is_rev_rec": "boolean",
        "manual": "boolean",
        "tract_transaction_id": "integer (int64)",
        "target_batch_key": "string",
        "source_batch_reference": "string",
        "source_transaction_reference": "string",
        "entry_values": "object"
      }
    ]
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-Elements-Count

The total results returned in this request. Used to drive paging requests.

integer (int64)
X-Total-Pages

The total pages available for the particular query. Used to drive paging requests.

integer (int64)
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (412 Precondition Failed)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Get accounting transaction by ID

GET /ledgers/{ledger_id}/accounting-transactions/{id}

Retrieves the specified accounting transaction for a certain AR Ledger by associated IDs.

id: integer (int64)
in path

The ID of the accounting transaction.

ledger_id: integer (int64)
in path

The ID of the AR Ledger.

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

404 Not Found

Entity not found.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "ledger_id": "integer (int64)",
  "target_batch_key": "string",
  "source_batch_reference": "string",
  "source_transaction_reference": "string",
  "entries": [
    {
      "id": "integer (int64)",
      "tenant_id": "integer (int64)",
      "accounting_period_id": "integer (int64)",
      "occurred_on": "string (date-time)",
      "event_date": "string (date-time)",
      "posted_on": "string (date-time)",
      "credit": "boolean",
      "amount": {
        "amount": "number (decimal)",
        "currency": "string"
      },
      "converted_amount": {
        "amount": "number (decimal)",
        "currency": "string"
      },
      "convert_currency": "boolean",
      "conversion_rate": "number (double)",
      "conversion_date": "string (date-time)",
      "charge_category": "string",
      "description": "string",
      "gl_account_id": "integer (int64)",
      "gl_account_num": "string",
      "transaction_id": "string",
      "charge_info_type": "string",
      "gl_posting_rule": "string",
      "gl_posting_rule_name": "string",
      "billing_account_num": "string",
      "billing_account_name": "string",
      "charge_info_id": "integer (int64)",
      "charge_info_state_id": "integer (int64)",
      "gl_run_id": "integer (int64)",
      "ledger_id": "integer (int64)",
      "gl_posting_rule_id": "integer (int64)",
      "gl_run_mode_id": "integer (int64)",
      "gl_run_type": "string",
      "is_rev_rec": "boolean",
      "manual": "boolean",
      "tract_transaction_id": "integer (int64)",
      "target_batch_key": "string",
      "source_batch_reference": "string",
      "source_transaction_reference": "string",
      "entry_values": "object"
    }
  ]
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Get accounting entries

GET /ledgers/{ledger_id}/accounting-entries

Retrieves a list of accounting entries by page.

page_number: integer x ≥ 1 1
in query

The page number for listing. The default value is 1.

page_size: integer 1 ≤ x ≤ 50 25
in query

The page size for listing. The default number of items per page is 25, the maximum is 50.

max_records: integer x ≥ 1 1000
in query

The max records to return. The default value is 1000.

ledger_id: integer (int64)
in path

The ID of the AR Ledger.

transaction_date_from: string (date-time)
in query

The filter parameter for retrieving accounting entries that occurred since the specified date. The date is defined in the ISO 8601 format. Here are examples of how the date can be presented 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

transaction_date_to: string (date-time)
in query

The filter parameter for retrieving accounting entries that occurred until the specified date. The date is defined in the ISO 8601 format. Here are examples of how the date can be presented 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

posted_on_from: string (date-time)
in query

The filter parameter for retrieving accounting entries that are posted since the specified date. The date is defined in the ISO 8601 format. Here are examples of how the date can be presented 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

posted_on_to: string (date-time)
in query

The filter parameter for retrieving accounting entries that are posted until the specified date. The date is defined in the ISO 8601 format. Here are examples of how the date can be presented 2015-12-12Z, 015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

billing_account_number: string
in query

The number of the billing account.

billing_account_category_name: string
in query

The category name of the billing account.

gl_account_number: string
in query

The GL account number.

transaction_type: string
in query

A comma-separated collection of transaction types.

charge_info_id: integer (int64)
in query

The ID of the charge info.

transaction_id: integer (int64)
in query

The transaction ID.

invoice_number: string
in query

The invoice number.

target_batch_key: string
in query

The target batch key.

source_batch_reference: string
in query

The source batch reference.

source_transaction_reference: string
in query

The source transaction reference.

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

409 Conflict

Conflict

412 Precondition Failed

Precondition failed.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer (int64)",
    "tenant_id": "integer (int64)",
    "accounting_period_id": "integer (int64)",
    "occurred_on": "string (date-time)",
    "event_date": "string (date-time)",
    "posted_on": "string (date-time)",
    "credit": "boolean",
    "amount": {
      "amount": "number (decimal)",
      "currency": "string"
    },
    "converted_amount": {
      "amount": "number (decimal)",
      "currency": "string"
    },
    "convert_currency": "boolean",
    "conversion_rate": "number (double)",
    "conversion_date": "string (date-time)",
    "charge_category": "string",
    "description": "string",
    "gl_account_id": "integer (int64)",
    "gl_account_num": "string",
    "transaction_id": "string",
    "charge_info_type": "string",
    "gl_posting_rule": "string",
    "gl_posting_rule_name": "string",
    "billing_account_num": "string",
    "billing_account_name": "string",
    "charge_info_id": "integer (int64)",
    "charge_info_state_id": "integer (int64)",
    "gl_run_id": "integer (int64)",
    "ledger_id": "integer (int64)",
    "gl_posting_rule_id": "integer (int64)",
    "gl_run_mode_id": "integer (int64)",
    "gl_run_type": "string",
    "is_rev_rec": "boolean",
    "manual": "boolean",
    "tract_transaction_id": "integer (int64)",
    "target_batch_key": "string",
    "source_batch_reference": "string",
    "source_transaction_reference": "string",
    "entry_values": "object"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-Elements-Count

The total results returned in this request. Used to drive paging requests.

integer (int64)
X-Total-Pages

The total pages available for the particular query. Used to drive paging requests.

integer (int64)
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (412 Precondition Failed)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Create accounting entry extract

POST /ledgers/{ledger_id}/accounting-entries-extract

Extracts accounting entry records to S3.

ledger_id: integer (int64)
in path

The ID of the AR Ledger.

transaction_date_from: string (date-time)
in query

The filter parameter for retrieving accounting transactions that occurred since the specified date. The date is defined in the ISO 8601 format. Here are examples of how the date can be presented 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

transaction_date_to: string (date-time)
in query

The filter parameter for retrieving accounting transactions that occurred until the specified date. The date is defined in the ISO 8601 format. Here are examples of how the date can be presented 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

posted_on_from: string (date-time)
in query

The filter parameter for retrieving accounting transactions that are posted since the specified date. The date is defined in the ISO 8601 format. Here are examples of how the date can be presented 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

posted_on_to: string (date-time)
in query

The filter parameter for retrieving accounting transactions that are posted until the specified date. The date is defined in the ISO 8601 format. Here are examples of how the date can be presented 2015-12-12Z, 015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

accounting_period_from: string (date-time)
in query

The filter parameter for retrieving accounting transactions which accounting period started since the specified date. To appear in the response, both accounting period start and end dates should be included in the range. The date is defined in the ISO 8601 format. Here are examples of how the date can be presented 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

accounting_period_to: string (date-time)
in query

The filter parameter for retrieving accounting transactions which accounting period ended until the specified date. To appear in the response, both accounting period start and end dates should be included in the range. The date is defined in the ISO 8601 format. Here are examples of how the date can be presented 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00

billing_account_number: string
in query

The number of the billing account.

gl_account_number: string
in query

The number of the GL account.

transaction_type: string
in query

A comma-separated collection of transaction types.

charge_info_id: integer (int64)
in query

The ID of the charge info.

billing_account_category_name: string
in query

The billing account category.

is_manual: boolean
in query

Specifies whether the transaction is manual.

starting_record: integer x ≥ 0
in query

(no description)

max_record_count: integer x ≥ 1
in query

The maximum number of accounting entries.

200 OK

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

409 Conflict

Conflict

412 Precondition Failed

Precondition failed.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (412 Precondition Failed)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Get balance

GET /ledgers/{ledger_id}/balance

Get balance for the AR Ledger associated with the specified ID.

ledger_id: integer (int64)
in path

The ID of the AR Ledger.

amount_type: object DEBIT, CREDIT
in query

The amount type. Possible parameter values are DEBIT or CREDIT.

start_date: string (date-time)
in query

The start date that is defined in the ISO8601 format.

end_date: string (date-time)
in query

The end date that is defined in the ISO8601 format.

gl_account_number: string
in query

The GL account number.

billing_account_category_name: string
in query

The name of the billing account category.

billing_account_number: string
in query

The number of the billing account.

currency: string
in query

Currency specified in the ISO 4217 format.

gl_account_category_name: string
in query

The name of the GL account category.

gl_account_category_parent_name: string
in query

The name of the parent GL account category.

account_designation_type: object
in query

The GL account designation.

include_parent_accounts: string EXCLUDE, INCLUDE, ONLY
in query

The parameter used for filtering balances on GL accounts. Possible parameters values are EXCLUDE, INCLUDE, and ONLY. Select EXCLUDE to ignore balance on parent accounts and not include it in the response. Select INCLUDE to include balance on both child and parent accounts. Select ONLY to include balance on parent accounts only.

200 OK

Success

type
400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

404 Not Found

Entity not found.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "entity_type": "string",
    "gl_account_number": "string",
    "gl_account_name": "string",
    "billing_account_category_name": "string",
    "billing_account_number": "string",
    "currency": "string",
    "gl_account_category_name": "string",
    "gl_account_category_parent_name": "string",
    "account_designation_type": "string",
    "amounts": [
      {
        "amount": "number (decimal)",
        "currency": "string"
      }
    ],
    "converted_amount": {
      "amount": "number (decimal)",
      "currency": "string"
    }
  }
]
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

GL Account

Get accounts

GET /accounts

Retrieves a list of GL accounts for the specific tenant by the default page.

name: string
in query

The name of the account.

account_number: string
in query

The number of the account.

account_number_or_name: string
in query

The number or name of the account.

type: string
in query

A comma-separated collection of account types.

designation: string
in query

A comma-separated collection of account designation types.

designation_category: string
in query

A comma-separated collection of account designation categories.

chart_of_account: string
in query

A comma-separated collection of chart of accounts IDs.

is_posting_account: boolean
in query

Specifies whether journal entries can be posted to this account.

status: string
in query

The status of the account.

blacklist: string
in query

A comma-separated collection of gl account IDs to blacklist.

page_number: integer x ≥ 1 1
in query

The page number for listing. The default value is 1.

page_size: integer 1 ≤ x ≤ 50 25
in query

The page size for listing. The default number of items per page is 25, the maximum is 50.

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

409 Conflict

Conflict

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer (int64)",
    "designation_category": "string",
    "tract_id": "integer (int64)",
    "chart_of_accounts": [
      "integer (int64)"
    ],
    "number": "string",
    "name": "string",
    "description": "string",
    "is_posting_account": "boolean",
    "designation": "string",
    "type": "string",
    "status": "string"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-Elements-Count

The total results returned in this request. Used to drive paging requests.

integer (int64)
X-Total-Pages

The total pages available for the particular query. Used to drive paging requests.

integer (int64)
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Create account

POST /accounts

Creates a new GL account.

The payload for creating a new account.

Request Content-Types: application/json
Request Example
{
  "number": "string",
  "name": "string",
  "description": "string",
  "is_posting_account": "boolean",
  "designation": "string",
  "type": "string",
  "status": "string"
}

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

409 Conflict

Conflict

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (201 Created)
{
  "id": "integer (int64)",
  "designation_category": "string",
  "tract_id": "integer (int64)",
  "chart_of_accounts": [
    "integer (int64)"
  ],
  "number": "string",
  "name": "string",
  "description": "string",
  "is_posting_account": "boolean",
  "designation": "string",
  "type": "string",
  "status": "string"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Get account designation types

GET /accounts/designations

Retrieves the GL account designation types.

designation: string
in query

The label of the account designation.

category: string
in query

The name of the account designation category.

type: string
in query

The name of the account designation type.

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

404 Not Found

Entity not found.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "name": "string",
    "label": "string",
    "category": "string",
    "type": "string",
    "ordinal": "integer"
  }
]
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Get account by ID

GET /accounts/{id}

Retrieves the GL account associated with the specified ID.

id: integer (int64)
in path

The ID of the account.

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

404 Not Found

Entity not found.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "designation_category": "string",
  "tract_id": "integer (int64)",
  "chart_of_accounts": [
    "integer (int64)"
  ],
  "number": "string",
  "name": "string",
  "description": "string",
  "is_posting_account": "boolean",
  "designation": "string",
  "type": "string",
  "status": "string"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Update account

PUT /accounts/{id}

Updates the GL account associated with the specified ID.

The payload for updating the existing account.

id: integer (int64)
in path

The ID of the account.

Request Content-Types: application/json
Request Example
{
  "number": "string",
  "name": "string",
  "description": "string",
  "is_posting_account": "boolean",
  "designation": "string",
  "type": "string",
  "status": "string"
}

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

404 Not Found

Entity not found.

409 Conflict

Conflict

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "designation_category": "string",
  "tract_id": "integer (int64)",
  "chart_of_accounts": [
    "integer (int64)"
  ],
  "number": "string",
  "name": "string",
  "description": "string",
  "is_posting_account": "boolean",
  "designation": "string",
  "type": "string",
  "status": "string"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Delete account

DELETE /accounts/{id}

Deletes the GL account associated with the specified ID.

id: integer (int64)
in path

The ID of the account.

200 OK

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

404 Not Found

Entity not found.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Create a batch of accounts

POST /accounts/batch

Creates a batch of GL accounts.

The payload for creating a batch of GL accounts.

Request Content-Types: application/json
Request Example
{
  "entries": [
    {
      "number": "string",
      "name": "string",
      "description": "string",
      "is_posting_account": "boolean",
      "designation": "string",
      "type": "string",
      "status": "string"
    }
  ]
}

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

409 Conflict

Conflict

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (201 Created)
[
  {
    "id": "integer (int64)",
    "designation_category": "string",
    "tract_id": "integer (int64)",
    "chart_of_accounts": [
      "integer (int64)"
    ],
    "number": "string",
    "name": "string",
    "description": "string",
    "is_posting_account": "boolean",
    "designation": "string",
    "type": "string",
    "status": "string"
  }
]
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Update accounts in a batch

PUT /accounts/batch

Updates GL accounts in a batch.

The payload for updating GL accounts in a batch.

Request Content-Types: application/json
Request Example
{
  "entries": [
    {
      "id": "integer (int64)",
      "number": "string",
      "name": "string",
      "description": "string",
      "is_posting_account": "boolean",
      "designation": "string",
      "type": "string",
      "status": "string"
    }
  ]
}
400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

404 Not Found

Entity not found.

409 Conflict

Conflict

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer (int64)",
    "designation_category": "string",
    "tract_id": "integer (int64)",
    "chart_of_accounts": [
      "integer (int64)"
    ],
    "number": "string",
    "name": "string",
    "description": "string",
    "is_posting_account": "boolean",
    "designation": "string",
    "type": "string",
    "status": "string"
  }
]
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Delete accounts in batch

DELETE /accounts/batch

Deletes GL accounts in a batch.

undefined

Request Content-Types: application/json
Request Example
{
  "ids": [
    "integer (int64)"
  ]
}
200 OK

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

404 Not Found

Entity not found.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

GL Account Category

Get account categories

GET /account-categories

Retrieves a list of GL account categories for a certain tenant by the default page.

name: string
in query

The name of the account category.

blacklist: string
in query

A comma-separated collection of account category IDs to blacklist.

type: string
in query

A comma-separated collection of account types.

status: string
in query

The account category status

page_number: integer x ≥ 1 1
in query

The page number for listing. The default value is 1.

page_size: integer 1 ≤ x ≤ 50 25
in query

The page size for listing. The default number of items per page is 25, the maximum is 50.

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

409 Conflict

Conflict

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer (int64)",
    "tract_id": "integer (int64)",
    "chart_of_accounts": [
      "integer (int64)"
    ],
    "name": "string",
    "description": "string",
    "status": "string",
    "type": "string"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-Elements-Count

The total results returned in this request. Used to drive paging requests.

integer (int64)
X-Total-Pages

The total pages available for the particular query. Used to drive paging requests.

integer (int64)
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Create account category

POST /account-categories

Creates a new GL account category for a certain tenant.

The payload for creating a new account category.

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "description": "string",
  "status": "string",
  "type": "string"
}

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

409 Conflict

Conflict

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (201 Created)
{
  "id": "integer (int64)",
  "tract_id": "integer (int64)",
  "chart_of_accounts": [
    "integer (int64)"
  ],
  "name": "string",
  "description": "string",
  "status": "string",
  "type": "string"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Get account category by ID

GET /account-categories/{id}

Retrieves the GL account category associated with the specified ID for a certain tenant.

id: integer (int64)
in path

The ID of the account category.

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

404 Not Found

Entity not found.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "tract_id": "integer (int64)",
  "chart_of_accounts": [
    "integer (int64)"
  ],
  "name": "string",
  "description": "string",
  "status": "string",
  "type": "string"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Update account category

PUT /account-categories/{id}

Updates the GL account category associated with the specified ID for a certain tenant.

The payload for updating the existing account category.

id: integer (int64)
in path

The ID of the account category.

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "description": "string",
  "status": "string",
  "type": "string"
}
400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

404 Not Found

Entity not found.

409 Conflict

Conflict

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "tract_id": "integer (int64)",
  "chart_of_accounts": [
    "integer (int64)"
  ],
  "name": "string",
  "description": "string",
  "status": "string",
  "type": "string"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Delete account category

DELETE /account-categories/{id}

Deletes the GL account category associated with the specified ID for a certain tenant.

id: integer (int64)
in path

The ID of the account category.

200 OK

Success

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

404 Not Found

Entity not found.

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (503 Service Unavailable)
{
  "code": "string",
  "message": "string"
}

Chart of Accounts

Get chart of accounts

GET /chart-of-accounts

Retrieves the chart of accounts for the tenant by the default page.

ledger_id: integer (int64)
in query

The ID of the AR Ledger.

id: integer (int64)
in query

The ID of the chart of accounts.

name: string
in query

The name of the chart of accounts.

status: string
in query

A comma-separated collection of statuses.

account_category_id: integer (int64)
in query

The ID of the account category.

account_id: integer (int64)
in query

The ID of the GL account.

get_account_categories: boolean false
in query

Fetch account categories for chart of accounts.

get_accounts: boolean false
in query

Fetch GL accounts for the chart of accounts.

blacklist: string
in query

A comma-separated collection of chart of account IDs to blacklist.

page_number: integer x ≥ 1 1
in query

The page number for listing. The default value is 1.

page_size: integer 1 ≤ x ≤ 50 25
in query

The page size for listing. The default number of items per page is 25, the maximum is 50.

400 Bad Request

Bad request.

401 Unauthorized

Authentication failed.

403 Forbidden

Forbidden.

409 Conflict

Conflict

503 Service Unavailable

Service unavailable.

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer (int64)",
    "account_categories": [
      {
        "parent_id": "integer (int64)",
        "parent_name": "string",
        "id": "integer (int64)",
        "tract_id": "integer (int64)",
        "chart_of_accounts": [
          "integer (int64)"
        ],
        "name": "string",
        "description": "string",
        "status": "string",
        "type": "string"
      }
    ],
    "accounts": [
      {
        "parent_id": "integer (int64)",
        "parent_number": "string",
        "parent_name": "string",
        "account_category_id": "integer (int64)",
        "account_category_name": "string",
        "id": "integer (int64)",
        "designation_category": "string",
        "tract_id": "integer (int64)",
        "chart_of_accounts": [
          "integer (int64)"
        ],
        "number": "string",
        "name": "string",
        "description": "string",
        "is_posting_account": "boolean",
        "designation": "string",
        "type": "string",
        "status": "string"
      }
    ],
    "ledgers": [
      "integer (int64)"
    ],
    "name": "string",
    "description": "string",
    "status": "string"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-Elements-Count

The total results returned in this request. Used to drive paging requests.

integer (int64)
X-Total-Pages

The total pages available for the particular query. Used to drive paging requests.

integer (int64)