Skip to main content
POST
/
public
/
v1
/
recurring
/
invoices
/
Create RecurringInvoice record
curl --request POST \
  --url https://api.dualentry.com/public/v1/recurring/invoices/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "rrule": "<string>",
  "memo": "<string>",
  "name": "<string>",
  "date": "2023-12-25",
  "company_id": 123,
  "record_payload": {
    "date": "2023-12-25",
    "transaction_date": "2023-12-25",
    "bill_to_address": "",
    "ship_to_address": "",
    "billing_address": {
      "street": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "state": "",
      "country": "",
      "second_line": "",
      "name": "<string>"
    },
    "shipping_address": {
      "street": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "state": "",
      "country": "",
      "second_line": "",
      "name": "<string>"
    },
    "custom_fields": [
      {}
    ],
    "items": [
      {
        "item_id": 123,
        "quantity": 123,
        "rate": 123,
        "position": 123,
        "memo": "<string>",
        "discount_value": 123,
        "discount_account_id": 123,
        "record_level_discount_amount": 123,
        "tax": {
          "code": "<string>",
          "rate": 123,
          "amount": 123,
          "is_taxable": true,
          "tax_exempt_amount": 123,
          "vat_rate_id": 123,
          "gst_tax_rate_id": 123
        },
        "id": 123,
        "classifications": [],
        "company_id": 123
      }
    ],
    "discount_value": 123,
    "memo": "<string>",
    "due_date": "2023-12-25",
    "company_id": 123,
    "customer_id": 123,
    "exchange_rate": 123,
    "sales_order_id": 123,
    "record_status": "posted",
    "attachments": [],
    "contracted": false,
    "contract_id": 123,
    "term_id": 123,
    "reference_number": "",
    "ar_account_id": 123,
    "payment": {
      "type": "<string>",
      "id": 123,
      "body": "<string>",
      "link": "<string>"
    }
  }
}
'
import requests

url = "https://api.dualentry.com/public/v1/recurring/invoices/"

payload = {
    "rrule": "<string>",
    "memo": "<string>",
    "name": "<string>",
    "date": "2023-12-25",
    "company_id": 123,
    "record_payload": {
        "date": "2023-12-25",
        "transaction_date": "2023-12-25",
        "bill_to_address": "",
        "ship_to_address": "",
        "billing_address": {
            "street": "<string>",
            "city": "<string>",
            "postal_code": "<string>",
            "state": "",
            "country": "",
            "second_line": "",
            "name": "<string>"
        },
        "shipping_address": {
            "street": "<string>",
            "city": "<string>",
            "postal_code": "<string>",
            "state": "",
            "country": "",
            "second_line": "",
            "name": "<string>"
        },
        "custom_fields": [{}],
        "items": [
            {
                "item_id": 123,
                "quantity": 123,
                "rate": 123,
                "position": 123,
                "memo": "<string>",
                "discount_value": 123,
                "discount_account_id": 123,
                "record_level_discount_amount": 123,
                "tax": {
                    "code": "<string>",
                    "rate": 123,
                    "amount": 123,
                    "is_taxable": True,
                    "tax_exempt_amount": 123,
                    "vat_rate_id": 123,
                    "gst_tax_rate_id": 123
                },
                "id": 123,
                "classifications": [],
                "company_id": 123
            }
        ],
        "discount_value": 123,
        "memo": "<string>",
        "due_date": "2023-12-25",
        "company_id": 123,
        "customer_id": 123,
        "exchange_rate": 123,
        "sales_order_id": 123,
        "record_status": "posted",
        "attachments": [],
        "contracted": False,
        "contract_id": 123,
        "term_id": 123,
        "reference_number": "",
        "ar_account_id": 123,
        "payment": {
            "type": "<string>",
            "id": 123,
            "body": "<string>",
            "link": "<string>"
        }
    }
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    rrule: '<string>',
    memo: '<string>',
    name: '<string>',
    date: '2023-12-25',
    company_id: 123,
    record_payload: {
      date: '2023-12-25',
      transaction_date: '2023-12-25',
      bill_to_address: '',
      ship_to_address: '',
      billing_address: {
        street: '<string>',
        city: '<string>',
        postal_code: '<string>',
        state: '',
        country: '',
        second_line: '',
        name: '<string>'
      },
      shipping_address: {
        street: '<string>',
        city: '<string>',
        postal_code: '<string>',
        state: '',
        country: '',
        second_line: '',
        name: '<string>'
      },
      custom_fields: [{}],
      items: [
        {
          item_id: 123,
          quantity: 123,
          rate: 123,
          position: 123,
          memo: '<string>',
          discount_value: 123,
          discount_account_id: 123,
          record_level_discount_amount: 123,
          tax: {
            code: '<string>',
            rate: 123,
            amount: 123,
            is_taxable: true,
            tax_exempt_amount: 123,
            vat_rate_id: 123,
            gst_tax_rate_id: 123
          },
          id: 123,
          classifications: [],
          company_id: 123
        }
      ],
      discount_value: 123,
      memo: '<string>',
      due_date: '2023-12-25',
      company_id: 123,
      customer_id: 123,
      exchange_rate: 123,
      sales_order_id: 123,
      record_status: 'posted',
      attachments: [],
      contracted: false,
      contract_id: 123,
      term_id: 123,
      reference_number: '',
      ar_account_id: 123,
      payment: {type: '<string>', id: 123, body: JSON.stringify('<string>'), link: '<string>'}
    }
  })
};

