Financials
Financial Docs

Upload a financial statement document

for each file to be uploaded, the user must provide an external customer id in the request headers.

x-accend-external-customer-Id: the external customer id for the customer the file belongs to

x-accend-customer-Id: the customer id in our system for the customer the file belongs to

x-accend-asset-Id: the asset id in our system for the asset the file belongs to

one of x-accend-external-customer-Id or x-accend-customer-id or x-accend-asset-id must be provided in the headers.

If multiple are provided, x-accend-external-customer-id will be used, then x-accend-customer-id, then x-accend-asset-id.

Supported formats: PDF, XLSX, and legacy XLS. CSV is not currently accepted on this endpoint and will return 400 Invalid file format. XLS files are converted to XLSX before storage.

Extensions and content types: The filename must end in .pdf, .xlsx, or .xls (case insensitive). Set the multipart part's Content-Type to the matching standard value:

  • PDF: application/pdf
  • XLSX: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
  • XLS: application/vnd.ms-excel

application/octet-stream also works; we fall back to the extension. Avoid non-standard types such as application/x-pdf, and don't label an .xlsx file as application/vnd.ms-excel.

Other requirements: The request must be under 150MB. Password-protected PDFs need the password in the x-accend-pdf-password header.

post/api/v1/financials/upload

Request

  • Base URL: https://api.withaccend.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.withaccend.com/api/v1/financials/upload
  • Auth: none declared. Required headers: headers, content-length

Headers

x_accend_idempotency_keystring required

Idempotency key for the document (max 255 characters)

x_accend_customer_idstring nullable

Customer ID in our system for the customer the case belongs to, one of customer_id or external_customer_id or asset_id is required

x_accend_asset_idstring nullable

Asset ID in our system for the asset the case belongs to, one of asset_id or external_customer_id or customer_id is required

x_accend_external_customer_idstring nullable

external customer id for the customer the case belongs to, one of customer_id or external_customer_id or asset_id is required

x_accend_pdf_passwordstring nullable

Password to unlock the PDF document

content-lengthinteger required

Response

Successful Response

document_idstring required

Document ID in our system

file_namestring required

File name of the document

idempotency_keystring required

Idempotency key for the document (max 255 characters)

Changes

No recorded changes to this operation across all 1 revision of this API.