Create RecurringJournalEntry record
curl --request POST \
--url https://api.dualentry.com/public/v3-alpha/recurring/journal-entries/ \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"rrule": "FREQ=DAILY",
"memo": "<string>",
"name": "<string>",
"date": "2023-12-25",
"company_id": 123,
"record_payload": {
"date": "2023-12-25",
"company_id": 123,
"items": [
{
"account_number": 123,
"debit": 123,
"credit": 123,
"position": 123,
"custom_fields": [
{}
],
"not_aging_eligible_reason": "",
"is_billable": false,
"billable_customer_id": 123,
"billable_project_id": 123,
"billable_markup_pct": 500,
"id": 123,
"memo": "",
"classifications": [],
"customer_id": 123,
"vendor_id": 123,
"eliminated": false
}
],
"transaction_date": "2023-12-25",
"custom_fields": [
{}
],
"memo": "<string>",
"reference_number": "<string>",
"exchange_rate": 123,
"reversal_date": "2023-12-25",
"reversal_aging_overrides": [
{
"original_line_id": 123,
"not_aging_eligible_reason": ""
}
],
"related_journal_entry_number": 123,
"accrual_template_id": 123,
"book_ids": [
123
],
"attachments": [],
"record_status": "posted",
"is_adjusting_entry": false
}
}
'import requests
url = "https://api.dualentry.com/public/v3-alpha/recurring/journal-entries/"
payload = {
"rrule": "FREQ=DAILY",
"memo": "<string>",
"name": "<string>",
"date": "2023-12-25",
"company_id": 123,
"record_payload": {
"date": "2023-12-25",
"company_id": 123,
"items": [
{
"account_number": 123,
"debit": 123,
"credit": 123,
"position": 123,
"custom_fields": [{}],
"not_aging_eligible_reason": "",
"is_billable": False,
"billable_customer_id": 123,
"billable_project_id": 123,
"billable_markup_pct": 500,
"id": 123,
"memo": "",
"classifications": [],
"customer_id": 123,
"vendor_id": 123,
"eliminated": False
}
],
"transaction_date": "2023-12-25",
"custom_fields": [{}],
"memo": "<string>",
"reference_number": "<string>",
"exchange_rate": 123,
"reversal_date": "2023-12-25",
"reversal_aging_overrides": [
{
"original_line_id": 123,
"not_aging_eligible_reason": ""
}
],
"related_journal_entry_number": 123,
"accrual_template_id": 123,
"book_ids": [123],
"attachments": [],
"record_status": "posted",
"is_adjusting_entry": False
}
}
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: 'FREQ=DAILY',
memo: '<string>',
name: '<string>',
date: '2023-12-25',
company_id: 123,
record_payload: {
date: '2023-12-25',
company_id: 123,
items: [
{
account_number: 123,
debit: 123,
credit: 123,
position: 123,
custom_fields: [{}],
not_aging_eligible_reason: '',
is_billable: false,
billable_customer_id: 123,
billable_project_id: 123,
billable_markup_pct: 500,
id: 123,
memo: '',
classifications: [],
customer_id: 123,
vendor_id: 123,
eliminated: false
}
],
transaction_date: '2023-12-25',
custom_fields: [{}],
memo: '<string>',
reference_number: '<string>',
exchange_rate: 123,
reversal_date: '2023-12-25',
reversal_aging_overrides: [{original_line_id: 123, not_aging_eligible_reason: ''}],
related_journal_entry_number: 123,
accrual_template_id: 123,
book_ids: [123],
attachments: [],
record_status: 'posted',
is_adjusting_entry: false
}
})
};
fetch('https://api.dualentry.com/public/v3-alpha/recurring/journal-entries/', 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/v3-alpha/recurring/journal-entries/",
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' => 'FREQ=DAILY',
'memo' => '<string>',
'name' => '<string>',
'date' => '2023-12-25',
'company_id' => 123,
'record_payload' => [
'date' => '2023-12-25',
'company_id' => 123,
'items' => [
[
'account_number' => 123,
'debit' => 123,
'credit' => 123,
'position' => 123,
'custom_fields' => [
[
]
],
'not_aging_eligible_reason' => '',
'is_billable' => false,
'billable_customer_id' => 123,
'billable_project_id' => 123,
'billable_markup_pct' => 500,
'id' => 123,
'memo' => '',
'classifications' => [
],
'customer_id' => 123,
'vendor_id' => 123,
'eliminated' => false
]
],
'transaction_date' => '2023-12-25',
'custom_fields' => [
[
]
],
'memo' => '<string>',
'reference_number' => '<string>',
'exchange_rate' => 123,
'reversal_date' => '2023-12-25',
'reversal_aging_overrides' => [
[
'original_line_id' => 123,
'not_aging_eligible_reason' => ''
]
],
'related_journal_entry_number' => 123,
'accrual_template_id' => 123,
'book_ids' => [
123
],
'attachments' => [
],
'record_status' => 'posted',
'is_adjusting_entry' => false
]
]),
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/v3-alpha/recurring/journal-entries/"
payload := strings.NewReader("{\n \"rrule\": \"FREQ=DAILY\",\n \"memo\": \"<string>\",\n \"name\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"company_id\": 123,\n \"record_payload\": {\n \"date\": \"2023-12-25\",\n \"company_id\": 123,\n \"items\": [\n {\n \"account_number\": 123,\n \"debit\": 123,\n \"credit\": 123,\n \"position\": 123,\n \"custom_fields\": [\n {}\n ],\n \"not_aging_eligible_reason\": \"\",\n \"is_billable\": false,\n \"billable_customer_id\": 123,\n \"billable_project_id\": 123,\n \"billable_markup_pct\": 500,\n \"id\": 123,\n \"memo\": \"\",\n \"classifications\": [],\n \"customer_id\": 123,\n \"vendor_id\": 123,\n \"eliminated\": false\n }\n ],\n \"transaction_date\": \"2023-12-25\",\n \"custom_fields\": [\n {}\n ],\n \"memo\": \"<string>\",\n \"reference_number\": \"<string>\",\n \"exchange_rate\": 123,\n \"reversal_date\": \"2023-12-25\",\n \"reversal_aging_overrides\": [\n {\n \"original_line_id\": 123,\n \"not_aging_eligible_reason\": \"\"\n }\n ],\n \"related_journal_entry_number\": 123,\n \"accrual_template_id\": 123,\n \"book_ids\": [\n 123\n ],\n \"attachments\": [],\n \"record_status\": \"posted\",\n \"is_adjusting_entry\": false\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/v3-alpha/recurring/journal-entries/")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"rrule\": \"FREQ=DAILY\",\n \"memo\": \"<string>\",\n \"name\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"company_id\": 123,\n \"record_payload\": {\n \"date\": \"2023-12-25\",\n \"company_id\": 123,\n \"items\": [\n {\n \"account_number\": 123,\n \"debit\": 123,\n \"credit\": 123,\n \"position\": 123,\n \"custom_fields\": [\n {}\n ],\n \"not_aging_eligible_reason\": \"\",\n \"is_billable\": false,\n \"billable_customer_id\": 123,\n \"billable_project_id\": 123,\n \"billable_markup_pct\": 500,\n \"id\": 123,\n \"memo\": \"\",\n \"classifications\": [],\n \"customer_id\": 123,\n \"vendor_id\": 123,\n \"eliminated\": false\n }\n ],\n \"transaction_date\": \"2023-12-25\",\n \"custom_fields\": [\n {}\n ],\n \"memo\": \"<string>\",\n \"reference_number\": \"<string>\",\n \"exchange_rate\": 123,\n \"reversal_date\": \"2023-12-25\",\n \"reversal_aging_overrides\": [\n {\n \"original_line_id\": 123,\n \"not_aging_eligible_reason\": \"\"\n }\n ],\n \"related_journal_entry_number\": 123,\n \"accrual_template_id\": 123,\n \"book_ids\": [\n 123\n ],\n \"attachments\": [],\n \"record_status\": \"posted\",\n \"is_adjusting_entry\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dualentry.com/public/v3-alpha/recurring/journal-entries/")
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\": \"FREQ=DAILY\",\n \"memo\": \"<string>\",\n \"name\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"company_id\": 123,\n \"record_payload\": {\n \"date\": \"2023-12-25\",\n \"company_id\": 123,\n \"items\": [\n {\n \"account_number\": 123,\n \"debit\": 123,\n \"credit\": 123,\n \"position\": 123,\n \"custom_fields\": [\n {}\n ],\n \"not_aging_eligible_reason\": \"\",\n \"is_billable\": false,\n \"billable_customer_id\": 123,\n \"billable_project_id\": 123,\n \"billable_markup_pct\": 500,\n \"id\": 123,\n \"memo\": \"\",\n \"classifications\": [],\n \"customer_id\": 123,\n \"vendor_id\": 123,\n \"eliminated\": false\n }\n ],\n \"transaction_date\": \"2023-12-25\",\n \"custom_fields\": [\n {}\n ],\n \"memo\": \"<string>\",\n \"reference_number\": \"<string>\",\n \"exchange_rate\": 123,\n \"reversal_date\": \"2023-12-25\",\n \"reversal_aging_overrides\": [\n {\n \"original_line_id\": 123,\n \"not_aging_eligible_reason\": \"\"\n }\n ],\n \"related_journal_entry_number\": 123,\n \"accrual_template_id\": 123,\n \"book_ids\": [\n 123\n ],\n \"attachments\": [],\n \"record_status\": \"posted\",\n \"is_adjusting_entry\": false\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>",
"status": "active",
"record_payload": "<unknown>",
"rrule": "<string>",
"next_occurrence": "2023-11-07T05:31:56Z",
"last_generated": "2023-11-07T05:31:56Z",
"errors": {},
"recurring_type": "automatic",
"records": [
{
"internal_id": 123,
"number": 123,
"date": "2023-12-25",
"amount": "<string>",
"record_status": "draft"
}
],
"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>",
"via": "<string>",
"agent_id": 123,
"agent_name": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
},
"updated_by": {
"actor_type": "<string>",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"via": "<string>",
"agent_id": 123,
"agent_name": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
},
"code": "<string>"
}{
"errors": {},
"success": false,
"error_code": "<string>",
"error_reason": "<string>"
}{
"errors": {},
"success": false,
"error_code": "<string>",
"error_reason": "<string>"
}{
"errors": {},
"success": false,
"error_code": "<string>",
"error_reason": "<string>"
}{
"errors": {},
"success": false,
"error_code": "<string>",
"error_reason": "<string>"
}Recurring Journal Entries
Create RecurringJournalEntry record
Create a new RecurringJournalEntry record with the provided data. Validates all required fields and business rules.
Side effects
- If a schedule date is already due, DualEntry can create records from this template in the same request.
Additional validations
- Your API key needs the create permission of the template’s record type, such as
invoice:createfor a recurring invoice, as well asrecurring:create. Without both permissions, the request returns403. - Fails with
422and error coderecurring_template_archived_partywhen the template uses an archived customer or vendor. - Fails with
503if the exchange rate for the transaction date is unavailable. - Fails with
422if a line has both adebitand acreditabove0, or a negativedebitorcredit.
POST
/
public
/
v3-alpha
/
recurring
/
journal-entries
/
Create RecurringJournalEntry record
curl --request POST \
--url https://api.dualentry.com/public/v3-alpha/recurring/journal-entries/ \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"rrule": "FREQ=DAILY",
"memo": "<string>",
"name": "<string>",
"date": "2023-12-25",
"company_id": 123,
"record_payload": {
"date": "2023-12-25",
"company_id": 123,
"items": [
{
"account_number": 123,
"debit": 123,
"credit": 123,
"position": 123,
"custom_fields": [
{}
],
"not_aging_eligible_reason": "",
"is_billable": false,
"billable_customer_id": 123,
"billable_project_id": 123,
"billable_markup_pct": 500,
"id": 123,
"memo": "",
"classifications": [],
"customer_id": 123,
"vendor_id": 123,
"eliminated": false
}
],
"transaction_date": "2023-12-25",
"custom_fields": [
{}
],
"memo": "<string>",
"reference_number": "<string>",
"exchange_rate": 123,
"reversal_date": "2023-12-25",
"reversal_aging_overrides": [
{
"original_line_id": 123,
"not_aging_eligible_reason": ""
}
],
"related_journal_entry_number": 123,
"accrual_template_id": 123,
"book_ids": [
123
],
"attachments": [],
"record_status": "posted",
"is_adjusting_entry": false
}
}
'import requests
url = "https://api.dualentry.com/public/v3-alpha/recurring/journal-entries/"
payload = {
"rrule": "FREQ=DAILY",
"memo": "<string>",
"name": "<string>",
"date": "2023-12-25",
"company_id": 123,
"record_payload": {
"date": "2023-12-25",
"company_id": 123,
"items": [
{
"account_number": 123,
"debit": 123,
"credit": 123,
"position": 123,
"custom_fields": [{}],
"not_aging_eligible_reason": "",
"is_billable": False,
"billable_customer_id": 123,
"billable_project_id": 123,
"billable_markup_pct": 500,
"id": 123,
"memo": "",
"classifications": [],
"customer_id": 123,
"vendor_id": 123,
"eliminated": False
}
],
"transaction_date": "2023-12-25",
"custom_fields": [{}],
"memo": "<string>",
"reference_number": "<string>",
"exchange_rate": 123,
"reversal_date": "2023-12-25",
"reversal_aging_overrides": [
{
"original_line_id": 123,
"not_aging_eligible_reason": ""
}
],
"related_journal_entry_number": 123,
"accrual_template_id": 123,
"book_ids": [123],
"attachments": [],
"record_status": "posted",
"is_adjusting_entry": False
}
}
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: 'FREQ=DAILY',
memo: '<string>',
name: '<string>',
date: '2023-12-25',
company_id: 123,
record_payload: {
date: '2023-12-25',
company_id: 123,
items: [
{
account_number: 123,
debit: 123,
credit: 123,
position: 123,
custom_fields: [{}],
not_aging_eligible_reason: '',
is_billable: false,
billable_customer_id: 123,
billable_project_id: 123,
billable_markup_pct: 500,
id: 123,
memo: '',
classifications: [],
customer_id: 123,
vendor_id: 123,
eliminated: false
}
],
transaction_date: '2023-12-25',
custom_fields: [{}],
memo: '<string>',
reference_number: '<string>',
exchange_rate: 123,
reversal_date: '2023-12-25',
reversal_aging_overrides: [{original_line_id: 123, not_aging_eligible_reason: ''}],
related_journal_entry_number: 123,
accrual_template_id: 123,
book_ids: [123],
attachments: [],
record_status: 'posted',
is_adjusting_entry: false
}
})
};
fetch('https://api.dualentry.com/public/v3-alpha/recurring/journal-entries/', 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/v3-alpha/recurring/journal-entries/",
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' => 'FREQ=DAILY',
'memo' => '<string>',
'name' => '<string>',
'date' => '2023-12-25',
'company_id' => 123,
'record_payload' => [
'date' => '2023-12-25',
'company_id' => 123,
'items' => [
[
'account_number' => 123,
'debit' => 123,
'credit' => 123,
'position' => 123,
'custom_fields' => [
[
]
],
'not_aging_eligible_reason' => '',
'is_billable' => false,
'billable_customer_id' => 123,
'billable_project_id' => 123,
'billable_markup_pct' => 500,
'id' => 123,
'memo' => '',
'classifications' => [
],
'customer_id' => 123,
'vendor_id' => 123,
'eliminated' => false
]
],
'transaction_date' => '2023-12-25',
'custom_fields' => [
[
]
],
'memo' => '<string>',
'reference_number' => '<string>',
'exchange_rate' => 123,
'reversal_date' => '2023-12-25',
'reversal_aging_overrides' => [
[
'original_line_id' => 123,
'not_aging_eligible_reason' => ''
]
],
'related_journal_entry_number' => 123,
'accrual_template_id' => 123,
'book_ids' => [
123
],
'attachments' => [
],
'record_status' => 'posted',
'is_adjusting_entry' => false
]
]),
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/v3-alpha/recurring/journal-entries/"
payload := strings.NewReader("{\n \"rrule\": \"FREQ=DAILY\",\n \"memo\": \"<string>\",\n \"name\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"company_id\": 123,\n \"record_payload\": {\n \"date\": \"2023-12-25\",\n \"company_id\": 123,\n \"items\": [\n {\n \"account_number\": 123,\n \"debit\": 123,\n \"credit\": 123,\n \"position\": 123,\n \"custom_fields\": [\n {}\n ],\n \"not_aging_eligible_reason\": \"\",\n \"is_billable\": false,\n \"billable_customer_id\": 123,\n \"billable_project_id\": 123,\n \"billable_markup_pct\": 500,\n \"id\": 123,\n \"memo\": \"\",\n \"classifications\": [],\n \"customer_id\": 123,\n \"vendor_id\": 123,\n \"eliminated\": false\n }\n ],\n \"transaction_date\": \"2023-12-25\",\n \"custom_fields\": [\n {}\n ],\n \"memo\": \"<string>\",\n \"reference_number\": \"<string>\",\n \"exchange_rate\": 123,\n \"reversal_date\": \"2023-12-25\",\n \"reversal_aging_overrides\": [\n {\n \"original_line_id\": 123,\n \"not_aging_eligible_reason\": \"\"\n }\n ],\n \"related_journal_entry_number\": 123,\n \"accrual_template_id\": 123,\n \"book_ids\": [\n 123\n ],\n \"attachments\": [],\n \"record_status\": \"posted\",\n \"is_adjusting_entry\": false\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/v3-alpha/recurring/journal-entries/")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"rrule\": \"FREQ=DAILY\",\n \"memo\": \"<string>\",\n \"name\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"company_id\": 123,\n \"record_payload\": {\n \"date\": \"2023-12-25\",\n \"company_id\": 123,\n \"items\": [\n {\n \"account_number\": 123,\n \"debit\": 123,\n \"credit\": 123,\n \"position\": 123,\n \"custom_fields\": [\n {}\n ],\n \"not_aging_eligible_reason\": \"\",\n \"is_billable\": false,\n \"billable_customer_id\": 123,\n \"billable_project_id\": 123,\n \"billable_markup_pct\": 500,\n \"id\": 123,\n \"memo\": \"\",\n \"classifications\": [],\n \"customer_id\": 123,\n \"vendor_id\": 123,\n \"eliminated\": false\n }\n ],\n \"transaction_date\": \"2023-12-25\",\n \"custom_fields\": [\n {}\n ],\n \"memo\": \"<string>\",\n \"reference_number\": \"<string>\",\n \"exchange_rate\": 123,\n \"reversal_date\": \"2023-12-25\",\n \"reversal_aging_overrides\": [\n {\n \"original_line_id\": 123,\n \"not_aging_eligible_reason\": \"\"\n }\n ],\n \"related_journal_entry_number\": 123,\n \"accrual_template_id\": 123,\n \"book_ids\": [\n 123\n ],\n \"attachments\": [],\n \"record_status\": \"posted\",\n \"is_adjusting_entry\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dualentry.com/public/v3-alpha/recurring/journal-entries/")
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\": \"FREQ=DAILY\",\n \"memo\": \"<string>\",\n \"name\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"company_id\": 123,\n \"record_payload\": {\n \"date\": \"2023-12-25\",\n \"company_id\": 123,\n \"items\": [\n {\n \"account_number\": 123,\n \"debit\": 123,\n \"credit\": 123,\n \"position\": 123,\n \"custom_fields\": [\n {}\n ],\n \"not_aging_eligible_reason\": \"\",\n \"is_billable\": false,\n \"billable_customer_id\": 123,\n \"billable_project_id\": 123,\n \"billable_markup_pct\": 500,\n \"id\": 123,\n \"memo\": \"\",\n \"classifications\": [],\n \"customer_id\": 123,\n \"vendor_id\": 123,\n \"eliminated\": false\n }\n ],\n \"transaction_date\": \"2023-12-25\",\n \"custom_fields\": [\n {}\n ],\n \"memo\": \"<string>\",\n \"reference_number\": \"<string>\",\n \"exchange_rate\": 123,\n \"reversal_date\": \"2023-12-25\",\n \"reversal_aging_overrides\": [\n {\n \"original_line_id\": 123,\n \"not_aging_eligible_reason\": \"\"\n }\n ],\n \"related_journal_entry_number\": 123,\n \"accrual_template_id\": 123,\n \"book_ids\": [\n 123\n ],\n \"attachments\": [],\n \"record_status\": \"posted\",\n \"is_adjusting_entry\": false\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>",
"status": "active",
"record_payload": "<unknown>",
"rrule": "<string>",
"next_occurrence": "2023-11-07T05:31:56Z",
"last_generated": "2023-11-07T05:31:56Z",
"errors": {},
"recurring_type": "automatic",
"records": [
{
"internal_id": 123,
"number": 123,
"date": "2023-12-25",
"amount": "<string>",
"record_status": "draft"
}
],
"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>",
"via": "<string>",
"agent_id": 123,
"agent_name": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
},
"updated_by": {
"actor_type": "<string>",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"via": "<string>",
"agent_id": 123,
"agent_name": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
},
"code": "<string>"
}{
"errors": {},
"success": false,
"error_code": "<string>",
"error_reason": "<string>"
}{
"errors": {},
"success": false,
"error_code": "<string>",
"error_reason": "<string>"
}{
"errors": {},
"success": false,
"error_code": "<string>",
"error_reason": "<string>"
}{
"errors": {},
"success": false,
"error_code": "<string>",
"error_reason": "<string>"
}Authorizations
Headers
Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.
Maximum string length:
255Query Parameters
When false, store submitted line classifications, including an empty list. When omitted, organization defaults apply to new lines with omitted or empty classifications only when the organization setting is enabled.
Body
application/json
Recurrence rule in iCalendar RRULE format (RFC 5545)
Required string length:
8 - 500Pattern:
^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"
Available options:
active, inactive Available options:
automatic, reminder Show child attributes
Show child attributes
Response
OK
Available options:
active, inactive Lists failures that stop this template from creating records. The key is the date in next_occurrence (YYYY-MM-DD) and the value is the error message.
Show child attributes
Show child attributes
Available options:
automatic, reminder Show child attributes
Show child attributes
Date and time the record was created
Date and time the record was last updated
Schema for audit actor information.
Show child attributes
Show child attributes
Schema for audit actor information.
Show child attributes
Show child attributes
Was this page helpful?