Module billecta::contract_invoice

Contract invoice

Contract invoices are recurring invoices to the same customer with the same invoice records and amounts. Using contract invoice you create an invoice definition and intervals of when it should be triggered. The create invoice trigger is executed a new invoice from the contract invoice is made and put among invoices (either as a draft/unattested or also auto attested by the system depending on the configuration on the contract invoice. The trigger is automatically managed by Billecta and made right after midnight. If a contract invoice is created after midnight it will not be triggered until the day after as long as next trigger/run date is today or earlier. Contract invoices also support invoice rows that are in the future also rows that should automatically be phased out after a certain date.

Functions

• comment_a_contract_invoice
• create_a_contract_invoice
  Create a new contract invoice. Response is the public id you will use when retrieving it again or performing actions on the contract invoice in the API.
• create_half_year_recurring_autogiro_contract_invoice
  Create a new contract invoice set to half year recurring. Create debtor with autogiro enabled. Response is the public id you will use when retrieving it again or performing actions on the contract invoice in the API.
• create_monthly_recurring_autogiro_contract_invoice
  Create a new contract invoice set to monthly recurring. Create debtor with autogiro enabled. Response is the public id you will use when retrieving it again or performing actions on the contract invoice in the API.
• create_yearly_recurring_autogiro_contract_invoice
  Create a new contract invoice set to yearly recurring. Create debtor with autogiro enabled. Response is the public id you will use when retrieving it again or performing actions on the contract invoice in the API.
• delete_a_contract_invoice
  Deletes a contract invoice. Please note that a contract invoice can’t be deleted if at least on invoice is generated from it. Pause it (equal to disabling it) if it shall not be used anymore. You will get a 400 Bad Request it you try to delete a contract invoice that has been triggered at least once.
• generate_a_new_invoice_from_a_contract_invoice
  Creates a new invoice with the contract invoice as template. The response is the public id of the newly created invoice and the new invoice is retrieved using the Invoice endpoints.
• get_a_contract_invoice
  Get a contract invoice based on the public id number that contract invoice was assigned when created.
• get_all_contract_invoices
  Get all contract invoices for all debtors/customers
• get_all_contract_invoices_to_a_debtor
  Get all contract invoices that to the specified debtor/customer
• get_invoices_generated_from_contract_invoice
  Gets all generated invoices by this contract invoice.
• move_next_run
  Skips or reverts a contract invoice so that it is ‘not triggered’/‘retriggered’ on the next run depending on recurring period setup. Please note that if you revert multiple steps to a date that is multiple periods earlier than current date, then the contract invoice will execute that many numbers of times until next step is after current date.
• pause_disables_a_contract_invoice
  Pauses/Disables a contract invoice from automatically creating new invoices each triggered period
• preview_a_contract_invoice
  Preview a contract invoice to view how it will be generated when the next period is triggered. This endpoint previews data already stored in API/database
• preview_a_contract_invoice_post
  Preview a contract invoice to view how it will be generated when the next period is triggered. This endpoint previews data sent in the request and ignores data stored in the API/database.
• resume_a_contract_invoice
  Resumes/Enables a contract invoice to automatically create new invoices when each period is triggered.
• update_a_contract_invoice