Work setup and job types

work config

Get

GET/v1/work-config

What a business calls its work records, its pinned entries and sharing defaults, the job types it can use and the words resolved from them. Every label is tenant text inside the untrusted envelope.

Scope

jobs:read

Effect

Read only

MCP tool

get_work_config

Retries

Safe to repeat

curl -X GET "https://api.billingmart.com/v1/work-config" \
  -H "Authorization: Bearer $BILLINGMART_API_KEY"

industry packs

List

GET/v1/industry-packs

The industry packs a business can adopt: key, name, version and a summary of the work setup each carries (words, record types). Platform content, no tenant data.

Scope

business:read

Effect

Read only

MCP tool

list_industry_packs

Retries

Safe to repeat

curl -X GET "https://api.billingmart.com/v1/industry-packs" \
  -H "Authorization: Bearer $BILLINGMART_API_KEY"

job types

List

GET/v1/job-types

Job types, oldest first: label, icon, status, revision and whether a draft is waiting. Narrowed to the businesses the credential is confined to. active by default.

Scope

jobs:read

Effect

Read only

MCP tool

list_job_types

Retries

Safe to repeat

curl -X GET "https://api.billingmart.com/v1/job-types" \
  -H "Authorization: Bearer $BILLINGMART_API_KEY"

job types

Create

POST/v1/job-types

Create a job type as a DRAFT for the given businesses (empty = every business, unconfined credentials only). Nothing is published or usable until an owner or admin publishes it in BillingMart.

Scope

workConfig:write

Effect

Writes a draft or record

MCP tool

create_job_type_draft

Retries

Send an Idempotency-Key; a repeat replays the stored answer for 24 hours

curl -X POST "https://api.billingmart.com/v1/job-types" \
  -H "Authorization: Bearer $BILLINGMART_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"businessIds":[],"definition":{}}'

job types

Get

GET/v1/job-types/{typeId}

One job type: status, revision, businesses and the published definition records render. The waiting draft and its provenance come back only to an owner or admin credential that also holds workConfig:write. Confined to the businesses of the credential.

Scope

jobs:read

Effect

Read only

MCP tool

get_job_type

Retries

Safe to repeat

curl -X GET "https://api.billingmart.com/v1/job-types/{typeId}" \
  -H "Authorization: Bearer $BILLINGMART_API_KEY"

job types

Get revision

GET/v1/job-types/{typeId}/revisions/{revision}

One published, immutable revision of a job type: the definition a work record pinned. Never a draft. Confined to the businesses of the credential.

Scope

jobs:read

Effect

Read only

MCP tool

get_job_type_revision

Retries

Safe to repeat

curl -X GET "https://api.billingmart.com/v1/job-types/{typeId}/revisions/{revision}" \
  -H "Authorization: Bearer $BILLINGMART_API_KEY"

job types

Save draft

POST/v1/job-types/{typeId}/draft

Save a new draft of an existing job type. Field keys of a published type are read-only. The published definition is untouched until an owner or admin publishes the draft in BillingMart.

Scope

workConfig:write

Effect

Writes a draft or record

MCP tool

save_job_type_draft

Retries

Send an Idempotency-Key; a repeat replays the stored answer for 24 hours

curl -X POST "https://api.billingmart.com/v1/job-types/{typeId}/draft" \
  -H "Authorization: Bearer $BILLINGMART_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"businessIds":[],"definition":{}}'

work config

Propose

POST/v1/work-proposals

Ask the assistant to propose a work setup for a business from a plain description: terminology, record types, questions, stages and pins. Writes a proposal only; nothing changes until an owner or admin applies it in BillingMart. Uses AI credits.

Scope

workConfig:write

Effect

Writes a draft or record

MCP tool

create_work_proposal

Retries

Send an Idempotency-Key; a repeat replays the stored answer for 24 hours

curl -X POST "https://api.billingmart.com/v1/work-proposals" \
  -H "Authorization: Bearer $BILLINGMART_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"businessId":"<businessId>","task":"setup","description":"<description>"}'

work config

Get proposal

GET/v1/work-proposals/{proposalId}

Read a work setup proposal: its status, the changes it would make and its summary. Only its author and owners and admins of the business can read it. The summary and every proposed value are tenant text inside the untrusted envelope.

Scope

jobs:read

Effect

Read only

MCP tool

get_work_proposal

Retries

Safe to repeat

curl -X GET "https://api.billingmart.com/v1/work-proposals/{proposalId}" \
  -H "Authorization: Bearer $BILLINGMART_API_KEY"

Object

WorkConfigView

WorkConfigView is computed by the server for this request, not a stored document, so no contract describes it. Its fields are the TypeScript type of the same name that the handler returns.

Object

IndustryPackSummary

IndustryPackSummary is computed by the server for this request, not a stored document, so no contract describes it. Its fields are the TypeScript type of the same name that the handler returns.

Object

JobTypeSummary

JobTypeSummary is computed by the server for this request, not a stored document, so no contract describes it. Its fields are the TypeScript type of the same name that the handler returns.

Object

JobTypeView

JobTypeView is computed by the server for this request, not a stored document, so no contract describes it. Its fields are the TypeScript type of the same name that the handler returns.

Object

JobTypeRevisionView

JobTypeRevisionView is computed by the server for this request, not a stored document, so no contract describes it. Its fields are the TypeScript type of the same name that the handler returns.

Object

WorkProposal

A proposed change to a business's work configuration, prepared by the assistant or a person and applied only after an owner or admin approves it with a second factor. FUNCTION-WRITTEN ONLY, by the proposal cores of.