House Account

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

query

$top

integer

No

The maximum documents to return

query

$skip

integer

No

The documents to skip before returning

query

$filter

string

No

A filter expression in OData v4 format

query

$orderby

string

No

An order by expression in OData v4 format

query

include_nested

boolean

No

Hydrates related nested objects when returning a result. For example, populate a Menu with Menu Categories and Menu Groups.

query

include_mappings

boolean

No

Include mappings for document in the response

query

include_entities

[string]

No

Specify entity_types to be populated by nesting mechanism. For example, include_entities=['menu-category'] for menu call - populate a Menu with Menu Categories.

query

include_inactive

boolean

No

Includes documents that inactive for current sites

200

Success

house_account_list

400

Bad request, for more information look at body error

403

Invalid token

404

Not found

422

Unprocessable error

Default

Unexpected error

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

header

X-SITE-IDs

[string]

No

The identifiers of the site to manage data for

query

$filter

string

No

A filter expression in OData v4 format

query

$top

integer

No

The maximum documents to return

query

$skip

integer

No

The documents to skip before returning

query

$orderby

string

No

An order by expression in OData v4 format

query

effective_date

string

Yes

The date and time to query against

query

entity_ids

string

No

An array of entity identifiers

query

include_nested

boolean

No

Hydrates related nested objects when returning a result. For example, populate a Menu with Menu Categories and Menu Groups.

query

include_mappings

boolean

No

Include mappings for document in the response

query

include_mappings_for_entities

[string]

No

Specify entity types for which mappings will be presented as a part of the response. For example, include_mappings_for_entities_param=['product','product-price', etc..].

query

include_entities

[string]

No

Specify entity_types to be populated by nesting mechanism. For example, include_entities=['menu-category'] for menu call - populate a Menu with Menu Categories.

query

include_audit

boolean

No

Adds audit fields to each document when returning a result: is_active, is_master, created_at, created_by, updated_at, updated_by

query

include_inactive

boolean

No

Includes documents that inactive for current sites

200

Success

house_account_list

400

Bad request, for more information look at body error

403

Invalid token

404

Not found

422

Unprocessable error

Default

Unexpected error

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

header

X-SITE-IDs

[string]

No

The identifiers of the site to manage data for

query

$filter

string

No

A filter expression in OData v4 format

query

$top

integer

No

The maximum documents to return

query

$skip

integer

No

The documents to skip before returning

query

$orderby

string

No

An order by expression in OData v4 format

query

effective_date

string

Yes

The date and time to query against

query

entity_ids

string

No

An array of entity identifiers

query

include_nested

boolean

No

Hydrates related nested objects when returning a result. For example, populate a Menu with Menu Categories and Menu Groups.

query

include_entities

[string]

No

Specify entity_types to be populated by nesting mechanism. For example, include_entities=['menu-category'] for menu call - populate a Menu with Menu Categories.

query

include_audit

boolean

No

Adds audit fields to each document when returning a result: is_active, is_master, created_at, created_by, updated_at, updated_by

query

include_inactive

boolean

No

Includes documents that inactive for current sites

query

include_mappings_for_entities

[string]

No

Specify entity types for which mappings will be presented as a part of the response. For example, include_mappings_for_entities_param=['product','product-price', etc..].

200

Success

house_account_list

400

Bad request, for more information look at body error

403

Invalid token

404

Not found

422

Unprocessable error

Default

Unexpected error

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

query

include_nested

boolean

No

Hydrates related nested objects when returning a result. For example, populate a Menu with Menu Categories and Menu Groups.

query

include_entities

[string]

No

Specify entity_types to be populated by nesting mechanism. For example, include_entities=['menu-category'] for menu call - populate a Menu with Menu Categories.

body

body

house_account_create

Yes

The JSON formatted request

400

Bad request, for more information look at body error

403

Invalid token

404

Not found

422

Unprocessable error

Default

Unexpected error

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

path

entity_id

string

Yes

The entity identifier

body

body

house_account_create

Yes

The JSON formatted request

400

