Skip to main content
PATCH
/
coa
/
api
/
entity
/
{id}
Partial Update Chart Entity
curl --request PATCH \
  --url https://api.meetcampfire.com/coa/api/entity/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "parent": 123,
  "elimination_entity": 123,
  "primary_entity": 123,
  "name": "<string>",
  "description": "<string>",
  "currency": "<string>",
  "address_1": "<string>",
  "address_2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zip_code": "<string>",
  "country": "<string>",
  "disable_service_date": true,
  "logo_url": "<string>",
  "active": true,
  "fiscal_year_month": -1,
  "fiscal_year_day": -1,
  "enable_mid_month_convention": true,
  "mid_month_threshold": 15,
  "use_whole_month_accounting_for_prepaids": true,
  "lineage_array": [
    "<string>"
  ],
  "tax_identification_number": "<string>",
  "representative_name": "<string>",
  "business_type": "<string>",
  "business_category": "<string>"
}
'
{
  "id": 123,
  "customer": 123,
  "parent_name": "<string>",
  "primary_entity_name": "<string>",
  "is_adjusting": true,
  "is_deleted": false,
  "deleted_at": "2023-11-07T05:31:56Z",
  "last_modified_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "invoice_name": "<string>",
  "invoice_email": "<string>",
  "invoice_message": "<string>",
  "invoice_email_subject": "<string>",
  "invoice_email_body": "<string>",
  "invoice_prefix": "<string>",
  "invoice_address": "<string>",
  "invoice_cc_emails": "<string>",
  "invoice_display_settings": {},
  "invoice_email_attachments": {},
  "parent": 123,
  "elimination_entity": 123,
  "primary_entity": 123,
  "name": "<string>",
  "description": "<string>",
  "currency": "<string>",
  "address_1": "<string>",
  "address_2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zip_code": "<string>",
  "country": "<string>",
  "disable_service_date": true,
  "logo_url": "<string>",
  "active": true,
  "fiscal_year_month": -1,
  "fiscal_year_day": -1,
  "enable_mid_month_convention": true,
  "mid_month_threshold": 15,
  "use_whole_month_accounting_for_prepaids": true,
  "lineage_array": [
    "<string>"
  ],
  "tax_identification_number": "<string>",
  "representative_name": "<string>",
  "business_type": "<string>",
  "business_category": "<string>"
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

​
id
integer
required

Body

​
parent
integer | null
​
elimination_entity
integer | null
​
primary_entity
integer | null

When set, this entity is an adjusting entity linked to the specified primary entity.

​
name
string | null
Maximum string length: 250
​
description
string | null
​
currency
string
Maximum string length: 3
​
address_1
string | null
Maximum string length: 120
​
address_2
string | null
Maximum string length: 120
​
city
string | null
Maximum string length: 120
​
state
string | null
Maximum string length: 120
​
zip_code
string | null
Maximum string length: 120
​
country
string | null
Maximum string length: 120
​
disable_service_date
boolean

When enabled, the Service Date field will be hidden on invoices for this entity

​
logo_url
string<uri> | null
Maximum string 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
​
use_whole_month_accounting_for_prepaids
boolean | null

Override customer-level whole-month accounting setting for this entity. Leave blank to inherit from customer.

​
lineage_array
string[] | null

Pre-computed lineage array from root to this entity

Maximum string length: 50
​
tax_identification_number
string | null

Tax ID such as Korean BRN, GST number, or EU VAT number

Maximum string length: 250
​
representative_name
string | null

Legal representative name

Maximum string length: 250
​
business_type
string | null

Business type classification

Maximum string length: 250
​
business_category
string | null

Business category classification

Maximum string length: 250

Response

200 - application/json
​
id
integer
required
​
customer
integer
required
​
parent_name
string
required
​
primary_entity_name
string
required
​
is_adjusting
boolean
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
​
invoice_name
string | null
required
​
invoice_email
string | null
required
​
invoice_message
string | null
required
​
invoice_email_subject
string | null
required
​
invoice_email_body
string | null
required
​
invoice_prefix
string | null
required
​
invoice_address
string | null
required
​
invoice_cc_emails
string | null
required
​
invoice_display_settings
object
required
​
invoice_email_attachments
object
required
​
parent
integer | null
​
elimination_entity
integer | null
​
primary_entity
integer | null

When set, this entity is an adjusting entity linked to the specified primary entity.

​
name
string | null
Maximum string length: 250
​
description
string | null
​
currency
string
Maximum string length: 3
​
address_1
string | null
Maximum string length: 120
​
address_2
string | null
Maximum string length: 120
​
city
string | null
Maximum string length: 120
​
state
string | null
Maximum string length: 120
​
zip_code
string | null
Maximum string length: 120
​
country
string | null
Maximum string length: 120
​
disable_service_date
boolean

When enabled, the Service Date field will be hidden on invoices for this entity

​
logo_url
string<uri> | null
Maximum string 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
​
use_whole_month_accounting_for_prepaids
boolean | null

Override customer-level whole-month accounting setting for this entity. Leave blank to inherit from customer.

​
lineage_array
string[] | null

Pre-computed lineage array from root to this entity

Maximum string length: 50
​
tax_identification_number
string | null

Tax ID such as Korean BRN, GST number, or EU VAT number

Maximum string length: 250
​
representative_name
string | null

Legal representative name

Maximum string length: 250
​
business_type
string | null

Business type classification

Maximum string length: 250
​
business_category
string | null

Business category classification

Maximum string length: 250