Skip to main content

Tryton module for subscription

Project description

The sale subscription module defines subscription, services and recurrence rule models.

Subscription

A subscription defines how some recurring services are periodically invoiced. The invoice is generated based on the consumption of each services. Here is the extensive list of the fields:

  • Party: The customer.

  • Contact: The contact who placed the order.

  • Invoice Party: An optional different party to invoice.

  • Invoice Address: The invoice address of the customer.

  • Number: The internal reference of the subscription.

  • Reference: The optional external reference of the subscription.

  • Description: An optional description for the subscription.

  • Start Date: The date at which the subscription starts.

  • End Date: The optional end date of the subscription.

  • Invoice Start Date: The date at which the invoice starts to be generated.

  • Invoice Recurrence: The definition of the invoicing recurrence.

  • Payment Term: The payment term to apply on the invoices.

  • Currency: Define the currency to use for the subscription. All service prices will be computed accordingly.

  • Lines:

    • Service: A required reference to the service subscribed.

    • Description: The description of the service subscribed.

    • Consumption Recurrence: The optional recurrence of consumption of the service.

    • Quantity: The quantity consumed on each occurrence.

    • Unit: The unit of measure of the quantity.

    • Unit Price: The unit price of the service expressed in the currency of the subscription.

    • Start Date: An optional later start date than the subscription.

    • End Date: An optional earlier end date than the subscription.

  • States: The state of the subscription. May take one of the following values: Draft, Quotation, Running, Closed, Cancelled.

  • Company: The company which issue the sale order.

A running subscription can be modified by going back to draft and edit. Some field may not more be editable if the consumption has already started. The draft subscription is momentary stopped until it is set back to running.

The consumptions are created by schedulers or by a wizard. Idem for the creation of the invoices.

Service

A subscription service defines the default consumption of a product. It is composed of the fields:

  • Product: A product of type service.

  • Consumption Recurrence: The recurrence at which the service is consumed.

  • Consumption Delay: A delay to apply between the date the consumption is created and the date of the consumption.

Recurrence Rule

It defines combination of rules which compute the occurrence dates.

  • Name: The name of the rule.

  • Rules:

    • Exclusive: Define if the rule excludes the resulted dates.

    • Frequency: Daily, Weekly, Monthly, Yearly.

    • Interval: The interval of the frequency

    • By Week Day: Defines the list of weekdays where the recurrence will be applied.

    • By Month Day: Defines the list of month days to apply the recurrence to.

    • By Year Day: Defines the list of year days to apply the recurrence to.

    • By Week Number: Defines the list of week numbers (ISO8601) to apply the recurrence to.

    • By Month: Defines the list of months to apply the recurrence to.

    • By Position: Defines the list of occurrence positions.

    • Week Start Day.

The computation of occurrences is base on the python-dateutil library.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

trytond_sale_subscription-7.6.0.tar.gz (69.2 kB view details)

Uploaded Source

Built Distribution

trytond_sale_subscription-7.6.0-py3-none-any.whl (120.4 kB view details)

Uploaded Python 3

File details

Details for the file trytond_sale_subscription-7.6.0.tar.gz.

File metadata

File hashes

Hashes for trytond_sale_subscription-7.6.0.tar.gz
Algorithm Hash digest
SHA256 7623841565536c7f7841a958a2a87d2f0a9e661fd6d537ad1d05c32cdf1d355b
MD5 eecef5056323af9a609538c462932c1f
BLAKE2b-256 b2fef7c8c5680469badae8902f098733de24dd03821e9bbaafa33858752a26f9

See more details on using hashes here.

File details

Details for the file trytond_sale_subscription-7.6.0-py3-none-any.whl.

File metadata

File hashes

Hashes for trytond_sale_subscription-7.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4bd4964ee99aaf0bc2a3269593558cfd54faa794fe547b47ee55f5f3d70df471
MD5 06099a9940aa8b216de6b7a0014d62e6
BLAKE2b-256 69007d26afe67de763aa4ae4f24d788b6a1322a0d7a9d973c62d493232a3d18e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page