Bad request, for more information look at body error

403

Invalid token

404

Not found

422

Unprocessable error

Default

Unexpected error

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

path

entity_id

string

Yes

The entity identifier

200

Success

400

Bad request, for more information look at body error

403

Invalid token

404

Not found

422

Unprocessable error

Default

Unexpected error

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

header

X-SITE-IDs

[string]

No

The identifiers of the site to manage data for

200

Success

house_account_list

400

Bad request, for more information look at body error

403

Invalid token

404

Not found

422

Unprocessable error

Default

Unexpected error

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

400

Bad request, for more information look at body error

403

Invalid token

404

Not found

422

Unprocessable error

Default

Unexpected error

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

400

Bad request, for more information look at body error

403

Invalid token

404

Not found

422

Unprocessable error

Default

Unexpected error

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

200

Success

400

Bad request, for more information look at body error

403

Invalid token

404

Not found

422

Unprocessable error

Default

Unexpected error

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

200

Success

house_account_list

400

Bad request, for more information look at body error

403

Invalid token

404

Not found

422

Unprocessable error

Default

Unexpected error

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

header

X-SITE-IDs

[string]

No

The identifiers of the site to manage data for

query

$top

integer

No

The maximum documents to return

query

$skip

integer

No

The documents to skip before returning

query

$filter

string

No

A filter expression in OData v4 format

query

$orderby

string

No

An order by expression in OData v4 format

query

include_inactive

boolean

No

Includes documents that inactive for current sites

400

Bad request, for more information look at body error

403

Invalid token

404

Not found

422

Unprocessable error

Default

Unexpected error

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

header

X-SITE-IDs

[string]

No

The identifiers of the site to manage data for

400

Bad request, for more information look at body error

403

Invalid token

404

Not found

422

Unprocessable error

Default

Unexpected error

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

400

Bad request, for more information look at body error

403

Invalid token

404

Not found

422

Unprocessable error

Default

Unexpected error

name

string

Yes

The name for the House Account, which is used by the ordering application

account_number

string

No

The identifier for the House Account, which may be used by external partners and integrators

house_account_status_entity_id

string, object

Yes

The status for House Account, which is used in the ordering application to allow or restrict using a House Account in operations

_id

_id

No

company_id

company_id

No

entity_id

entity_id

No

is_master

is_master

No

is_active

is_active

No

external_id

external_id

No

created_by

created_by

No

updated_by

updated_by

No

created_at

created_at

No

updated_at

updated_at

No

name

string

Yes

The name for the House Account, which is used by the ordering application

account_number

string

No

The identifier for the House Account, which may be used by external partners and integrators

house_account_status_entity_id

string, object

Yes

The status for House Account, which is used in the ordering application to allow or restrict using a House Account in operations

entity_id

entity_id

No

external_id

external_id

No

name

string

No

The name for the House Account, which is used by the ordering application

account_number

string

No

The identifier for the House Account, which may be used by external partners and integrators

house_account_status_entity_id

string, object

No

The status for House Account, which is used in the ordering application to allow or restrict using a House Account in operations

external_id

external_id

No

total

integer

items

[house_account]

name

string

_id

string

The auto-assigned system document identifier

company_id

string

The identifier of the company who owns the document

entity_id

string

The auto-assigned unique identifier of this entity, set on creation. All future versions of this entity will share the same entity_id.

is_master

boolean

is_active

boolean

A flag that indicates active documents. Sets to true by default.

external_id

string

created_by

string

The identifier of the OPRA user or site that created this document

updated_by

string

The identifier of the OPRA user or site that last updated this document

created_at

string

The date and time the document was created

updated_at

string

The last date and time the document was updated

total

integer

document_id

string

Yes

The document identifier in the collection the mapping refers to

document_id

string

Yes

The document identifier in the collection the mapping refers to

_id

_id

company_id

company_id

entity_id

entity_id

document_id

string

The document identifier in the collection the mapping refers to

created_by

created_by

updated_by

updated_by

created_at

created_at

updated_at

updated_at