Create a manual document
curl --request POST \
--url https://app.equated.co/api/documents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": "<string>",
"documentType": "BILL",
"dueDate": "<string>",
"documentNumber": "<string>",
"displayTitle": "<string>",
"idempotencyKey": "<string>",
"vendorOrgMerchantId": 1,
"vendorName": "<string>",
"lineItems": [
{
"amount": 123,
"name": "<string>",
"description": "<string>",
"categoryAccountId": 1,
"quantity": 123,
"unitPrice": 123
}
],
"isRecurring": true,
"recurringInterval": 1
}
'import requests
url = "https://app.equated.co/api/documents"
payload = {
"amount": "<string>",
"documentType": "BILL",
"dueDate": "<string>",
"documentNumber": "<string>",
"displayTitle": "<string>",
"idempotencyKey": "<string>",
"vendorOrgMerchantId": 1,
"vendorName": "<string>",
"lineItems": [
{
"amount": 123,
"name": "<string>",
"description": "<string>",
"categoryAccountId": 1,
"quantity": 123,
"unitPrice": 123
}
],
"isRecurring": True,
"recurringInterval": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: '<string>',
documentType: 'BILL',
dueDate: '<string>',
documentNumber: '<string>',
displayTitle: '<string>',
idempotencyKey: '<string>',
vendorOrgMerchantId: 1,
vendorName: '<string>',
lineItems: [
{
amount: 123,
name: '<string>',
description: '<string>',
categoryAccountId: 1,
quantity: 123,
unitPrice: 123
}
],
isRecurring: true,
recurringInterval: 1
})
};
fetch('https://app.equated.co/api/documents', 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://app.equated.co/api/documents",
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([
'amount' => '<string>',
'documentType' => 'BILL',
'dueDate' => '<string>',
'documentNumber' => '<string>',
'displayTitle' => '<string>',
'idempotencyKey' => '<string>',
'vendorOrgMerchantId' => 1,
'vendorName' => '<string>',
'lineItems' => [
[
'amount' => 123,
'name' => '<string>',
'description' => '<string>',
'categoryAccountId' => 1,
'quantity' => 123,
'unitPrice' => 123
]
],
'isRecurring' => true,
'recurringInterval' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://app.equated.co/api/documents"
payload := strings.NewReader("{\n \"amount\": \"<string>\",\n \"documentType\": \"BILL\",\n \"dueDate\": \"<string>\",\n \"documentNumber\": \"<string>\",\n \"displayTitle\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"vendorOrgMerchantId\": 1,\n \"vendorName\": \"<string>\",\n \"lineItems\": [\n {\n \"amount\": 123,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"categoryAccountId\": 1,\n \"quantity\": 123,\n \"unitPrice\": 123\n }\n ],\n \"isRecurring\": true,\n \"recurringInterval\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://app.equated.co/api/documents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": \"<string>\",\n \"documentType\": \"BILL\",\n \"dueDate\": \"<string>\",\n \"documentNumber\": \"<string>\",\n \"displayTitle\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"vendorOrgMerchantId\": 1,\n \"vendorName\": \"<string>\",\n \"lineItems\": [\n {\n \"amount\": 123,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"categoryAccountId\": 1,\n \"quantity\": 123,\n \"unitPrice\": 123\n }\n ],\n \"isRecurring\": true,\n \"recurringInterval\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.equated.co/api/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": \"<string>\",\n \"documentType\": \"BILL\",\n \"dueDate\": \"<string>\",\n \"documentNumber\": \"<string>\",\n \"displayTitle\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"vendorOrgMerchantId\": 1,\n \"vendorName\": \"<string>\",\n \"lineItems\": [\n {\n \"amount\": 123,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"categoryAccountId\": 1,\n \"quantity\": 123,\n \"unitPrice\": 123\n }\n ],\n \"isRecurring\": true,\n \"recurringInterval\": 1\n}"
response = http.request(request)
puts response.read_body{
"document": {
"id": 1,
"documentType": "<string>",
"lifecycle": "<string>",
"amount": "<string>",
"currency": "<string>",
"displayTitle": "<string>",
"documentNumber": "<string>",
"dueDate": "<string>",
"createdAt": "<string>",
"orgMerchantId": 1,
"orgMerchant": {
"id": 1,
"name": "<string>",
"website": "<string>",
"imageUrl": "<string>",
"logo": "<string>"
},
"amountBase": "<string>",
"baseCurrency": "<string>",
"derivedSettlementStatus": "open",
"derivedOutstandingAmount": "<string>",
"payerAccountId": 1,
"resolution": "unresolved"
}
}Documents
Create a manual document
Create a manual document (BILL or INVOICE) without an uploaded file. The document lands in DRAFT with a DRAFT accrual journal entry (AP for bills, AR for invoices), ready for posting edits and confirm_document. To create a document FROM a file (receipt image, bill/invoice PDF), use POST /documents/upload-urls then POST /documents/ingest instead.
POST
/
api
/
documents
Create a manual document
curl --request POST \
--url https://app.equated.co/api/documents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": "<string>",
"documentType": "BILL",
"dueDate": "<string>",
"documentNumber": "<string>",
"displayTitle": "<string>",
"idempotencyKey": "<string>",
"vendorOrgMerchantId": 1,
"vendorName": "<string>",
"lineItems": [
{
"amount": 123,
"name": "<string>",
"description": "<string>",
"categoryAccountId": 1,
"quantity": 123,
"unitPrice": 123
}
],
"isRecurring": true,
"recurringInterval": 1
}
'import requests
url = "https://app.equated.co/api/documents"
payload = {
"amount": "<string>",
"documentType": "BILL",
"dueDate": "<string>",
"documentNumber": "<string>",
"displayTitle": "<string>",
"idempotencyKey": "<string>",
"vendorOrgMerchantId": 1,
"vendorName": "<string>",
"lineItems": [
{
"amount": 123,
"name": "<string>",
"description": "<string>",
"categoryAccountId": 1,
"quantity": 123,
"unitPrice": 123
}
],
"isRecurring": True,
"recurringInterval": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: '<string>',
documentType: 'BILL',
dueDate: '<string>',
documentNumber: '<string>',
displayTitle: '<string>',
idempotencyKey: '<string>',
vendorOrgMerchantId: 1,
vendorName: '<string>',
lineItems: [
{
amount: 123,
name: '<string>',
description: '<string>',
categoryAccountId: 1,
quantity: 123,
unitPrice: 123
}
],
isRecurring: true,
recurringInterval: 1
})
};
fetch('https://app.equated.co/api/documents', 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://app.equated.co/api/documents",
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([
'amount' => '<string>',
'documentType' => 'BILL',
'dueDate' => '<string>',
'documentNumber' => '<string>',
'displayTitle' => '<string>',
'idempotencyKey' => '<string>',
'vendorOrgMerchantId' => 1,
'vendorName' => '<string>',
'lineItems' => [
[
'amount' => 123,
'name' => '<string>',
'description' => '<string>',
'categoryAccountId' => 1,
'quantity' => 123,
'unitPrice' => 123
]
],
'isRecurring' => true,
'recurringInterval' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://app.equated.co/api/documents"
payload := strings.NewReader("{\n \"amount\": \"<string>\",\n \"documentType\": \"BILL\",\n \"dueDate\": \"<string>\",\n \"documentNumber\": \"<string>\",\n \"displayTitle\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"vendorOrgMerchantId\": 1,\n \"vendorName\": \"<string>\",\n \"lineItems\": [\n {\n \"amount\": 123,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"categoryAccountId\": 1,\n \"quantity\": 123,\n \"unitPrice\": 123\n }\n ],\n \"isRecurring\": true,\n \"recurringInterval\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://app.equated.co/api/documents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": \"<string>\",\n \"documentType\": \"BILL\",\n \"dueDate\": \"<string>\",\n \"documentNumber\": \"<string>\",\n \"displayTitle\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"vendorOrgMerchantId\": 1,\n \"vendorName\": \"<string>\",\n \"lineItems\": [\n {\n \"amount\": 123,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"categoryAccountId\": 1,\n \"quantity\": 123,\n \"unitPrice\": 123\n }\n ],\n \"isRecurring\": true,\n \"recurringInterval\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.equated.co/api/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": \"<string>\",\n \"documentType\": \"BILL\",\n \"dueDate\": \"<string>\",\n \"documentNumber\": \"<string>\",\n \"displayTitle\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"vendorOrgMerchantId\": 1,\n \"vendorName\": \"<string>\",\n \"lineItems\": [\n {\n \"amount\": 123,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"categoryAccountId\": 1,\n \"quantity\": 123,\n \"unitPrice\": 123\n }\n ],\n \"isRecurring\": true,\n \"recurringInterval\": 1\n}"
response = http.request(request)
puts response.read_body{
"document": {
"id": 1,
"documentType": "<string>",
"lifecycle": "<string>",
"amount": "<string>",
"currency": "<string>",
"displayTitle": "<string>",
"documentNumber": "<string>",
"dueDate": "<string>",
"createdAt": "<string>",
"orgMerchantId": 1,
"orgMerchant": {
"id": 1,
"name": "<string>",
"website": "<string>",
"imageUrl": "<string>",
"logo": "<string>"
},
"amountBase": "<string>",
"baseCurrency": "<string>",
"derivedSettlementStatus": "open",
"derivedOutstandingAmount": "<string>",
"payerAccountId": 1,
"resolution": "unresolved"
}
}Authorizations
API token issued from the Equated app under Settings → API Tokens.
Body
application/json
- Option 1
- Option 2
Pattern:
^\d+(\.\d+)?$Available options:
BILL Available options:
CAD, USD, EUR, GBP, AUD Pattern:
^\d{4}-\d{2}-\d{2}$Maximum string length:
80Maximum string length:
200Required string length:
1 - 200Required range:
x > 0Required string length:
1 - 200Show child attributes
Show child attributes
Required range:
x > 0Available options:
WEEK, MONTH, YEAR Response
201 - application/json
Created document
Show child attributes
Show child attributes