Generate Fiscal Documents

post

https://api.brinta.com/documents/fiscal-documents

Start an asynchronous generation of fiscal documents for the requesting company.

Send exactly one selection mode: start_date + end_date (period mode) or transactions (transactions mode). Sending both, or neither, is a 400. Returns a process id right away.

Both lists are capped at 50 items by default (DOCUMENTS_MAX_ITEMS_PER_REQUEST).

Get Fiscal Document Process, and see when status is completed or failed, then fetch each generated document with Get a Fiscal Document

Optionally, enable the webhook to be notified.

Body Params

start_date

date-time

Period mode. Start of the period, ISO 8601

end_date

date-time

Period mode. End of the period, ISO 8601

transactions

array of objects

length between 1 and 50

Transactions mode. Transactions to include. The period is derived from their invoice dates. Maximum 50 items by default (configurable per environment). A 400 lists any transaction that cannot be resolved

transactions

Provide id or external_id

string

Id of the transaction in Brinta's system

external_id

string

Id of the transaction on the client's system

counterpart_id

number

Period mode. Restrict generation to one counterpart company

certificate_date

date-time

Date to print on the certificates, ISO 8601

fiscal_document_type

string

enum

Generate only this type of fiscal document

external_id

string

Your own reference for this process. Use it later to fetch the process and the documents it generated

metadata

array of objects

length ≤ 50

Free-form items stored with the process and the generated documents (only from PAYMENT_ORDER)

metadata

201201

400Invalid request