curl --request PUT \
--url https://api.exowpee.com/v1/accounting/client/recurring-entries/{recurringEntry} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.exowpee.com/v1/accounting/client/recurring-entries/{recurringEntry}"
headers = {"Authorization": "Bearer <token>"}
response = requests.put(url, headers=headers)
print(response.text)const options = {method: 'PUT', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.exowpee.com/v1/accounting/client/recurring-entries/{recurringEntry}', 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.exowpee.com/v1/accounting/client/recurring-entries/{recurringEntry}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.exowpee.com/v1/accounting/client/recurring-entries/{recurringEntry}"
req, _ := http.NewRequest("PUT", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.exowpee.com/v1/accounting/client/recurring-entries/{recurringEntry}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/accounting/client/recurring-entries/{recurringEntry}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"owner_type": "<string>",
"label": "<string>",
"journal_id": "<string>",
"journal": {},
"frequency": "<string>",
"day_of_month": 123,
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"next_run_on": "2023-12-25",
"last_run_on": "2023-12-25",
"lines": [
"<unknown>"
],
"status": "<string>",
"created_by": "<string>",
"created_by_type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"message": "<string>",
"errors": {}
}Edit a recurring entry (client account)
Changes, pauses, reactivates or extends a recurring entry template (client space).
curl --request PUT \
--url https://api.exowpee.com/v1/accounting/client/recurring-entries/{recurringEntry} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.exowpee.com/v1/accounting/client/recurring-entries/{recurringEntry}"
headers = {"Authorization": "Bearer <token>"}
response = requests.put(url, headers=headers)
print(response.text)const options = {method: 'PUT', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.exowpee.com/v1/accounting/client/recurring-entries/{recurringEntry}', 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.exowpee.com/v1/accounting/client/recurring-entries/{recurringEntry}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.exowpee.com/v1/accounting/client/recurring-entries/{recurringEntry}"
req, _ := http.NewRequest("PUT", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.exowpee.com/v1/accounting/client/recurring-entries/{recurringEntry}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/accounting/client/recurring-entries/{recurringEntry}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"owner_type": "<string>",
"label": "<string>",
"journal_id": "<string>",
"journal": {},
"frequency": "<string>",
"day_of_month": 123,
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"next_run_on": "2023-12-25",
"last_run_on": "2023-12-25",
"lines": [
"<unknown>"
],
"status": "<string>",
"created_by": "<string>",
"created_by_type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"message": "<string>",
"errors": {}
}recurring_entries.update, journal_entries.create (only when changing what it posts or reactivating)
Conditions
- The accounting module must be included in the plan of the organization.
- In the client space the book is always the client account’s own book.
- Changing what the template posts or when (lines, journal, start or end date, frequency, day of month) or reactivating it also needs the journal_entries.create permission.
- The book must be set up for accounting (it must have at least one journal).
- The template must belong to the selected book.
- status can only be set to active or paused; finished is set by the schedule.
- A finished template can be restarted only by sending end_date in the same call (a later date, or null to remove the end); sending status alone is refused.
- Changing the start date is refused when the new date is before the start of the earliest open fiscal year of the book.
- When lines are sent they must meet the same rules as at creation: at least two lines, distinct postable accounts of the book, positive whole amounts, balanced.
- A journal that is changed must belong to the selected book.
- The resulting end date must not be before the start date.
- A field sent as null keeps its stored value, except end_date, where null removes the end of the schedule.
- Saves the changed template and recomputes the next occurrence when the schedule, the start date, the end date or the status (reactivation) changes.
- Pausing records the pause date: occurrences that fall due while paused are dropped, not posted, once the template is reactivated; occurrences due before the pause are still posted.
- When the next occurrence ends up past the end date the status becomes finished; moving the end date past it makes a finished template active again.
- Journal entries already posted are not changed.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Identifier of the recurring entry template (27-character KSUID).
Query Parameters
Response mode. Default none; none answers 204 No Content.
none, resource Comma-separated JSON keys of the root resource (id is always rendered). Available: id, owner_type, label, journal_id, frequency, day_of_month, start_date, end_date, next_run_on, last_run_on, lines, status, created_by, created_by_type, created_at, updated_at.
Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: journal.
Response
Resource (only with response=resource).
Identifier of the recurring entry template (27-character KSUID).
Kind of book the template belongs to: organization, company or client.
Name of the template; it becomes the description of each entry it posts.
Identifier of the journal the entries are posted in (27-character KSUID).
The journal. Present only when requested with include=journal and the caller holds the journals.retrieve permission.
How often the entry is posted: monthly, quarterly (every 3 months) or yearly (every 12 months).
Day of the month of each occurrence, from 1 to 31; in shorter months the last day of the month is used.
Date from which occurrences are due (YYYY-MM-DD).
Date after which no occurrence is posted (YYYY-MM-DD); null when the schedule has no end.
Date of the next occurrence to post (YYYY-MM-DD).
Date of the latest occurrence posted (YYYY-MM-DD); null when none has been posted yet.
Lines posted at each occurrence, as entered: objects with accounting_account_id, direction (debit or credit), amount (whole number in minor units) and label.
State of the template: active (posts on schedule), paused (temporarily not posting) or finished (the next occurrence is past the end date).
Identifier of the member or agent account that created the template; null when unknown.
Kind of the creator; null when unknown.
Date and time the record was created (ISO 8601, UTC).
Date and time the record was last changed (ISO 8601, UTC).