The POS Settings 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.

invoice_type string

Default: Sales Invoice

post_change_gl_entries boolean

Default: false

The POS Settings object 
{
  "id": "p-o-s-settings_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "invoice_type": "Sales Invoice",
  "post_change_gl_entries": false
}
GET /api/accounts/p-o-s-settings

Retrieve pos settings

Retrieves the current pos settings. This is a singleton resource.

Returns

Returns the pos settings object.

GET /api/accounts/p-o-s-settings 
curl https://api.overplane.dev/api/accounts/p-o-s-settings \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "p-o-s-settings_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "invoice_type": "Sales Invoice",
  "post_change_gl_entries": false
}
PATCH /api/accounts/p-o-s-settings/{id}

Update a pos settings

Updates the specified pos settings 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 pos settings to update.

Body parameters

invoice_type string

Default: Sales Invoice

post_change_gl_entries boolean

Default: false

Returns

Returns the updated pos settings object.

PATCH /api/accounts/p-o-s-settings/{id} 
curl https://api.overplane.dev/api/accounts/p-o-s-settings/p-o-s-settings_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"invoice_type":"Sales Invoice","post_change_gl_entries":false}'
Response 
{
  "id": "p-o-s-settings_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "invoice_type": "Sales Invoice",
  "post_change_gl_entries": false
}