Skip to main content
GET
/
coa
/
api
/
entity
List Chart Entities
curl --request GET \
  --url https://api.meetcampfire.com/coa/api/entity \
  --header 'Authorization: <api-key>'
[
  {
    "id": 123,
    "parent_name": "<string>",
    "is_deleted": false,
    "deleted_at": "2023-11-07T05:31:56Z",
    "last_modified_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "description": "<string>",
    "currency": "<string>",
    "invoice_name": "<string>",
    "invoice_email": "<string>",
    "address_1": "<string>",
    "address_2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip_code": "<string>",
    "country": "<string>",
    "invoice_message": "<string>",
    "invoice_email_body": "<string>",
    "invoice_email_subject": "<string>",
    "invoice_prefix": "<string>",
    "invoice_address": "<string>",
    "logo_url": "<string>",
    "active": true,
    "fiscal_year_month": -1,
    "fiscal_year_day": -1,
    "created_at": "2023-11-07T05:31:56Z",
    "enable_mid_month_convention": true,
    "mid_month_threshold": 15,
    "lineage_array": [
      "<string>"
    ],
    "customer": 123,
    "parent": 123
  }
]

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Query Parameters

​
include_inactive
boolean
default:true

Include inactive entities in results

Response

200 - application/json
​
id
integer
required
​
parent_name
string
required
​
is_deleted
boolean
default:false
required
​
deleted_at
string<date-time> | null
required
​
last_modified_at
string<date-time>
required
​
created_at
string<date-time> | null
required
​
customer
integer
required
​
name
string | null
Maximum length: 250
​
description
string | null
​
currency
string
Maximum length: 3
​
invoice_name
string | null
Maximum length: 120
​
invoice_email
string | null
Maximum length: 120
​
address_1
string | null
Maximum length: 120
​
address_2
string | null
Maximum length: 120
​
city
string | null
Maximum length: 120
​
state
string | null
Maximum length: 120
​
zip_code
string | null
Maximum length: 120
​
country
string | null
Maximum length: 120
​
invoice_message
string | null
​
invoice_email_body
string | null
​
invoice_email_subject
string | null
Maximum length: 250
​
invoice_prefix
string | null
Maximum length: 120
​
invoice_address
string | null
​
logo_url
string<uri> | null
Maximum length: 500
​
active
boolean
​
fiscal_year_month
integer
Required range: -2147483648 <= x <= 2147483647
​
fiscal_year_day
integer
Required range: -2147483648 <= x <= 2147483647
​
enable_mid_month_convention
boolean | null

Override customer-level mid-month convention setting for this entity. Leave blank to inherit from customer.

​
mid_month_threshold
integer | null

Override customer-level threshold. Leave blank to inherit from customer.

Required range: 0 <= x <= 31
​
lineage_array
string[] | null

Pre-computed lineage array from root to this entity

​
parent
integer | null