Interface Export

Detailed information about the export.

Export

Export

interface Export {
    errorMessage?: string;
    exportId?: string;
    generateExportFinishedAt?: string;
    generateExportStartedAt?: string;
    invoicesDocumentIds?: string[];
    status?: ExportStatus;
}

Properties

errorMessage? exportId? generateExportFinishedAt? generateExportStartedAt? invoicesDocumentIds? status?

Properties

OptionalerrorMessage

errorMessage?: string

When the export generation fails, this attribute contains a description of the error.

Memberof

Export

OptionalexportId

exportId?: string

The export identifier.

Memberof

Export

OptionalgenerateExportFinishedAt

generateExportFinishedAt?: string

The date and time when the export generation finished. Vales are in ISO 8601 date-time format.

Memberof

Export

OptionalgenerateExportStartedAt

generateExportStartedAt?: string

The date and time when the export generation started. Values are in ISO 8601 date-time format.

Memberof

Export

OptionalinvoicesDocumentIds

invoicesDocumentIds?: string[]

The identifier for the export documents. To get the information required to retrieve the export document's contents, pass each ID in the getInvoicesDocument operation. This list is empty until the status is DONE.

Memberof

Export

Optionalstatus

status?: ExportStatus

Memberof

Export

Settings

Member Visibility

On This Page

Properties