Create a journal

Updated:

POST/accounting/{connection_id}/journal

Creates a AccountingJournal. Provide the unified AccountingJournal fields in the request body; they are mapped to the provider's API. Returns the created AccountingJournal.

Parameters

fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection

Payload

idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
referencestring
tax_amountnumber
currencystring
lineitems array
new field name
taxrate_idstring
descriptionstring
posted_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
sourcestring
organization_idstring
category_idsstring array
(reference to AccountingCategory)
project_idstring
(reference to TaskProject)
attachments array
total_amountnumber
Total of the debit lines; equals the total of the credit lines
exchange_ratenumber
Exchange rate to the base/home currency at the posting date
status enum
Valid values:
"DRAFT"
"POSTED"
"VOID"
"OTHER"
Posting state of the journal entry
is_inclusive_of_taxboolean
True when the line amounts already include tax
metadata array

Returns

Response fieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
referencestringNo
tax_amountnumberNo
currencystringNo
lineitemsAccountingJournalLineitem[]Nonew field name
lineitems[].idstringNo
lineitems[].tax_amountnumberNo
lineitems[].total_amountnumberNowill be a positive value for a debit and negative for a credit
lineitems[].debit_amountnumberNowill replace total_amount (absolute value)
lineitems[].credit_amountnumberNo
lineitems[].descriptionstringNo
lineitems[].account_idstringNo(reference to AccountingAccount)
lineitems[].contact_idstringNo(reference to AccountingContact)
lineitems[].payment_idstringNolink to PaymentPayment (reference to PaymentPayment)
lineitems[].invoice_idstringNo(reference to AccountingInvoice)
lineitems[].category_idsstring[]No(reference to AccountingCategory)
lineitems[].group_idstringNopoints to a HRIS Group (reference to HrisGroup)
lineitems[].project_idstringNo(reference to TaskProject)
lineitems[].organization_idstringNopoints to a AccountingOrganization
lineitems[].taxrate_idstringNoref -> AccountingTaxrate applied to the line
taxrate_idstringNo
descriptionstringNo
posted_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
sourcestringNo
organization_idstringNo
category_idsstring[]No(reference to AccountingCategory)
project_idstringNo(reference to TaskProject)
attachmentsAccountingAttachment[]No
attachments[].idstringNo
attachments[].download_urlstringNo
attachments[].namestringNo
attachments[].mime_typestringNo
total_amountnumberNoTotal of the debit lines; equals the total of the credit lines
exchange_ratenumberNoExchange rate to the base/home currency at the posting date
statusenumNoPosting state of the journal entry Values: DRAFT, POSTED, VOID, OTHER
is_inclusive_of_taxbooleanNoTrue when the line amounts already include tax
metadataAccountingMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
metadata[].slugstringNoThe integration's API name (key) of an existing custom field. List valid slugs for this object with the metadata/metadata endpoint; unknown slugs are rejected by the integration.
metadata[].valueobjectNoThe field's value, typed by format: DATE as ISO-8601 (YYYY-MM-DD, or YYYY-MM-DDTHH:MM:SSZ for date-times); NUMBER, PRICE and CURRENCY as a number; BOOLEAN and YES_NO as true/false; MULTIPLE_SELECT as an array of option values; otherwise a string.
metadata[].namespacestringNo
metadata[].formatenumNoThe data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo

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"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot 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/journal',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?