Record actual statement cycle and transmission evidence

POST/facilities/{id}/billing-cycles

Path parameters

idstringRequired

Headers

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

ends_onstring · dateRequired

A business date, YYYY-MM-DD

periodstringRequired

referencestringRequired

sent_atstring · date-timeRequired

sha256stringRequired

starts_onstring · dateRequired

A business date, YYYY-MM-DD

Returns

200 OK

actorstringRequired

ends_onstring · dateRequired

A business date, YYYY-MM-DD

facility_idstringRequired

periodstringRequired

policyobjectRequired

10 child attributes

cycle_close_dayintegerRequired

expense_gl_codestringRequired

idstringRequired

interest_refund_roundingstringOptional

interest_refund_routestringOptional

max_claim_amountintegerRequired

product_codesarray of stringsRequired

resumption_grace_daysintegerRequired

suspend_all_interestbooleanRequired

timezonestringRequired

recorded_atstring · date-timeRequired

referencestringRequired

sent_atstring · date-timeRequired

sha256stringRequired

starts_onstring · dateRequired

A business date, YYYY-MM-DD

statementobjectRequired

FacilityStatement is a billing cycle on a facility.

14 child attributes

closing_amountintegerRequired

collectible_minimum_dueintegerRequired

collection_due_datestring · dateRequired

A business date, YYYY-MM-DD

due_datestring · dateRequired

A business date, YYYY-MM-DD

facility_idstringRequired

fees_amountintegerRequired

generated_atstring · date-time or nullOptional

interest_amountintegerRequired

minimum_due_amountintegerRequired

paid_amountintegerRequired

periodstringRequired

protected_amountintegerRequired

statement_datestring · dateRequired

A business date, YYYY-MM-DD

statusstringRequired

Open, paid, late

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503