fetch('https://api.dualentry.com/public/v1/recurring/invoices/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dualentry.com/public/v1/recurring/invoices/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'rrule' => '<string>',
    'memo' => '<string>',
    'name' => '<string>',
    'date' => '2023-12-25',
    'company_id' => 123,
    'record_payload' => [
        'date' => '2023-12-25',
        'transaction_date' => '2023-12-25',
        'bill_to_address' => '',
        'ship_to_address' => '',
        'billing_address' => [
                'street' => '<string>',
                'city' => '<string>',
                'postal_code' => '<string>',
                'state' => '',
                'country' => '',
                'second_line' => '',
                'name' => '<string>'
        ],
        'shipping_address' => [
                'street' => '<string>',
                'city' => '<string>',
                'postal_code' => '<string>',
                'state' => '',
                'country' => '',
                'second_line' => '',
                'name' => '<string>'
        ],
        'custom_fields' => [
                [
                                
                ]
        ],
        'items' => [
                [
                                'item_id' => 123,
                                'quantity' => 123,
                                'rate' => 123,
                                'position' => 123,
                                'memo' => '<string>',
                                'discount_value' => 123,
                                'discount_account_id' => 123,
                                'record_level_discount_amount' => 123,
                                'tax' => [
                                                                'code' => '<string>',
                                                                'rate' => 123,
                                                                'amount' => 123,
                                                                'is_taxable' => true,
                                                                'tax_exempt_amount' => 123,
                                                                'vat_rate_id' => 123,
                                                                'gst_tax_rate_id' => 123
                                ],
                                'id' => 123,
                                'classifications' => [
                                                                
                                ],
                                'company_id' => 123
                ]
        ],
        'discount_value' => 123,
        'memo' => '<string>',
        'due_date' => '2023-12-25',
        'company_id' => 123,
        'customer_id' => 123,
        'exchange_rate' => 123,
        'sales_order_id' => 123,
        'record_status' => 'posted',
        'attachments' => [
                
        ],
        'contracted' => false,
        'contract_id' => 123,
        'term_id' => 123,
        'reference_number' => '',
        'ar_account_id' => 123,
        'payment' => [
                'type' => '<string>',
                'id' => 123,
                'body' => '<string>',
                'link' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dualentry.com/public/v1/recurring/invoices/"

	payload := strings.NewReader("{\n  \"rrule\": \"<string>\",\n  \"memo\": \"<string>\",\n  \"name\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"company_id\": 123,\n  \"record_payload\": {\n    \"date\": \"2023-12-25\",\n    \"transaction_date\": \"2023-12-25\",\n    \"bill_to_address\": \"\",\n    \"ship_to_address\": \"\",\n    \"billing_address\": {\n      \"street\": \"<string>\",\n      \"city\": \"<string>\",\n      \"postal_code\": \"<string>\",\n      \"state\": \"\",\n      \"country\": \"\",\n      \"second_line\": \"\",\n      \"name\": \"<string>\"\n    },\n    \"shipping_address\": {\n      \"street\": \"<string>\",\n      \"city\": \"<string>\",\n      \"postal_code\": \"<string>\",\n      \"state\": \"\",\n      \"country\": \"\",\n      \"second_line\": \"\",\n      \"name\": \"<string>\"\n    },\n    \"custom_fields\": [\n      {}\n    ],\n    \"items\": [\n      {\n        \"item_id\": 123,\n        \"quantity\": 123,\n        \"rate\": 123,\n        \"position\": 123,\n        \"memo\": \"<string>\",\n        \"discount_value\": 123,\n        \"discount_account_id\": 123,\n        \"record_level_discount_amount\": 123,\n        \"tax\": {\n          \"code\": \"<string>\",\n          \"rate\": 123,\n          \"amount\": 123,\n          \"is_taxable\": true,\n          \"tax_exempt_amount\": 123,\n          \"vat_rate_id\": 123,\n          \"gst_tax_rate_id\": 123\n        },\n        \"id\": 123,\n        \"classifications\": [],\n        \"company_id\": 123\n      }\n    ],\n    \"discount_value\": 123,\n    \"memo\": \"<string>\",\n    \"due_date\": \"2023-12-25\",\n    \"company_id\": 123,\n    \"customer_id\": 123,\n    \"exchange_rate\": 123,\n    \"sales_order_id\": 123,\n    \"record_status\": \"posted\",\n    \"attachments\": [],\n    \"contracted\": false,\n    \"contract_id\": 123,\n    \"term_id\": 123,\n    \"reference_number\": \"\",\n    \"ar_account_id\": 123,\n    \"payment\": {\n      \"type\": \"<string>\",\n      \"id\": 123,\n      \"body\": \"<string>\",\n      \"link\": \"<string>\"\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.dualentry.com/public/v1/recurring/invoices/")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rrule\": \"<string>\",\n  \"memo\": \"<string>\",\n  \"name\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"company_id\": 123,\n  \"record_payload\": {\n    \"date\": \"2023-12-25\",\n    \"transaction_date\": \"2023-12-25\",\n    \"bill_to_address\": \"\",\n    \"ship_to_address\": \"\",\n    \"billing_address\": {\n      \"street\": \"<string>\",\n      \"city\": \"<string>\",\n      \"postal_code\": \"<string>\",\n      \"state\": \"\",\n      \"country\": \"\",\n      \"second_line\": \"\",\n      \"name\": \"<string>\"\n    },\n    \"shipping_address\": {\n      \"street\": \"<string>\",\n      \"city\": \"<string>\",\n      \"postal_code\": \"<string>\",\n      \"state\": \"\",\n      \"country\": \"\",\n      \"second_line\": \"\",\n      \"name\": \"<string>\"\n    },\n    \"custom_fields\": [\n      {}\n    ],\n    \"items\": [\n      {\n        \"item_id\": 123,\n        \"quantity\": 123,\n        \"rate\": 123,\n        \"position\": 123,\n        \"memo\": \"<string>\",\n        \"discount_value\": 123,\n        \"discount_account_id\": 123,\n        \"record_level_discount_amount\": 123,\n        \"tax\": {\n          \"code\": \"<string>\",\n          \"rate\": 123,\n          \"amount\": 123,\n          \"is_taxable\": true,\n          \"tax_exempt_amount\": 123,\n          \"vat_rate_id\": 123,\n          \"gst_tax_rate_id\": 123\n        },\n        \"id\": 123,\n        \"classifications\": [],\n        \"company_id\": 123\n      }\n    ],\n    \"discount_value\": 123,\n    \"memo\": \"<string>\",\n    \"due_date\": \"2023-12-25\",\n    \"company_id\": 123,\n    \"customer_id\": 123,\n    \"exchange_rate\": 123,\n    \"sales_order_id\": 123,\n    \"record_status\": \"posted\",\n    \"attachments\": [],\n    \"contracted\": false,\n    \"contract_id\": 123,\n    \"term_id\": 123,\n    \"reference_number\": \"\",\n    \"ar_account_id\": 123,\n    \"payment\": {\n      \"type\": \"<string>\",\n      \"id\": 123,\n      \"body\": \"<string>\",\n      \"link\": \"<string>\"\n    }\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.dualentry.com/public/v1/recurring/invoices/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"rrule\": \"<string>\",\n  \"memo\": \"<string>\",\n  \"name\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"company_id\": 123,\n  \"record_payload\": {\n    \"date\": \"2023-12-25\",\n    \"transaction_date\": \"2023-12-25\",\n    \"bill_to_address\": \"\",\n    \"ship_to_address\": \"\",\n    \"billing_address\": {\n      \"street\": \"<string>\",\n      \"city\": \"<string>\",\n      \"postal_code\": \"<string>\",\n      \"state\": \"\",\n      \"country\": \"\",\n      \"second_line\": \"\",\n      \"name\": \"<string>\"\n    },\n    \"shipping_address\": {\n      \"street\": \"<string>\",\n      \"city\": \"<string>\",\n      \"postal_code\": \"<string>\",\n      \"state\": \"\",\n      \"country\": \"\",\n      \"second_line\": \"\",\n      \"name\": \"<string>\"\n    },\n    \"custom_fields\": [\n      {}\n    ],\n    \"items\": [\n      {\n        \"item_id\": 123,\n        \"quantity\": 123,\n        \"rate\": 123,\n        \"position\": 123,\n        \"memo\": \"<string>\",\n        \"discount_value\": 123,\n        \"discount_account_id\": 123,\n        \"record_level_discount_amount\": 123,\n        \"tax\": {\n          \"code\": \"<string>\",\n          \"rate\": 123,\n          \"amount\": 123,\n          \"is_taxable\": true,\n          \"tax_exempt_amount\": 123,\n          \"vat_rate_id\": 123,\n          \"gst_tax_rate_id\": 123\n        },\n        \"id\": 123,\n        \"classifications\": [],\n        \"company_id\": 123\n      }\n    ],\n    \"discount_value\": 123,\n    \"memo\": \"<string>\",\n    \"due_date\": \"2023-12-25\",\n    \"company_id\": 123,\n    \"customer_id\": 123,\n    \"exchange_rate\": 123,\n    \"sales_order_id\": 123,\n    \"record_status\": \"posted\",\n    \"attachments\": [],\n    \"contracted\": false,\n    \"contract_id\": 123,\n    \"term_id\": 123,\n    \"reference_number\": \"\",\n    \"ar_account_id\": 123,\n    \"payment\": {\n      \"type\": \"<string>\",\n      \"id\": 123,\n      \"body\": \"<string>\",\n      \"link\": \"<string>\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "internal_id": 123,
  "number": 123,
  "name": "<string>",
  "memo": "<string>",
  "date": "2023-12-25",
  "company_id": 123,
  "company_name": "<string>",
  "company_currency": "<string>",
  "record_payload": "<unknown>",
  "rrule": "<string>",
  "next_occurrence": "2023-11-07T05:31:56Z",
  "last_generated": "2023-11-07T05:31:56Z",
  "records": [
    {
      "internal_id": 123,
      "number": 123,
      "date": "2023-12-25",
      "amount": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": {
    "actor_type": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "updated_by": {
    "actor_type": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}
{
  "errors": {},
  "success": false
}
{
  "errors": {},
  "success": false
}
{
  "errors": {},
  "success": false
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
rrule
string<rrule>
required

Recurrence rule in iCalendar RRULE format (RFC 5545)

Required string length: 8 - 500
Pattern: ^FREQ=(DAILY|WEEKLY|MONTHLY|YEARLY)(?:;.*)?$
Examples:

"FREQ=DAILY"

"FREQ=WEEKLY;BYDAY=MO,WE,FR"

"FREQ=MONTHLY;BYMONTHDAY=15"

"FREQ=YEARLY;BYMONTH=12;BYMONTHDAY=25"

"FREQ=MONTHLY;BYDAY=1MO"

"FREQ=WEEKLY;INTERVAL=2;BYDAY=TU,TH"

"FREQ=MONTHLY;BYMONTHDAY=1;COUNT=12"

"FREQ=DAILY;UNTIL=20241231T235959Z"

"FREQ=WEEKLY;WKST=SU;BYDAY=MO,TU,WE,TH,FR"

​
memo
string
required
​
name
string
required
​
date
string<date>
required
​
company_id
integer
required
​
status
enum<string>
required
Available options:
active,
inactive
​
recurring_type
enum<string>
required
Available options:
automatic,
reminder
​
record_payload
PublicInvoiceSchemaCreateIn · object
required

Response

OK

​
internal_id
integer
required
​
number
integer
required
​
name
string
required
​
memo
string
required
​
date
string<date>
required
​
company_id
integer
required
​
company_name
string
required
​
company_currency
string
required
​
status
enum<string>
required
Available options:
active,
inactive
​
record_payload
any
required
​
rrule
string
required
​
next_occurrence
string<date-time> | null
required
​
last_generated
string<date-time> | null
required
​
recurring_type
enum<string>
required
Available options:
automatic,
reminder
​
records
PublicRecurringRecordSchemaOut · object[]
required
​
created_at
string<date-time>
required

Date and time the record was created

​
updated_at
string<date-time>
required

Date and time the record was last updated

​
created_by
AuditActorSchemaOut · object | null

Schema for audit actor information.

​
updated_by
AuditActorSchemaOut · object | null

Schema for audit actor information.

Last modified on July 13, 2026