v2

latestSwagger 2.02026-08-0138140265.1 KB
DocumentSubmissions

Submit a new document.

Submit a document for delivery.

post/document_submissions

Request body

legalEntityIdinteger

The id of the LegalEntity this document should be sent on behalf of. Either legalEntityId or forDocumentGuid is mandatory, unless the document type uses forDocumentSubmissionGuid instead.

receiveGuidstring

DEPRECATED. The GUID that was in the received_document webhook. Use forDocumentGuid instead.

forDocumentGuidstring

The GUID that was in the received_document webhook. Use this field for document types that refer to a received document, such as InvoiceResponse and OrderResponse. Provide forDocumentGuid instead of legalEntityId for those flows.

forDocumentSubmissionGuidstring

The GUID of an earlier DocumentSubmission that this submission refers to. For documentType=payment_received_notification, this must be the GUID of the original French invoice DocumentSubmission the payment notification is for. For this document type, provide forDocumentSubmissionGuid instead of legalEntityId or forDocumentGuid.

idempotencyGuidstring

A guid that you generated for this DocumentSubmission to achieve idempotency. If you submit multiple documents with the same idempotencyGuid, only the first one will be processed and any subsequent ones will trigger an HTTP 422 Unprocessable Entity response.

createPrimaryImageboolean

DEPRECATED. In the future we will no longer support creating PDF invoices. Whether or not to create a primary image (PDF) if one is not provided. For customers who started from April 1st 2023, the default is false. For customers who started before that, the default is true.

Response

Success

guidstring

A (V4) GUID for the document submission