The Global Defaults object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

default_company string
country string
default_distance_unit string
default_currency string

Default: INR

hide_currency_symbol string
disable_rounded_total boolean

Default: false

disable_in_words boolean

Default: false

demo_company string
use_posting_datetime_for_naming_documents boolean

Default: false

The Global Defaults object 
{
  "id": "global-defaults_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "default_company": "Example Corp",
  "country": "country_example",
  "default_distance_unit": "default_distance_unit_example",
  "default_currency": "INR",
  "hide_currency_symbol": "USD",
  "disable_rounded_total": false,
  "disable_in_words": false,
  "demo_company": "Example Corp",
  "use_posting_datetime_for_naming_documents": false
}
GET /api/setup/global-defaults/{id}

Retrieve a global defaults

Retrieves the details of an existing global defaults. Supply the unique global defaults ID that was returned from a previous request.

Path parameters

id string required

The identifier of the global defaults to retrieve.

Returns

Returns the global defaults object if a valid identifier was provided.

GET /api/setup/global-defaults/{id} 
curl https://api.overplane.dev/api/setup/global-defaults/global-defaults_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "global-defaults_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "default_company": "Example Corp",
  "country": "country_example",
  "default_distance_unit": "default_distance_unit_example",
  "default_currency": "INR",
  "hide_currency_symbol": "USD",
  "disable_rounded_total": false,
  "disable_in_words": false,
  "demo_company": "Example Corp",
  "use_posting_datetime_for_naming_documents": false
}
GET /api/setup/global-defaults

List all global defaultss

Returns a list of global defaultss. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of global defaults objects.

GET /api/setup/global-defaults 
curl https://api.overplane.dev/api/setup/global-defaults \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "global-defaults_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "default_company": "Example Corp",
      "country": "country_example",
      "default_distance_unit": "default_distance_unit_example",
      "default_currency": "INR",
      "hide_currency_symbol": "USD",
      "disable_rounded_total": false,
      "disable_in_words": false,
      "demo_company": "Example Corp",
      "use_posting_datetime_for_naming_documents": false
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/setup/global-defaults

Create a global defaults

Creates a new global defaults object.

Body parameters

default_company string
country string
default_distance_unit string
default_currency string

Default: INR

hide_currency_symbol string
disable_rounded_total boolean

Default: false

disable_in_words boolean

Default: false

demo_company string
use_posting_datetime_for_naming_documents boolean

Default: false

Returns

Returns the newly created global defaults object if the call succeeded.

POST /api/setup/global-defaults 
curl https://api.overplane.dev/api/setup/global-defaults \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "global-defaults_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "default_company": "Example Corp",
  "country": "country_example",
  "default_distance_unit": "default_distance_unit_example",
  "default_currency": "INR",
  "hide_currency_symbol": "USD",
  "disable_rounded_total": false,
  "disable_in_words": false,
  "demo_company": "Example Corp",
  "use_posting_datetime_for_naming_documents": false
}
PATCH /api/setup/global-defaults/{id}

Update a global defaults

Updates the specified global defaults by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the global defaults to update.

Body parameters

default_company string
country string
default_distance_unit string
default_currency string

Default: INR

hide_currency_symbol string
disable_rounded_total boolean

Default: false

disable_in_words boolean

Default: false

demo_company string
use_posting_datetime_for_naming_documents boolean

Default: false

Returns

Returns the updated global defaults object.

PATCH /api/setup/global-defaults/{id} 
curl https://api.overplane.dev/api/setup/global-defaults/global-defaults_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"default_company":"Example Corp","country":"country_example"}'
Response 
{
  "id": "global-defaults_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "default_company": "Example Corp",
  "country": "country_example",
  "default_distance_unit": "default_distance_unit_example",
  "default_currency": "INR",
  "hide_currency_symbol": "USD",
  "disable_rounded_total": false,
  "disable_in_words": false,
  "demo_company": "Example Corp",
  "use_posting_datetime_for_naming_documents": false
}
DELETE /api/setup/global-defaults/{id}

Delete a global defaults

Permanently deletes a global defaults. This cannot be undone.

Path parameters

id string required

The identifier of the global defaults to delete.

Returns

Returns a confirmation that the global defaults has been deleted.

DELETE /api/setup/global-defaults/{id} 
curl https://api.overplane.dev/api/setup/global-defaults/global-defaults_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "global-defaults_abc123",
  "deleted": true
}