Skip to main content

Query: getQuoteCharterAgreementDocument

Generates a Charter Agreement document for a quote realization. Automatically selects the first available template if no template is specified. Requires access to resource GRAPHQL_SALES_QUOTE_REQUEST_SEE. Requires access to given quote realization. Requires access to given quote realization leg

sales {
getQuoteCharterAgreementDocument(
quoteRealizationNid: QuoteRealizationNid!
documentTemplateNid: DocumentTemplateNid
quoteRealizationLegNids: [QuoteRealizationLegNid!]
): DocumentFileDataValueOrErrorList!
}

Arguments

getQuoteCharterAgreementDocument.quoteRealizationNid ● QuoteRealizationNid! non-null scalar

Quote realization identifier

getQuoteCharterAgreementDocument.documentTemplateNid ● DocumentTemplateNid scalar

Optional template identifier. If not provided, the first available published template is selected automatically. Template type must match quote realization: 'charter_agreement_sales' for regular quotes, 'charter_agreement_subcharter' for subcharter quotes.

getQuoteCharterAgreementDocument.quoteRealizationLegNids ● [QuoteRealizationLegNid!] list scalar

Optional list of quote realization leg identifiers to include in the document. If not provided, all legs from the quote realization will be included.

Type

DocumentFileDataValueOrErrorList union