Module billecta::invoice

Invoice

The following endpoints describes the invoice api calls. It is a self-standing section/ feature but has tight integrations with debt collection if you have access to those modules.

Functions

• attest_an_invoice
  Attesting an invoice means that it will be book kept and locked for editing. Invoice is automatically sent if any distribution is set.
• cancel_autogiro_withdrawal
  The autogiro withdrawal can be cancelled using this endpoint. Note that this can’t be done up to the day before the autogiro withdrawal date (day before due date)
• cancel_credit_card_payment
  The credit card payment can be cancelled if payment has not been completed yet.
• cancel_invoice_dispute
  Removed the invoice dispute flag which reenables all automatic events on the invoice again
• cancel_reminder_invoice
  Canceling the reminder invoice will also remove any added reminder fees to the invoice
• cancel_the_invoice_sales
  If invoice has not been accepted by purchaser the invoice sales can be cancelled and reverted.
• comment_an_invoice
  Writes a comment to the self invoice events log.
• create_a_verification_invoice
  A verification invoice is a pure bookkeeping event. You create the verification to write to the bookkeeping and have a ‘receipt’ on the invoice for tracking. It is automatically closed after creation.
• create_an_invoice
  All created invoices are saved and not attested. To make it permanent and bookkeep it, the invoice action must be attested.
• create_autogiro_withdrawal
  Creates an autogiro withdrawal on the latest of todays date or the invoice due date
• create_card_withdrawal
  Creates a card withdrawal on the latest of specified date (optional) or todays date or the invoice due date
• create_credit_card_payment_intent
  Make an credit card payment intent with the amount on the invoice.
• create_interest_invoice
  According to law an invoice sender has the right to invoice the lost interest on a due invoice. By calling this endpoint an interest invoice will be sent with only the interest generated between the from and to date. Note that Billecta doesn’t take consideration on the from and to date overlap with another reminder invoice with the same from and to date.
• credit_an_invoice_with_existing_credit_invoice
  A debit and credit invoice can be connected and balance each other out by this endpoint. If both have the same amount (the other one negative), then both will be closed. If one invoice has more amount than the other one, one of them will be closed and the other will have a current amount equal to the difference.
• delete_address_override_for_an_invoice
  Delete the overridden debtor address and uses the address from the debtor/customer card
• delete_an_invoice
  Only non-attested invoices can be deleted. Once attested it is locked and deletion is not allowed any more.
• dispute_an_invoice
  According to law a debtor/customer has the right to dispute an invoice (regardless reason). If such a knowledge is known to the customer no more automatic events are allowed to perform on the invoice (like sending it to debt collection)
• finance_the_invoice
  Finance the invoice to a specified sales contract. If no contract is specified and only one exists that invoice sale contract will be used.
• get_all_closed_invoices
  Retrieves all invoices that have a closed/full payment date between the specified from and to dates.
• get_all_closed_invoices_by_debtor_public_id
  Retrieves all invoices for a specific debtor that have a closed/full payment date between the specified from and to dates.
• get_all_closed_invoices_by_invoice_period
  Retrieves all closed invoices by invoice period.
• get_all_credit_card_payment_intents
  Gets all credit card payment intents for a given invoice
• get_all_events_for_all_invoices
• get_all_open_invoices
  Retrieves all drafts/attested and unpaid invoices.
• get_all_open_invoices_by_debtor_public_id
  Retrieves all open invoices for a specific debtor.
• get_all_open_invoices_by_invoice_period
  Retrieves all open invoices by invoice period.
• get_all_open_reminder_invoices
  Get all open reminder invoices. Use this endpoint to see which invoices have an active reminder
• get_an_invoice
  Returns an invoice based on the ActionPublicId. All invoices have a unique ActionPublicId that is generated on creation.
• get_an_invoice_by_invoice_number
  Returns an invoice based on the invoice number.
• get_reminder_invoice
  Invoice reminders can be sent using the Invoice/SendReminderInvoice endpoint. Call this endpoint to retrieve metadata about the reminder.
• load_archived_events
  Invoice events gets archived after one year. This reloads archived events to enable the events to be retrieved again. Observe that these events will be archived again after one day.
• mark_invoices_are_processed_for_rot
  Invoices where XML has been generated can be marked as processed and filtered/hidden when exporting XML for other invoices
• mark_invoices_are_processed_for_rut
  Invoices where XML has been generated can be marked as processed and filtered/hidden when exporting XML for other invoices
• pause_an_invoice
  Pauses the invoice from any more automatic events.
• postpone_next_event
  Postpones the next automatic event of an invoice. Note that it is only possible to postpone forward and not backwards
• postpone_next_event_date
  Postpones the next automatic event of an invoice. Note that it is only possible to postpone forward and not backwards
• preview_an_invoice
  Preview an invoice to view how it will be generated. This endpoint previews data already stored in API/database. This endpoint returns a PDF data stream in the content
• preview_an_invoice_post
  Preview an invoice to view how it will be generated. This endpoint previews data sent in the request and ignores data stored in the API/ database. This endpoint returns a PDF data stream in the content
• refund_credit_card_payment
  The credit card payment can be refunded if payment has been completed.
• refund_swish_payment
  The swish payment can be refunded if payment has been completed.
• register_payment_on_an_invoice
  Register an already received payment on the invoice that was not received through Billecta.
• resume_a_paused_invoice
  Resumes the self invoice to automatically process events.
• sell_the_invoice
  Sells the invoice to a purchaser according to specified sales contract. If no contract is specified and only one exists that invoice sale contract will be used.
• send_the_invoice
  Sends the invoice with the preferred delivery method. Note that omitting optional parameters will use pre-stored values on the invoice.
• send_the_reminder_invoice
  Creates and sends a reminder invoice for the invoice. Reminder fees and PDF:s will be added to the invoice.
• send_the_reminder_invoice_with_pregenerated_pdf
  Uses a already reminder PDF generated by you and sends it. Reminder fees and PDF:s will be added to the invoice.
• unmark_invoices_are_processed_for_rot
• unmark_invoices_are_processed_for_rut
• update_address_on_an_invoice
  Overrides the customer/debtor address and sets a temporary address for this invoice only
• update_an_invoice
  Note that only non-attested invoices can be updated. Once attested it is locked and update is not possible any more.