abandon_build
Mark the month's stuck in-flight build failed so it can be resubmitted.
Code
abandon_build › Request Body
yearFour-digit calendar year of the report month.
monthCalendar month of the report month, 1-12.
abandon_build › Responses
successWhether the request itself succeeded. False with messages.refusal_code on an admission refusal.
Empty on success. On a refusal: an object with refusal_code plus one sentence under the field the refusal is about.
get_build_status
Poll the month's build. Idempotent: polling never consumes the result.
Code
get_build_status › Request Body
yearFour-digit calendar year of the report month.
monthCalendar month of the report month, 1-12.
get_build_status › Responses
successWhether the request itself succeeded. False with messages.refusal_code on an admission refusal.
Empty on success. On a refusal: an object with refusal_code plus one sentence under the field the refusal is about.
get_configuration
Return the credential-free DBCS configuration read model.
Code
get_configuration › Request Body
get_configuration › Responses
successIndicates if the request was successful.
Any messages or errors related to the request.
get_existing_artifacts
List the DBCS XML already on file for the month, newest first.
Code
get_existing_artifacts › Request Body
yearFour-digit calendar year of the report month.
monthCalendar month of the report month, 1-12.
get_existing_artifacts › Responses
successWhether the request itself succeeded. False with messages.refusal_code on an admission refusal.
Empty on success. On a refusal: an object with refusal_code plus one sentence under the field the refusal is about.
get_selected_agencies
Return the stored selection, resolved, INCLUDING ids no longer eligible.
Code
get_selected_agencies › Request Body
get_selected_agencies › Responses
successIndicates if the request was successful.
Any messages or errors related to the request.
rebuild
Submit a new build that supersedes an earlier DBCS XML for the month.
Code
rebuild › Request Body
yearFour-digit calendar year of the report month.
monthCalendar month of the report month, 1-12.
supersedes_file_idid of the earlier nxtech_dbcs XML this build replaces. Must exist, be DBCS XML and cover the requested month, or the request is refused before anything is queued. Recorded only on the NEW file's metadata; the superseded file is never modified.
acknowledged_unverified_monthRequired true for a month older than last month, whose commission checkpoint is not checked. Ignored for last month. Acknowledgement alone is not enough: the month must still have commission payments.
rebuild › Responses
successWhether the request itself succeeded. False with messages.refusal_code on an admission refusal.
Empty on success. On a refusal: an object with refusal_code plus one sentence under the field the refusal is about.
resolve_agencies
Resolve a batch of contact ids to rows plus their eligibility verdicts.
Code
resolve_agencies › Request Body
contact_idsContact ids to resolve. Null or omitted is treated as an empty list and resolves nothing. Repeats are allowed. Ids with no contacts row come back in unknown_contact_ids.
resolve_agencies › Responses
successIndicates if the request was successful.
Any messages or errors related to the request.
save_selected_agencies
Replace the whole stored selection with the submitted ids.
Code
save_selected_agencies › Request Body
contact_idsThe complete new selection. Null or omitted is treated as an empty list, which CLEARS the selection and therefore requires confirmation_text. Every id must be an eligible agency or the whole request is refused and nothing is written. Repeats collapse rather than erroring. The bound of 2000 is generous because a whole-roster save has to fit in one request.
confirmation_textRequired, and must be exactly 'CLEAR', only when contact_ids is empty -- clearing the selection stops DBCS file generation entirely, so it is never an accidental empty list. Ignored outright when contact_ids is non-empty.
save_selected_agencies › Responses
successIndicates if the request was successful.
Empty on success. On a refusal this is an object keyed by field, and it always carries contact_ids with one human-readable sentence naming every offending id. It additionally carries exactly one of the structured keys below, which a UI can act on without parsing that sentence. Validation is all-or-nothing and runs before the write, so a refused request stores nothing.
search_agencies
Return one page of the eligible agency roster, flagged for the picker.
Code
search_agencies › Request Body
search_textCase-insensitive substring match against contacts.name OR contacts.agencyNumber. Null or omitted returns the whole eligible roster. Bounded at 250 because contacts.name is VARCHAR(250): a longer term cannot match either column.
page1-based page number. Bounded because it becomes the query's OFFSET, and an unbounded offset costs the same scan however far it walks. A page past the last one is not an error: it returns an empty agencies list with the real total_count.
page_sizeRows per page. 25 is both the default and the maximum; a larger value is refused rather than clamped.
search_agencies › Responses
successIndicates if the request was successful.
Any messages or errors related to the request.
submit_build
Admit and enqueue a DBCS build for one completed calendar month.
Code
submit_build › Request Body
yearFour-digit calendar year of the report month.
monthCalendar month of the report month, 1-12.
acknowledged_unverified_monthRequired true for a month older than last month, whose commission checkpoint is not checked. Ignored for last month. Acknowledgement alone is not enough: the month must still have commission payments.
submit_build › Responses
successWhether the request itself succeeded. False with messages.refusal_code on an admission refusal.
Empty on success. On a refusal: an object with refusal_code plus one sentence under the field the refusal is about.
