Create a transaction

POST/accounting/{connection_id}/transaction

Parameters

Payload

idstring

created_atdate-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atdate-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

memostring

total_amountnumber

negative for CREDIT, positive for DEBIT

tax_amountnumber

negative for CREDIT, positive for DEBIT

account_idstring

(reference to AccountingAccount)

referencestring

sub_total_amountnumber

split_account_idstring

payment_methodstring

payment_termsstring

customer_messagestring

typestring

eg. CreditCardCharge, Check, Invoice, ReceivePayment, JournalEntry, Bill, CreditCardCredit, VendorCredit, Credit, BillPaymentCheck, BillPaymentCreditCard, Charge, Transfer, Deposit, BANK_DEPOSIT, BANK_TRANSFER, Statement, BillableCharge, TimeActivity, CashPurchase, SalesReceipt, CreditMemo, CreditRefund, Estimate, InventoryQuantityAdjustment, PurchaseOrder, GlobalTaxPayment, GlobalTaxAdjustment, Service Tax Refund, Service Tax Gross Adjustment, Service Tax Reversal, Service Tax Defer, Service Tax Partial Utilisation

lineitems array

currencystring

contacts array

organization_idstring

category_idsstring array

(reference to AccountingCategory)

project_idstring

(reference to TaskProject)

transaction_atdate-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

exchange_ratenumber

Exchange rate to the base/home currency at the transaction date

status enum

Valid values:

"PENDING"

"POSTED"

"VOID"

"OTHER"

Posting state of the transaction

raw

Returns

AccountingTransaction

Response field	Type	Required	Description
`id`	string	No
`created_at`	string (date-time)	No	(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`updated_at`	string (date-time)	No	(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`memo`	string	No
`total_amount`	number	No	negative for CREDIT, positive for DEBIT
`tax_amount`	number	No	negative for CREDIT, positive for DEBIT
`account_id`	string	No	(reference to AccountingAccount)
`reference`	string	No
`sub_total_amount`	number	No
`split_account_id`	string	No
`payment_method`	string	No
`payment_terms`	string	No
`customer_message`	string	No
`type`	string	No	eg. CreditCardCharge, Check, Invoice, ReceivePayment, JournalEntry, Bill, CreditCardCredit, VendorCredit, Credit, BillPaymentCheck, BillPaymentCreditCard, Charge, Transfer, Deposit, BANK_DEPOSIT, BANK_TRANSFER, Statement, BillableCharge, TimeActivity, CashPurchase, SalesReceipt, CreditMemo, CreditRefund, Estimate, InventoryQuantityAdjustment, PurchaseOrder, GlobalTaxPayment, GlobalTaxAdjustment, Service Tax Refund, Service Tax Gross Adjustment, Service Tax Reversal, Service Tax Defer, Service Tax Partial Utilisation
`lineitems`	AccountingTransactionLineItem[]	No
`lineitems[].id`	string	No
`lineitems[].unit_quantity`	number	No
`lineitems[].unit_amount`	number	No
`lineitems[].total_amount`	number	No	will be a positive value for a debit and negative for a credit
`lineitems[].account_id`	string	No	(reference to AccountingAccount)
`lineitems[].object_type`	string	No
`lineitems[].name`	string	No
`lineitems[].description`	string	No
`lineitems[].category_ids`	string[]	No	(reference to AccountingCategory)
`lineitems[].taxrate_id`	string	No	ref -> AccountingTaxrate applied to the line
`currency`	string	No
`contacts`	AccountingTransactionContact[]	No
`contacts[].id`	string	Yes
`contacts[].is_customer`	boolean	No
`contacts[].is_supplier`	boolean	No
`organization_id`	string	No
`category_ids`	string[]	No	(reference to AccountingCategory)
`project_id`	string	No	(reference to TaskProject)
`transaction_at`	string (date-time)	No	(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`exchange_rate`	number	No	Exchange rate to the base/home currency at the transaction date
`status`	enum	No	Posting state of the transaction Values: `PENDING`, `POSTED`, `VOID`, `OTHER`

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}

Status	Error	Meaning
`400`	Bad Request	The request was malformed or failed validation.
`401`	Unauthorized	The connection is likely broken; re-authorize it.
`403`	Forbidden	The connection is missing permissions or scopes.
`404`	Not Found	The requested resource does not exist.
`429`	Too Many Requests	Rate limit exceeded (see the two sources below).
`500`	Internal Server Error	An unexpected error occurred.
`501`	Not Implemented	Not supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

The integration's own rate limit, passed through.
Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.

const options = {
  method: 'POST',
  url: 'https://api.unified.to/accounting/5de520f96e439b002043d8dc/transaction',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Code Samples

Node.js SDK

import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const results = await sdk.accounting.createAccountingTransaction({ connectionId, accountingTransaction: { }, 
    fields: '',
    raw: '',
 });

Node.js (axios)

const options = {
  method: 'POST',
  url: 'https://api.unified.to/accounting/5de520f96e439b002043d8dc/transaction',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("POST", "https://api.unified.to/accounting/5de520f96e439b002043d8dc/transaction?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

Go

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/accounting/5de520f96e439b002043d8dc/transaction?fields=&raw=

req, _ := http.NewRequest("POST", url, nil)

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

Python

import requests

url = "https://api.unified.to/accounting/5de520f96e439b002043d8dc/transaction?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.post(url, headers=headers)

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/accounting/5de520f96e439b002043d8dc/transaction?fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/accounting/5de520f96e439b002043d8dc/transaction?fields=&raw=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

response = http.request(request)
puts response.read_body

cURL

curl --request POST \
  --url 'https://api.unified.to/accounting/5de520f96e439b002043d8dc/transaction?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?