INinvoiceninja
recurring_expenses

Adds a recurring expense

Changed on

Adds a recurring expense to a company

post/api/v1/recurring_expenses

Request

Query parameters

includestring
Example:first_load

Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes

Headers

X-API-TOKENstring required
Example:TOKEN

The API token to be used for authentication

X-Requested-Withstring required
Example:XMLHttpRequest

Used to send the XMLHttpRequest header

Response

Returns the saved recurring expense object

idstring

The hashed id of the recurring expense

user_idstring

The hashed id of the user who created the recurring expense

assigned_user_idstring

The hashed id of the user assigned to this recurring expense

client_idstring

The hashed id of the client

invoice_idstring

The hashed id of the invoice

bank_idstring

The id of the bank associated with this recurring expense

invoice_currency_idstring

The currency id of the invoice associated with this recurring expense

expense_currency_idstring

The currency id of the expense associated with this recurring expense

invoice_category_idstring

The category id of the invoice

payment_type_idstring

The payment type id

private_notesstring

The recurring expense private notes

public_notesstring

The recurring expense public notes

transaction_referencestring

The recurring expense transaction reference

transcation_idstring

The transaction id of the recurring expense

custom_value1string

Custom value field

custom_value2string

Custom value field

custom_value3string

Custom value field

custom_value4string

Custom value field

tax_name1string

The tax name

tax_name2string

The tax name

tax_rate1number float

The tax rate

tax_rate2number float

The tax rate

tax_name3string

The tax name

tax_rate3number float

The tax rate

amountnumber float

The total amount of the recurring expense

frequency_idnumber

The frequency this recurring expense fires

remaining_cyclesnumber

The number of remaining cycles for this recurring expense

foreign_amountnumber float

The foreign currency amount of the recurring expense

exchange_ratenumber float

The exchange rate for the expernse

datestring

The date of the expense

payment_datestring

The date the expense was paid

should_be_invoicedboolean

Boolean flag determining if the expense should be invoiced

is_deletedboolean

Boolean flag determining if the recurring expense is deleted

last_sent_datestring date

The Date it was sent last

next_send_datestring date

The next send date

invoice_documentsboolean

Boolean flag determining if the documents associated with this expense should be passed onto the invoice if it is converted to an invoice

updated_atnumber

Timestamp

archived_atnumber

Timestamp

calculate_tax_by_amountboolean

Flag indicating whether to calculate tax based on amount rather than percentage

category_idstring

The unique identifier of the expense category

currency_idstring

The unique identifier of the currency

next_send_date_clientstring date

The next scheduled send date for the client

numberstring

The unique number assigned to this recurring expense

project_idstring

The unique identifier of the project associated with this recurring expense

tax_amount1number float

The amount of the first tax

tax_amount2number float

The amount of the second tax

tax_amount3number float

The amount of the third tax

transaction_idstring

The unique identifier of the transaction

uses_inclusive_taxesboolean

Flag indicating whether taxes are included in the price

vendor_idstring

The unique identifier of the vendor associated with this recurring expense

Example response

{
  "id": "Opnel5aKBz",
  "user_id": "Opnel5aKBz",
  "assigned_user_id": "Opnel5aKBz",
  "client_id": "Opnel5aKBz",
  "invoice_id": "Opnel5aKBz",
  "bank_id": "22",
  "invoice_currency_id": "1",
  "expense_currency_id": "1",
  "invoice_category_id": "1",
  "payment_type_id": "1",
  "private_notes": "Private and confidential",
  "public_notes": "This is the best client in the world",
  "transaction_reference": "EXP-1223-2333",
  "transcation_id": "1233312312",
  "custom_value1": "$1000",
  "custom_value2": "2022-10-10",
  "custom_value3": "short text",
  "custom_value4": "very long text",
  "tax_name1": "GST",
  "tax_name2": "VAT",
  "tax_rate1": 10,
  "tax_rate2": 10,
  "tax_rate3": 10,
  "amount": 10,
  "frequency_id": 1,
  "remaining_cycles": 1,
  "foreign_amount": 10,
  "exchange_rate": 0.8,
  "should_be_invoiced": true,
  "is_deleted": true,
  "last_sent_date": "1994-07-30",
  "next_send_date": "1994-07-30",
  "invoice_documents": true,
  "updated_at": 1434342123,
  "archived_at": 1434342123,
  "calculate_tax_by_amount": true,
  "category_id": "Opnel5aKBz",
  "currency_id": "1",
  "next_send_date_client": "2024-12-31",
  "number": "RE-0001",
  "project_id": "Opnel5aKBz",
  "tax_amount1": 10,
  "tax_amount2": 5,
  "tax_amount3": 2.5,
  "transaction_id": "txn_1234567890",
  "uses_inclusive_taxes": true,
  "vendor_id": "Opnel5aKBz"
}

Changes

  • 69a36036d334Revision changes
    • info

      the response optional property became read-only for the status

  • 00ad5cc89fadRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status