Update RecurringBill record
curl --request PUT \
--url https://api.dualentry.com/public/v3-alpha/recurring/bills/{record_number}/ \
--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,
"vendor_id": 123,
"ship_from_address": {
"street": "<string>",
"city": "<string>",
"postal_code": "<string>",
"state": "",
"country": "",
"second_line": "",
"name": "<string>"
},
"ship_to_address": {
"street": "<string>",
"city": "<string>",
"postal_code": "<string>",
"state": "",
"country": "",
"second_line": "",
"name": "<string>"
},
"supply_date": "2023-12-25",
"place_of_supply": "<string>",
"tax_registration_numbers": {
"company": [
{
"type": "<string>",
"number": "<string>",
"region": "<string>"
}
],
"counterparty": [
{
"type": "<string>",
"number": "<string>",
"region": "<string>"
}
]
},
"tax_metadata": {},
"custom_fields": [
{}
],
"transaction_date": "2023-12-25",
"auto_calculate_tax": "required",
"exchange_rate": 123,
"memo": "<string>",
"items": [
{
"position": 123,
"item_id": 123,
"memo": "<string>",
"rate": 123,
"quantity": 123,
"tax": {
"code": "<string>",
"rate": 123,
"amount": 123,
"is_taxable": true,
"tax_exempt_amount": 123,
"vat_rate_id": 123,
"gst_tax_rate_id": 123,
"tax_metadata": {}
},
"is_billable": false,
"billable_customer_id": 123,
"billable_project_id": 123,
"billable_markup_pct": 500,
"id": 123,
"classifications": [],
"company_id": 123,
"custom_fields": [
{}
]
}
],
"expenses": [
{
"position": 123,
"rate": 123,
"quantity": 123,
"account_number": 123,
"expense_description": "<string>",
"tax": {
"code": "<string>",
"rate": 123,
"amount": 123,
"is_taxable": true,
"tax_exempt_amount": 123,
"vat_rate_id": 123,
"gst_tax_rate_id": 123,
"tax_metadata": {}
},
"is_billable": false,
"billable_customer_id": 123,
"billable_project_id": 123,
"billable_markup_pct": 500,
"special_tax_treatment": "IMPORT_VAT",
"id": 123,
"classifications": [],
"customer_id": 123,
"vendor_id": 123,
"company_id": 123,
"custom_fields": [
{}
]
}
],
"due_date": "2023-12-25",
"term_id": 123,
"reference_number": "",
"purchase_order_number": 123,
"attachments": [],
"record_status": "posted"
}
}
'import requests
url = "https://api.dualentry.com/public/v3-alpha/recurring/bills/{record_number}/"
payload = {
"rrule": "FREQ=DAILY",
"memo": "<string>",
"name": "<string>",
"date": "2023-12-25",
"company_id": 123,
"record_payload": {
"date": "2023-12-25",
"company_id": 123,
"vendor_id": 123,
"ship_from_address": {
"street": "<string>",
"city": "<string>",
"postal_code": "<string>",
"state": "",
"country": "",
"second_line": "",
"name": "<string>"
},
"ship_to_address": {
"street": "<string>",
"city": "<string>",
"postal_code": "<string>",
"state": "",
"country": "",
"second_line": "",
"name": "<string>"
},
"supply_date": "2023-12-25",
"place_of_supply": "<string>",
"tax_registration_numbers": {
"company": [
{
"type": "<string>",
"number": "<string>",
"region": "<string>"
}
],
"counterparty": [
{
"type": "<string>",
"number": "<string>",
"region": "<string>"
}
]
},
"tax_metadata": {},
"custom_fields": [{}],
"transaction_date": "2023-12-25",
"auto_calculate_tax": "required",
"exchange_rate": 123,
"memo": "<string>",
"items": [
{
"position": 123,
"item_id": 123,
"memo": "<string>",
"rate": 123,
"quantity": 123,
"tax": {
"code": "<string>",
"rate": 123,
"amount": 123,
"is_taxable": True,
"tax_exempt_amount": 123,
"vat_rate_id": 123,
"gst_tax_rate_id": 123,
"tax_metadata": {}
},
"is_billable": False,
"billable_customer_id": 123,
"billable_project_id": 123,
"billable_markup_pct": 500,
"id": 123,
"classifications": [],
"company_id": 123,
"custom_fields": [{}]
}
],
"expenses": [
{
"position": 123,
"rate": 123,
"quantity": 123,
"account_number": 123,
"expense_description": "<string>",
"tax": {
"code": "<string>",
"rate": 123,
"amount": 123,
"is_taxable": True,
"tax_exempt_amount": 123,
"vat_rate_id": 123,
"gst_tax_rate_id": 123,
"tax_metadata": {}
},
"is_billable": False,
"billable_customer_id": 123,
"billable_project_id": 123,
"billable_markup_pct": 500,
"special_tax_treatment": "IMPORT_VAT",
"id": 123,
"classifications": [],
"customer_id": 123,
"vendor_id": 123,
"company_id": 123,
"custom_fields": [{}]
}
],
"due_date": "2023-12-25",
"term_id": 123,
"reference_number": "",
"purchase_order_number": 123,
"attachments": [],
"record_status": "posted"
}
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
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,
vendor_id: 123,
ship_from_address: {
street: '<string>',
city: '<string>',
postal_code: '<string>',
state: '',
country: '',
second_line: '',
name: '<string>'
},
ship_to_address: {
street: '<string>',
city: '<string>',
postal_code: '<string>',
state: '',
country: '',
second_line: '',
name: '<string>'
},
supply_date: '2023-12-25',
place_of_supply: '<string>',
tax_registration_numbers: {
company: [{type: '<string>', number: '<string>', region: '<string>'}],
counterparty: [{type: '<string>', number: '<string>', region: '<string>'}]
},
tax_metadata: {},
custom_fields: [{}],
transaction_date: '2023-12-25',
auto_calculate_tax: 'required',
exchange_rate: 123,
memo: '<string>',
items: [
{
position: 123,
item_id: 123,
memo: '<string>',
rate: 123,
quantity: 123,
tax: {
code: '<string>',
rate: 123,
amount: 123,
is_taxable: true,
tax_exempt_amount: 123,
vat_rate_id: 123,
gst_tax_rate_id: 123,
tax_metadata: {}
},
is_billable: false,
billable_customer_id: 123,
billable_project_id: 123,
billable_markup_pct: 500,
id: 123,
classifications: [],
company_id: 123,
custom_fields: [{}]
}
],
expenses: [
{
position: 123,
rate: 123,
quantity: 123,
account_number: 123,
expense_description: '<string>',
tax: {
code: '<string>',
rate: 123,
amount: 123,
is_taxable: true,
tax_exempt_amount: 123,
vat_rate_id: 123,
gst_tax_rate_id: 123,
tax_metadata: {}
},
is_billable: false,
billable_customer_id: 123,
billable_project_id: 123,
billable_markup_pct: 500,
special_tax_treatment: 'IMPORT_VAT',
id: 123,
classifications: [],
customer_id: 123,
vendor_id: 123,
company_id: 123,
custom_fields: [{}]
}
],
due_date: '2023-12-25',
term_id: 123,
reference_number: '',
purchase_order_number: 123,
attachments: [],
record_status: 'posted'
}
})
};
fetch('https://api.dualentry.com/public/v3-alpha/recurring/bills/{record_number}/', 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/bills/{record_number}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
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,
'vendor_id' => 123,
'ship_from_address' => [
'street' => '<string>',
'city' => '<string>',
'postal_code' => '<string>',
'state' => '',
'country' => '',
'second_line' => '',
'name' => '<string>'
],
'ship_to_address' => [
'street' => '<string>',
'city' => '<string>',
'postal_code' => '<string>',
'state' => '',
'country' => '',
'second_line' => '',
'name' => '<string>'
],
'supply_date' => '2023-12-25',
'place_of_supply' => '<string>',
'tax_registration_numbers' => [
'company' => [
[
'type' => '<string>',
'number' => '<string>',
'region' => '<string>'
]
],
'counterparty' => [
[
'type' => '<string>',
'number' => '<string>',
'region' => '<string>'
]
]
],
'tax_metadata' => [
],
'custom_fields' => [
[
]
],
'transaction_date' => '2023-12-25',
'auto_calculate_tax' => 'required',
'exchange_rate' => 123,
'memo' => '<string>',
'items' => [
[
'position' => 123,
'item_id' => 123,
'memo' => '<string>',
'rate' => 123,
'quantity' => 123,
'tax' => [
'code' => '<string>',
'rate' => 123,
'amount' => 123,
'is_taxable' => true,
'tax_exempt_amount' => 123,
'vat_rate_id' => 123,
'gst_tax_rate_id' => 123,
'tax_metadata' => [
]
],
'is_billable' => false,
'billable_customer_id' => 123,
'billable_project_id' => 123,
'billable_markup_pct' => 500,
'id' => 123,
'classifications' => [
],
'company_id' => 123,
'custom_fields' => [
[
]
]
]
],
'expenses' => [
[
'position' => 123,
'rate' => 123,
'quantity' => 123,
'account_number' => 123,
'expense_description' => '<string>',
'tax' => [
'code' => '<string>',
'rate' => 123,
'amount' => 123,
'is_taxable' => true,
'tax_exempt_amount' => 123,
'vat_rate_id' => 123,
'gst_tax_rate_id' => 123,
'tax_metadata' => [
]
],
'is_billable' => false,
'billable_customer_id' => 123,
'billable_project_id' => 123,
'billable_markup_pct' => 500,
'special_tax_treatment' => 'IMPORT_VAT',
'id' => 123,
'classifications' => [
],
'customer_id' => 123,
'vendor_id' => 123,
'company_id' => 123,
'custom_fields' => [
[
]
]
]
],
'due_date' => '2023-12-25',
'term_id' => 123,
'reference_number' => '',
'purchase_order_number' => 123,
'attachments' => [
],
'record_status' => 'posted'
]
]),
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/bills/{record_number}/"
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 \"vendor_id\": 123,\n \"ship_from_address\": {\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"\",\n \"country\": \"\",\n \"second_line\": \"\",\n \"name\": \"<string>\"\n },\n \"ship_to_address\": {\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"\",\n \"country\": \"\",\n \"second_line\": \"\",\n \"name\": \"<string>\"\n },\n \"supply_date\": \"2023-12-25\",\n \"place_of_supply\": \"<string>\",\n \"tax_registration_numbers\": {\n \"company\": [\n {\n \"type\": \"<string>\",\n \"number\": \"<string>\",\n \"region\": \"<string>\"\n }\n ],\n \"counterparty\": [\n {\n \"type\": \"<string>\",\n \"number\": \"<string>\",\n \"region\": \"<string>\"\n }\n ]\n },\n \"tax_metadata\": {},\n \"custom_fields\": [\n {}\n ],\n \"transaction_date\": \"2023-12-25\",\n \"auto_calculate_tax\": \"required\",\n \"exchange_rate\": 123,\n \"memo\": \"<string>\",\n \"items\": [\n {\n \"position\": 123,\n \"item_id\": 123,\n \"memo\": \"<string>\",\n \"rate\": 123,\n \"quantity\": 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 \"tax_metadata\": {}\n },\n \"is_billable\": false,\n \"billable_customer_id\": 123,\n \"billable_project_id\": 123,\n \"billable_markup_pct\": 500,\n \"id\": 123,\n \"classifications\": [],\n \"company_id\": 123,\n \"custom_fields\": [\n {}\n ]\n }\n ],\n \"expenses\": [\n {\n \"position\": 123,\n \"rate\": 123,\n \"quantity\": 123,\n \"account_number\": 123,\n \"expense_description\": \"<string>\",\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 \"tax_metadata\": {}\n },\n \"is_billable\": false,\n \"billable_customer_id\": 123,\n \"billable_project_id\": 123,\n \"billable_markup_pct\": 500,\n \"special_tax_treatment\": \"IMPORT_VAT\",\n \"id\": 123,\n \"classifications\": [],\n \"customer_id\": 123,\n \"vendor_id\": 123,\n \"company_id\": 123,\n \"custom_fields\": [\n {}\n ]\n }\n ],\n \"due_date\": \"2023-12-25\",\n \"term_id\": 123,\n \"reference_number\": \"\",\n \"purchase_order_number\": 123,\n \"attachments\": [],\n \"record_status\": \"posted\"\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.dualentry.com/public/v3-alpha/recurring/bills/{record_number}/")
.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 \"vendor_id\": 123,\n \"ship_from_address\": {\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"\",\n \"country\": \"\",\n \"second_line\": \"\",\n \"name\": \"<string>\"\n },\n \"ship_to_address\": {\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"\",\n \"country\": \"\",\n \"second_line\": \"\",\n \"name\": \"<string>\"\n },\n \"supply_date\": \"2023-12-25\",\n \"place_of_supply\": \"<string>\",\n \"tax_registration_numbers\": {\n \"company\": [\n {\n \"type\": \"<string>\",\n \"number\": \"<string>\",\n \"region\": \"<string>\"\n }\n ],\n \"counterparty\": [\n {\n \"type\": \"<string>\",\n \"number\": \"<string>\",\n \"region\": \"<string>\"\n }\n ]\n },\n \"tax_metadata\": {},\n \"custom_fields\": [\n {}\n ],\n \"transaction_date\": \"2023-12-25\",\n \"auto_calculate_tax\": \"required\",\n \"exchange_rate\": 123,\n \"memo\": \"<string>\",\n \"items\": [\n {\n \"position\": 123,\n \"item_id\": 123,\n \"memo\": \"<string>\",\n \"rate\": 123,\n \"quantity\": 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 \"tax_metadata\": {}\n },\n \"is_billable\": false,\n \"billable_customer_id\": 123,\n \"billable_project_id\": 123,\n \"billable_markup_pct\": 500,\n \"id\": 123,\n \"classifications\": [],\n \"company_id\": 123,\n \"custom_fields\": [\n {}\n ]\n }\n ],\n \"expenses\": [\n {\n \"position\": 123,\n \"rate\": 123,\n \"quantity\": 123,\n \"account_number\": 123,\n \"expense_description\": \"<string>\",\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 \"tax_metadata\": {}\n },\n \"is_billable\": false,\n \"billable_customer_id\": 123,\n \"billable_project_id\": 123,\n \"billable_markup_pct\": 500,\n \"special_tax_treatment\": \"IMPORT_VAT\",\n \"id\": 123,\n \"classifications\": [],\n \"customer_id\": 123,\n \"vendor_id\": 123,\n \"company_id\": 123,\n \"custom_fields\": [\n {}\n ]\n }\n ],\n \"due_date\": \"2023-12-25\",\n \"term_id\": 123,\n \"reference_number\": \"\",\n \"purchase_order_number\": 123,\n \"attachments\": [],\n \"record_status\": \"posted\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dualentry.com/public/v3-alpha/recurring/bills/{record_number}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.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 \"vendor_id\": 123,\n \"ship_from_address\": {\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"\",\n \"country\": \"\",\n \"second_line\": \"\",\n \"name\": \"<string>\"\n },\n \"ship_to_address\": {\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"\",\n \"country\": \"\",\n \"second_line\": \"\",\n \"name\": \"<string>\"\n },\n \"supply_date\": \"2023-12-25\",\n \"place_of_supply\": \"<string>\",\n \"tax_registration_numbers\": {\n \"company\": [\n {\n \"type\": \"<string>\",\n \"number\": \"<string>\",\n \"region\": \"<string>\"\n }\n ],\n \"counterparty\": [\n {\n \"type\": \"<string>\",\n \"number\": \"<string>\",\n \"region\": \"<string>\"\n }\n ]\n },\n \"tax_metadata\": {},\n \"custom_fields\": [\n {}\n ],\n \"transaction_date\": \"2023-12-25\",\n \"auto_calculate_tax\": \"required\",\n \"exchange_rate\": 123,\n \"memo\": \"<string>\",\n \"items\": [\n {\n \"position\": 123,\n \"item_id\": 123,\n \"memo\": \"<string>\",\n \"rate\": 123,\n \"quantity\": 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 \"tax_metadata\": {}\n },\n \"is_billable\": false,\n \"billable_customer_id\": 123,\n \"billable_project_id\": 123,\n \"billable_markup_pct\": 500,\n \"id\": 123,\n \"classifications\": [],\n \"company_id\": 123,\n \"custom_fields\": [\n {}\n ]\n }\n ],\n \"expenses\": [\n {\n \"position\": 123,\n \"rate\": 123,\n \"quantity\": 123,\n \"account_number\": 123,\n \"expense_description\": \"<string>\",\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 \"tax_metadata\": {}\n },\n \"is_billable\": false,\n \"billable_customer_id\": 123,\n \"billable_project_id\": 123,\n \"billable_markup_pct\": 500,\n \"special_tax_treatment\": \"IMPORT_VAT\",\n \"id\": 123,\n \"classifications\": [],\n \"customer_id\": 123,\n \"vendor_id\": 123,\n \"company_id\": 123,\n \"custom_fields\": [\n {}\n ]\n }\n ],\n \"due_date\": \"2023-12-25\",\n \"term_id\": 123,\n \"reference_number\": \"\",\n \"purchase_order_number\": 123,\n \"attachments\": [],\n \"record_status\": \"posted\"\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 Bills
Update RecurringBill record
Update an existing RecurringBill 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 edit permission of the template’s record type, such as
invoice:editfor a recurring invoice, as well asrecurring:edit. Without both permissions, the request returns403. - Fails with
422and error coderecurring_template_archived_partywhen the template uses an archived customer or vendor.
PUT
/
public
/
v3-alpha
/
recurring
/
bills
/
{record_number}
/
Update RecurringBill record
curl --request PUT \
--url https://api.dualentry.com/public/v3-alpha/recurring/bills/{record_number}/ \
--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,
"vendor_id": 123,
"ship_from_address": {
"street": "<string>",
"city": "<string>",
"postal_code": "<string>",
"state": "",
"country": "",
"second_line": "",
"name": "<string>"
},
"ship_to_address": {
"street": "<string>",
"city": "<string>",
"postal_code": "<string>",
"state": "",
"country": "",
"second_line": "",
"name": "<string>"
},
"supply_date": "2023-12-25",
"place_of_supply": "<string>",
"tax_registration_numbers": {
"company": [
{
"type": "<string>",
"number": "<string>",
"region": "<string>"
}
],
"counterparty": [
{
"type": "<string>",
"number": "<string>",
"region": "<string>"
}
]
},
"tax_metadata": {},
"custom_fields": [
{}
],
"transaction_date": "2023-12-25",
"auto_calculate_tax": "required",
"exchange_rate": 123,
"memo": "<string>",
"items": [
{
"position": 123,
"item_id": 123,
"memo": "<string>",
"rate": 123,
"quantity": 123,
"tax": {
"code": "<string>",
"rate": 123,
"amount": 123,
"is_taxable": true,
"tax_exempt_amount": 123,
"vat_rate_id": 123,
"gst_tax_rate_id": 123,
"tax_metadata": {}
},
"is_billable": false,
"billable_customer_id": 123,
"billable_project_id": 123,
"billable_markup_pct": 500,
"id": 123,
"classifications": [],
"company_id": 123,
"custom_fields": [
{}
]
}
],
"expenses": [
{
"position": 123,
"rate": 123,
"quantity": 123,
"account_number": 123,
"expense_description": "<string>",
"tax": {
"code": "<string>",
"rate": 123,
"amount": 123,
"is_taxable": true,
"tax_exempt_amount": 123,
"vat_rate_id": 123,
"gst_tax_rate_id": 123,
"tax_metadata": {}
},
"is_billable": false,
"billable_customer_id": 123,
"billable_project_id": 123,
"billable_markup_pct": 500,
"special_tax_treatment": "IMPORT_VAT",
"id": 123,
"classifications": [],
"customer_id": 123,
"vendor_id": 123,
"company_id": 123,
"custom_fields": [
{}
]
}
],
"due_date": "2023-12-25",
"term_id": 123,
"reference_number": "",
"purchase_order_number": 123,
"attachments": [],
"record_status": "posted"
}
}
'import requests
url = "https://api.dualentry.com/public/v3-alpha/recurring/bills/{record_number}/"
payload = {
"rrule": "FREQ=DAILY",
"memo": "<string>",
"name": "<string>",
"date": "2023-12-25",
"company_id": 123,
"record_payload": {
"date": "2023-12-25",
"company_id": 123,
"vendor_id": 123,
"ship_from_address": {
"street": "<string>",
"city": "<string>",
"postal_code": "<string>",
"state": "",
"country": "",
"second_line": "",
"name": "<string>"
},
"ship_to_address": {
"street": "<string>",
"city": "<string>",
"postal_code": "<string>",
"state": "",
"country": "",
"second_line": "",
"name": "<string>"
},
"supply_date": "2023-12-25",
"place_of_supply": "<string>",
"tax_registration_numbers": {
"company": [
{
"type": "<string>",
"number": "<string>",
"region": "<string>"
}
],
"counterparty": [
{
"type": "<string>",
"number": "<string>",
"region": "<string>"
}
]
},
"tax_metadata": {},
"custom_fields": [{}],
"transaction_date": "2023-12-25",
"auto_calculate_tax": "required",
"exchange_rate": 123,
"memo": "<string>",
"items": [
{
"position": 123,
"item_id": 123,
"memo": "<string>",
"rate": 123,
"quantity": 123,
"tax": {
"code": "<string>",
"rate": 123,
"amount": 123,
"is_taxable": True,
"tax_exempt_amount": 123,
"vat_rate_id": 123,
"gst_tax_rate_id": 123,
"tax_metadata": {}
},
"is_billable": False,
"billable_customer_id": 123,
"billable_project_id": 123,
"billable_markup_pct": 500,
"id": 123,
"classifications": [],
"company_id": 123,
"custom_fields": [{}]
}
],
"expenses": [
{
"position": 123,
"rate": 123,
"quantity": 123,
"account_number": 123,
"expense_description": "<string>",
"tax": {
"code": "<string>",
"rate": 123,
"amount": 123,
"is_taxable": True,
"tax_exempt_amount": 123,
"vat_rate_id": 123,
"gst_tax_rate_id": 123,
"tax_metadata": {}
},
"is_billable": False,
"billable_customer_id": 123,
"billable_project_id": 123,
"billable_markup_pct": 500,
"special_tax_treatment": "IMPORT_VAT",
"id": 123,
"classifications": [],
"customer_id": 123,
"vendor_id": 123,
"company_id": 123,
"custom_fields": [{}]
}
],
"due_date": "2023-12-25",
"term_id": 123,
"reference_number": "",
"purchase_order_number": 123,
"attachments": [],
"record_status": "posted"
}
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
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,
vendor_id: 123,
ship_from_address: {
street: '<string>',
city: '<string>',
postal_code: '<string>',
state: '',
country: '',
second_line: '',
name: '<string>'
},
ship_to_address: {
street: '<string>',
city: '<string>',
postal_code: '<string>',
state: '',
country: '',
second_line: '',
name: '<string>'
},
supply_date: '2023-12-25',
place_of_supply: '<string>',
tax_registration_numbers: {
company: [{type: '<string>', number: '<string>', region: '<string>'}],
counterparty: [{type: '<string>', number: '<string>', region: '<string>'}]
},
tax_metadata: {},
custom_fields: [{}],
transaction_date: '2023-12-25',
auto_calculate_tax: 'required',
exchange_rate: 123,
memo: '<string>',
items: [
{
position: 123,
item_id: 123,
memo: '<string>',
rate: 123,
quantity: 123,
tax: {
code: '<string>',
rate: 123,
amount: 123,
is_taxable: true,
tax_exempt_amount: 123,
vat_rate_id: 123,
gst_tax_rate_id: 123,
tax_metadata: {}
},
is_billable: false,
billable_customer_id: 123,
billable_project_id: 123,
billable_markup_pct: 500,
id: 123,
classifications: [],
company_id: 123,
custom_fields: [{}]
}
],
expenses: [
{
position: 123,
rate: 123,
quantity: 123,
account_number: 123,
expense_description: '<string>',
tax: {
code: '<string>',
rate: 123,
amount: 123,
is_taxable: true,
tax_exempt_amount: 123,
vat_rate_id: 123,
gst_tax_rate_id: 123,
tax_metadata: {}
},
is_billable: false,
billable_customer_id: 123,
billable_project_id: 123,
billable_markup_pct: 500,
special_tax_treatment: 'IMPORT_VAT',
id: 123,
classifications: [],
customer_id: 123,
vendor_id: 123,
company_id: 123,
custom_fields: [{}]
}
],
due_date: '2023-12-25',
term_id: 123,
reference_number: '',
purchase_order_number: 123,
attachments: [],
record_status: 'posted'
}
})
};
fetch('https://api.dualentry.com/public/v3-alpha/recurring/bills/{record_number}/', 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/bills/{record_number}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
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,
'vendor_id' => 123,
'ship_from_address' => [
'street' => '<string>',
'city' => '<string>',
'postal_code' => '<string>',
'state' => '',
'country' => '',
'second_line' => '',
'name' => '<string>'
],
'ship_to_address' => [
'street' => '<string>',
'city' => '<string>',
'postal_code' => '<string>',
'state' => '',
'country' => '',
'second_line' => '',
'name' => '<string>'
],
'supply_date' => '2023-12-25',
'place_of_supply' => '<string>',
'tax_registration_numbers' => [
'company' => [
[
'type' => '<string>',
'number' => '<string>',
'region' => '<string>'
]
],
'counterparty' => [
[
'type' => '<string>',
'number' => '<string>',
'region' => '<string>'
]
]
],
'tax_metadata' => [
],
'custom_fields' => [
[
]
],
'transaction_date' => '2023-12-25',
'auto_calculate_tax' => 'required',
'exchange_rate' => 123,
'memo' => '<string>',
'items' => [
[
'position' => 123,
'item_id' => 123,
'memo' => '<string>',
'rate' => 123,
'quantity' => 123,
'tax' => [
'code' => '<string>',
'rate' => 123,
'amount' => 123,
'is_taxable' => true,
'tax_exempt_amount' => 123,
'vat_rate_id' => 123,
'gst_tax_rate_id' => 123,
'tax_metadata' => [
]
],
'is_billable' => false,
'billable_customer_id' => 123,
'billable_project_id' => 123,
'billable_markup_pct' => 500,
'id' => 123,
'classifications' => [
],
'company_id' => 123,
'custom_fields' => [
[
]
]
]
],
'expenses' => [
[
'position' => 123,
'rate' => 123,
'quantity' => 123,
'account_number' => 123,
'expense_description' => '<string>',
'tax' => [
'code' => '<string>',
'rate' => 123,
'amount' => 123,
'is_taxable' => true,
'tax_exempt_amount' => 123,
'vat_rate_id' => 123,
'gst_tax_rate_id' => 123,
'tax_metadata' => [
]
],
'is_billable' => false,
'billable_customer_id' => 123,
'billable_project_id' => 123,
'billable_markup_pct' => 500,
'special_tax_treatment' => 'IMPORT_VAT',
'id' => 123,
'classifications' => [
],
'customer_id' => 123,
'vendor_id' => 123,
'company_id' => 123,
'custom_fields' => [
[
]
]
]
],
'due_date' => '2023-12-25',
'term_id' => 123,
'reference_number' => '',
'purchase_order_number' => 123,
'attachments' => [
],
'record_status' => 'posted'
]
]),
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/bills/{record_number}/"
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 \"vendor_id\": 123,\n \"ship_from_address\": {\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"\",\n \"country\": \"\",\n \"second_line\": \"\",\n \"name\": \"<string>\"\n },\n \"ship_to_address\": {\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"\",\n \"country\": \"\",\n \"second_line\": \"\",\n \"name\": \"<string>\"\n },\n \"supply_date\": \"2023-12-25\",\n \"place_of_supply\": \"<string>\",\n \"tax_registration_numbers\": {\n \"company\": [\n {\n \"type\": \"<string>\",\n \"number\": \"<string>\",\n \"region\": \"<string>\"\n }\n ],\n \"counterparty\": [\n {\n \"type\": \"<string>\",\n \"number\": \"<string>\",\n \"region\": \"<string>\"\n }\n ]\n },\n \"tax_metadata\": {},\n \"custom_fields\": [\n {}\n ],\n \"transaction_date\": \"2023-12-25\",\n \"auto_calculate_tax\": \"required\",\n \"exchange_rate\": 123,\n \"memo\": \"<string>\",\n \"items\": [\n {\n \"position\": 123,\n \"item_id\": 123,\n \"memo\": \"<string>\",\n \"rate\": 123,\n \"quantity\": 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 \"tax_metadata\": {}\n },\n \"is_billable\": false,\n \"billable_customer_id\": 123,\n \"billable_project_id\": 123,\n \"billable_markup_pct\": 500,\n \"id\": 123,\n \"classifications\": [],\n \"company_id\": 123,\n \"custom_fields\": [\n {}\n ]\n }\n ],\n \"expenses\": [\n {\n \"position\": 123,\n \"rate\": 123,\n \"quantity\": 123,\n \"account_number\": 123,\n \"expense_description\": \"<string>\",\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 \"tax_metadata\": {}\n },\n \"is_billable\": false,\n \"billable_customer_id\": 123,\n \"billable_project_id\": 123,\n \"billable_markup_pct\": 500,\n \"special_tax_treatment\": \"IMPORT_VAT\",\n \"id\": 123,\n \"classifications\": [],\n \"customer_id\": 123,\n \"vendor_id\": 123,\n \"company_id\": 123,\n \"custom_fields\": [\n {}\n ]\n }\n ],\n \"due_date\": \"2023-12-25\",\n \"term_id\": 123,\n \"reference_number\": \"\",\n \"purchase_order_number\": 123,\n \"attachments\": [],\n \"record_status\": \"posted\"\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.dualentry.com/public/v3-alpha/recurring/bills/{record_number}/")
.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 \"vendor_id\": 123,\n \"ship_from_address\": {\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"\",\n \"country\": \"\",\n \"second_line\": \"\",\n \"name\": \"<string>\"\n },\n \"ship_to_address\": {\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"\",\n \"country\": \"\",\n \"second_line\": \"\",\n \"name\": \"<string>\"\n },\n \"supply_date\": \"2023-12-25\",\n \"place_of_supply\": \"<string>\",\n \"tax_registration_numbers\": {\n \"company\": [\n {\n \"type\": \"<string>\",\n \"number\": \"<string>\",\n \"region\": \"<string>\"\n }\n ],\n \"counterparty\": [\n {\n \"type\": \"<string>\",\n \"number\": \"<string>\",\n \"region\": \"<string>\"\n }\n ]\n },\n \"tax_metadata\": {},\n \"custom_fields\": [\n {}\n ],\n \"transaction_date\": \"2023-12-25\",\n \"auto_calculate_tax\": \"required\",\n \"exchange_rate\": 123,\n \"memo\": \"<string>\",\n \"items\": [\n {\n \"position\": 123,\n \"item_id\": 123,\n \"memo\": \"<string>\",\n \"rate\": 123,\n \"quantity\": 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 \"tax_metadata\": {}\n },\n \"is_billable\": false,\n \"billable_customer_id\": 123,\n \"billable_project_id\": 123,\n \"billable_markup_pct\": 500,\n \"id\": 123,\n \"classifications\": [],\n \"company_id\": 123,\n \"custom_fields\": [\n {}\n ]\n }\n ],\n \"expenses\": [\n {\n \"position\": 123,\n \"rate\": 123,\n \"quantity\": 123,\n \"account_number\": 123,\n \"expense_description\": \"<string>\",\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 \"tax_metadata\": {}\n },\n \"is_billable\": false,\n \"billable_customer_id\": 123,\n \"billable_project_id\": 123,\n \"billable_markup_pct\": 500,\n \"special_tax_treatment\": \"IMPORT_VAT\",\n \"id\": 123,\n \"classifications\": [],\n \"customer_id\": 123,\n \"vendor_id\": 123,\n \"company_id\": 123,\n \"custom_fields\": [\n {}\n ]\n }\n ],\n \"due_date\": \"2023-12-25\",\n \"term_id\": 123,\n \"reference_number\": \"\",\n \"purchase_order_number\": 123,\n \"attachments\": [],\n \"record_status\": \"posted\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dualentry.com/public/v3-alpha/recurring/bills/{record_number}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.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 \"vendor_id\": 123,\n \"ship_from_address\": {\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"\",\n \"country\": \"\",\n \"second_line\": \"\",\n \"name\": \"<string>\"\n },\n \"ship_to_address\": {\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"\",\n \"country\": \"\",\n \"second_line\": \"\",\n \"name\": \"<string>\"\n },\n \"supply_date\": \"2023-12-25\",\n \"place_of_supply\": \"<string>\",\n \"tax_registration_numbers\": {\n \"company\": [\n {\n \"type\": \"<string>\",\n \"number\": \"<string>\",\n \"region\": \"<string>\"\n }\n ],\n \"counterparty\": [\n {\n \"type\": \"<string>\",\n \"number\": \"<string>\",\n \"region\": \"<string>\"\n }\n ]\n },\n \"tax_metadata\": {},\n \"custom_fields\": [\n {}\n ],\n \"transaction_date\": \"2023-12-25\",\n \"auto_calculate_tax\": \"required\",\n \"exchange_rate\": 123,\n \"memo\": \"<string>\",\n \"items\": [\n {\n \"position\": 123,\n \"item_id\": 123,\n \"memo\": \"<string>\",\n \"rate\": 123,\n \"quantity\": 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 \"tax_metadata\": {}\n },\n \"is_billable\": false,\n \"billable_customer_id\": 123,\n \"billable_project_id\": 123,\n \"billable_markup_pct\": 500,\n \"id\": 123,\n \"classifications\": [],\n \"company_id\": 123,\n \"custom_fields\": [\n {}\n ]\n }\n ],\n \"expenses\": [\n {\n \"position\": 123,\n \"rate\": 123,\n \"quantity\": 123,\n \"account_number\": 123,\n \"expense_description\": \"<string>\",\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 \"tax_metadata\": {}\n },\n \"is_billable\": false,\n \"billable_customer_id\": 123,\n \"billable_project_id\": 123,\n \"billable_markup_pct\": 500,\n \"special_tax_treatment\": \"IMPORT_VAT\",\n \"id\": 123,\n \"classifications\": [],\n \"customer_id\": 123,\n \"vendor_id\": 123,\n \"company_id\": 123,\n \"custom_fields\": [\n {}\n ]\n }\n ],\n \"due_date\": \"2023-12-25\",\n \"term_id\": 123,\n \"reference_number\": \"\",\n \"purchase_order_number\": 123,\n \"attachments\": [],\n \"record_status\": \"posted\"\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:
255Path Parameters
The number attribute of the record.
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?