ReceivedDocuments

Get a new ReceivedDocument

Get a new ReceivedDocument that you have been notified for via received_document webhook.

get/received_documents/{guid}/{format}

Path parameters

guidstring uuid required

The guid of the document that was received. This is the "document_guid" property of the "received_document" webhook.

format'json' | 'original' required

The format in which to receive the received document.

Query parameters

versionstring

The JSON content version date. The default is '1970-01-01' meaning you get all deprecated elements since nothing was deprecated before that ;). If you do not want deprecated elements, use a later date. Do not use a dynamic date, because that means when we deprecate elements they will disappear from our responses. Only used for 'json' packaging, not for 'original'. Not currently used for invoices, only for orders.

Response

Success

legalEntityIdinteger

The id of the LegalEntity this document should be sent on behalf of or was received for.

direction'in' | 'out'

The direction of the document.

guidstring

The GUID of the document that was received

originalstring

The document as originally received. Process this as a blob. Only present if requested.

Changes

No recorded changes to this endpoint across all 4 revisions of this API.