Batch Create Journals

POST /unified/accounting/companies/{id}/journals/batch

Batch Create Journals

cURL

curl --request POST \
  --url https://api.stackone.com/unified/accounting/companies/{id}/journals/batch \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-id: <x-account-id>' \
  --data '
{
  "items": [
    {
      "reference": "JRN-2024-001",
      "memo": "Monthly closing entries",
      "currency_code": {
        "value": "USD",
        "source_value": "USD"
      },
      "exchange_rate": 1,
      "transaction_date": "2024-03-20T10:00:00Z",
      "lines": [
        {
          "account_id": "acc_123456789",
          "description": "Payment for office supplies",
          "amount": 10010,
          "tax_rate_id": "tax_123456789",
          "tax_amount": 10010
        }
      ]
    }
  ]
}
'

import requests

url = "https://api.stackone.com/unified/accounting/companies/{id}/journals/batch"

payload = { "items": [
        {
            "reference": "JRN-2024-001",
            "memo": "Monthly closing entries",
            "currency_code": {
                "value": "USD",
                "source_value": "USD"
            },
            "exchange_rate": 1,
            "transaction_date": "2024-03-20T10:00:00Z",
            "lines": [
                {
                    "account_id": "acc_123456789",
                    "description": "Payment for office supplies",
                    "amount": 10010,
                    "tax_rate_id": "tax_123456789",
                    "tax_amount": 10010
                }
            ]
        }
    ] }
headers = {
    "x-account-id": "<x-account-id>",
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-account-id': '<x-account-id>',
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    items: [
      {
        reference: 'JRN-2024-001',
        memo: 'Monthly closing entries',
        currency_code: {value: 'USD', source_value: 'USD'},
        exchange_rate: 1,
        transaction_date: '2024-03-20T10:00:00Z',
        lines: [
          {
            account_id: 'acc_123456789',
            description: 'Payment for office supplies',
            amount: 10010,
            tax_rate_id: 'tax_123456789',
            tax_amount: 10010
          }
        ]
      }
    ]
  })
};

fetch('https://api.stackone.com/unified/accounting/companies/{id}/journals/batch', 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.stackone.com/unified/accounting/companies/{id}/journals/batch",
  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([
    'items' => [
        [
                'reference' => 'JRN-2024-001',
                'memo' => 'Monthly closing entries',
                'currency_code' => [
                                'value' => 'USD',
                                'source_value' => 'USD'
                ],
                'exchange_rate' => 1,
                'transaction_date' => '2024-03-20T10:00:00Z',
                'lines' => [
                                [
                                                                'account_id' => 'acc_123456789',
                                                                'description' => 'Payment for office supplies',
                                                                'amount' => 10010,
                                                                'tax_rate_id' => 'tax_123456789',
                                                                'tax_amount' => 10010
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json",
    "x-account-id: <x-account-id>"
  ],
]);

$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://api.stackone.com/unified/accounting/companies/{id}/journals/batch"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"reference\": \"JRN-2024-001\",\n      \"memo\": \"Monthly closing entries\",\n      \"currency_code\": {\n        \"value\": \"USD\",\n        \"source_value\": \"USD\"\n      },\n      \"exchange_rate\": 1,\n      \"transaction_date\": \"2024-03-20T10:00:00Z\",\n      \"lines\": [\n        {\n          \"account_id\": \"acc_123456789\",\n          \"description\": \"Payment for office supplies\",\n          \"amount\": 10010,\n          \"tax_rate_id\": \"tax_123456789\",\n          \"tax_amount\": 10010\n        }\n      ]\n    }\n  ]\n}")

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

	req.Header.Add("x-account-id", "<x-account-id>")
	req.Header.Add("Authorization", "Basic <encoded-value>")
	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://api.stackone.com/unified/accounting/companies/{id}/journals/batch")
  .header("x-account-id", "<x-account-id>")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"reference\": \"JRN-2024-001\",\n      \"memo\": \"Monthly closing entries\",\n      \"currency_code\": {\n        \"value\": \"USD\",\n        \"source_value\": \"USD\"\n      },\n      \"exchange_rate\": 1,\n      \"transaction_date\": \"2024-03-20T10:00:00Z\",\n      \"lines\": [\n        {\n          \"account_id\": \"acc_123456789\",\n          \"description\": \"Payment for office supplies\",\n          \"amount\": 10010,\n          \"tax_rate_id\": \"tax_123456789\",\n          \"tax_amount\": 10010\n        }\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.stackone.com/unified/accounting/companies/{id}/journals/batch")

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

request = Net::HTTP::Post.new(url)
request["x-account-id"] = '<x-account-id>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"items\": [\n    {\n      \"reference\": \"JRN-2024-001\",\n      \"memo\": \"Monthly closing entries\",\n      \"currency_code\": {\n        \"value\": \"USD\",\n        \"source_value\": \"USD\"\n      },\n      \"exchange_rate\": 1,\n      \"transaction_date\": \"2024-03-20T10:00:00Z\",\n      \"lines\": [\n        {\n          \"account_id\": \"acc_123456789\",\n          \"description\": \"Payment for office supplies\",\n          \"amount\": 10010,\n          \"tax_rate_id\": \"tax_123456789\",\n          \"tax_amount\": 10010\n        }\n      ]\n    }\n  ]\n}"

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

202

{
  "statusCode": 202,
  "message": "Batch operation accepted",
  "timestamp": "2021-01-01T01:01:01.000Z",
  "errors": [
    [
      "Missing field: name"
    ],
    [],
    []
  ]
}

{
  "statusCode": 400,
  "message": "Bad Request",
  "timestamp": "2023-05-30T00:00:00.000Z",
  "data": {
    "statusCode": 400,
    "message": "Bad Request",
    "headers": {
      "content-type": "application/json",
      "x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
    }
  },
  "provider_errors": [
    {
      "status": 400,
      "url": "https://api.provider.com/v1/resource",
      "raw": {
        "message": "Invalid input parameters"
      },
      "headers": {
        "content-type": "application/json",
        "x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
      }
    }
  ]
}

{
  "statusCode": 401,
  "message": "Unauthorized",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 403,
  "message": "Forbidden resource",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 404,
  "message": "Not Found",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 408,
  "message": "Request timed out",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 409,
  "message": "Conflict",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 412,
  "message": "Precondition failed",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 422,
  "message": "Unprocessable Entity",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 429,
  "message": "Too many requests",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 500,
  "message": "Internal server error",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 501,
  "message": "Not Implemented",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 502,
  "message": "Bad Gateway",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id · string · required

The account identifier

Prefer · string

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Example:

"heartbeat"

Path Parameters

id · string · required

Body

application/json

items · object[] · required

The batch of journals to create

Show child attributes

Response

202

application/json

Batch operation accepted

statusCode · number | null

Example:

202

message · string | null

Example:

"Batch operation accepted"

timestamp · string<date-time> | null

Example:

"2021-01-01T01:01:01.000Z"

errors · string[][] | null

Example:

[["Missing field: name"], [], []]