Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

The distribution node contains information on how the invoice document is accessible to different parties, how the invoice shall be distributed, aggregated and more.

access

Indicates how the client or the supplier can access the invoice document:

  • NotPublished : Not accessible

  • PublishedReadOnly : Accessible but viewing only

  • PublishedReadWrite : Accessible and properties and totals can be edited.

string

distributeEmail

Indicates the status of distribution of invoice by email:

  • NotRequired : Distribution by email is not required by default.

  • TransmissionRequired : Distribution by email is not required by default.

  • TransmissionSuccess : Sent by email with success

  • TransmissionFailed : Sent by email but with failure

Note that the Wordbee Translator Invoice Production tools permit to distribute invoices by expected channel. Email transmission is done automatically with Wordbee functionality.

string

distributePrint

Indicates the status of distribution of invoice by print or non-Wordbee channels:

  • NotRequired : Distribution by print is not required by default.

  • TransmissionRequired : Distribution by print is not required by default.

  • TransmissionSuccess : Sent by print with success

  • TransmissionFailed : Sent by print but with failure

string

variant

The variant in the invoice & quote template to use for generating the Excel or PDF document. See the online documentation on how to create a multi-variant template and assign this to clients or suppliers.

int

doAggregate

Indicates if this invoice is supposed to be aggregated and not be sent as an individual document.

bool

EXAMPLES

Example payload:

{
    "access": "PublishedReadOnly",
    "distributeEmail": "TransmissionRequired",
    "distributePrint": "TransmissionRequired",
    "variant": 0,
    "doAggregate": true
}

  • No labels