curl --request POST \
--url https://api.exowpee.com/v1/accounting/organization/books/{book}/recurring-entries \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.exowpee.com/v1/accounting/organization/books/{book}/recurring-entries"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.exowpee.com/v1/accounting/organization/books/{book}/recurring-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.exowpee.com/v1/accounting/organization/books/{book}/recurring-entries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
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/organization/books/{book}/recurring-entries"
req, _ := http.NewRequest("POST", 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.post("https://api.exowpee.com/v1/accounting/organization/books/{book}/recurring-entries")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/accounting/organization/books/{book}/recurring-entries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.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>"
}{
"message": "<string>",
"errors": {}
}Create a recurring entry (organization)
Sets up an accounting entry that is posted automatically every month, quarter or year (organization space), for example rent or depreciation.
curl --request POST \
--url https://api.exowpee.com/v1/accounting/organization/books/{book}/recurring-entries \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.exowpee.com/v1/accounting/organization/books/{book}/recurring-entries"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.exowpee.com/v1/accounting/organization/books/{book}/recurring-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.exowpee.com/v1/accounting/organization/books/{book}/recurring-entries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
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/organization/books/{book}/recurring-entries"
req, _ := http.NewRequest("POST", 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.post("https://api.exowpee.com/v1/accounting/organization/books/{book}/recurring-entries")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/accounting/organization/books/{book}/recurring-entries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.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>"
}{
"message": "<string>",
"errors": {}
}recurring_entries.create, journal_entries.create
Conditions
- The accounting module must be included in the plan of the organization.
- In the organization space the caller needs an accounting access grant on the book named in the URL.
- The caller needs both the recurring_entries.create and the journal_entries.create permissions, because a template posts entries unattended.
- The book must be set up for accounting (it must have at least one journal).
- journal_id must be a journal of the selected book.
- There must be at least two lines with distinct accounts, positive whole amounts, equal total debits and credits, and postable accounts of the book.
- frequency must be monthly, quarterly or yearly, and day_of_month a whole number from 1 to 31.
- end_date, when sent, must not be before start_date.
- start_date must not be before the start of the earliest open fiscal year of the book.
- Creates the template with status active, the schedule computed from start_date, frequency and day_of_month (first occurrence on or after the start date) and the creator recorded.
- Posts nothing immediately. The nightly job later posts one journal entry for each due occurrence (catching up a late template, up to 120 occurrences per run), in the chosen journal, with the label as description, source type recurring_entry and no author. An occurrence already posted is never posted twice.
- An occurrence falling in a closed period is skipped; one refused for another business reason (closed account, declared VAT) is retried on the next run.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Identifier of the accounting book (a 27-character KSUID): the organization itself or one of its companies. The caller must hold an accounting access grant on it.
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).