JOjoinsophic
accounts

Create an account statement

Changed on

Creates a new statement

post/accounts/{account_id}/statements

Request

  • Base URL
    https://api.engine.usesophic.com
  • Auth
    HTTP bearer

Path parameters

account_idstring required

Request body

period_endstring date required

The end of the period to generate the statement for, exclusive.

period_startstring date required

The start of the period to generate the statement for, inclusive.

Example request

{
  "period_end": "2026-02-01",
  "period_start": "2026-01-01"
}

Response

Created

accountstring required

ID of the account the document belongs to.

content_typestring required

MIME type of the document content.

created_atstring date-time required

The timestamp (in ISO-8601 format) of when the resource was created.

document_type'welcome_letter' | 'order_confirmation' | 'fee_statement' | 'account_statement' required
filestring required

ID of the file containing the document.

idstring required

Unique resource identifier.

is_downloadableboolean required

Whether the document is available for download.

modified_atstring date-time required

The timestamp (in ISO-8601 format) of when the resource was last modified.

period_endstring date nullable required

End date of the period covered by the document.

period_startstring date nullable required

Start date of the period covered by the document.

referencestring nullable required

ID of the object this document evidences; the order an order confirmation confirms. Null for documents covering a period.

titlestring required

Document title.

Example response

{
  "period_end": "2026-03-31",
  "period_start": "2026-01-01",
  "reference": "ord_2eF9kQ7pXn"
}

Changes

  • 6a63920239d8Revision changes
    • breaking

      the response's property type changed from no type to string for status

    • warning

      added the new account_statement enum value to the response property for the response status

    • warning

      added the new fee_statement enum value to the response property for the response status

    • warning

      added the new order_confirmation enum value to the response property for the response status

    • warning

      added the new welcome_letter enum value to the response property for the response status

    • info

      removed from the response property allOf list for the response status

  • aa43bab6253cRevision changes
    • breaking

      response property context/additionalProperties/ list-of-types was widened by adding types array to media type application/json of response 400