Journal Entries

Create Journal Entries in batch

Changed on

Create multiple journal entries in a single request. Each item is processed independently, so some may be created while others fail; the response returns 200 with one result per item, in the order the items were sent. The maximum number of items accepted per request depends on the connector.

post/accounting/journal-entries/batch

Request

  • Base URL: https://unify.apideck.com
  • URL: https://unify.apideck.com/accounting/journal-entries/batch
  • Auth: API key in header Authorization

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

x-apideck-company-idstring

The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.

Request body

Example request

{
  "items": [
    {
      "_ref": "item-1",
      "data": {
        "display_id": "12345",
        "title": "Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry",
        "currency_rate": 0.69,
        "currency": "USD",
        "company_id": "12345",
        "subsidiary": {
          "id": "12345",
          "display_id": "123456",
          "name": "Acme Inc."
        },
        "line_items": [
          {
            "id": "12345",
            "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
            "tax_amount": 27500,
            "sub_total": 27500,
            "total_amount": 27500,
            "base_currency_amount": 27500,
            "type": "debit",
            "tax_rate": {
              "id": "123456",
              "code": "N-T",
              "name": "GST on Purchases",
              "rate": 10
            },
            "tax_type": "sales",
            "tracking_category": {
              "id": "123456",
              "name": "New York"
            },
            "tracking_categories": [
              {
                "id": "123456",
                "code": "100",
                "name": "New York",
                "parent_id": "123456",
                "parent_name": "New York"
              }
            ],
            "ledger_account": {
              "id": "123456",
              "name": "Bank account",
              "nominal_code": "N091",
              "code": "453",
              "parent_id": "123456",
              "display_id": "123456"
            },
            "customer": {
              "id": "12345",
              "display_id": "CUST00101",
              "display_name": "Windsurf Shop",
              "name": "Windsurf Shop",
              "company_name": "The boring company",
              "email": "boring@boring.com"
            },
            "supplier": {
              "id": "12345",
              "display_id": "SUPP00101",
              "display_name": "Windsurf Shop",
              "company_name": "The boring company",
              "address": {
                "id": "123",
                "type": "primary",
                "string": "25 Spring Street, Blackburn, VIC 3130",
                "name": "HQ US",
                "line1": "Main street",
                "line2": "apt #",
                "line3": "Suite #",
                "line4": "delivery instructions",
                "line5": "Attention: Finance Dept",
                "street_number": "25",
                "city": "San Francisco",
                "state": "CA",
                "postal_code": "94104",
                "country": "US",
                "latitude": "40.759211",
                "longitude": "-73.984638",
                "county": "Santa Clara",
                "contact_name": "Elon Musk",
                "salutation": "Mr",
                "phone_number": "111-111-1111",
                "fax": "122-111-1111",
                "email": "elon@musk.com",
                "website": "https://elonmusk.com",
                "notes": "Address notes or delivery instructions.",
                "row_version": "1-12345"
              }
            },
            "employee": {
              "id": "12345",
              "display_id": "EH",
              "display_name": "Ester Henderson"
            },
            "department_id": "12345",
            "location_id": "12345",
            "line_number": 1,
            "worktags": [
              {
                "id": "123456",
                "value": "New York"
              }
            ],
            "date": "2020-09-30",
            "source_id": "12345"
          }
        ],
        "status": "draft",
        "memo": "Thank you for your business and have a great day!",
        "posted_at": "2020-09-30T07:43:32.000Z",
        "journal_symbol": "IND",
        "tax_type": "sales",
        "tax_code": "1234",
        "number": "OIT00546",
        "tracking_categories": [
          {
            "id": "123456",
            "code": "100",
            "name": "New York",
            "parent_id": "123456",
            "parent_name": "New York"
          }
        ],
        "accounting_period": "01-24",
        "tax_inclusive": true,
        "attachments": [
          {
            "name": "sample.jpg",
            "mime_type": "image/jpeg",
            "encoding": "base64",
            "content": "data:image/jpeg;base64,...",
            "notes": "A sample image"
          }
        ],
        "source_type": "manual",
        "source_id": "12345",
        "row_version": "1-12345",
        "custom_fields": [
          {
            "id": "2389328923893298",
            "name": "employee_level",
            "ref_name": "Marketing",
            "description": "Employee Level",
            "value": "Uses Salesforce and Marketo"
          }
        ],
        "pass_through": [
          {
            "extend_paths": [
              {
                "path": "$.nested.property",
                "value": {
                  "TaxClassificationRef": {
                    "value": "EUC-99990201-V1-00020000"
                  }
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

Response

Journal Entries batch processed

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "journal-entries",
  "operation": "add",
  "data": [
    {
      "_ref": "item-1",
      "id": "12345",
      "downstream_id": "12345",
      "status": "created",
      "error": {
        "status_code": 502,
        "error": "Bad Gateway",
        "type_name": "PostWriteProcessingError",
        "message": "The record was written, but processing its response failed.",
        "ref": "https://developers.apideck.com/errors#postwriteprocessingerror"
      },
      "warnings": [
        {
          "type": "currency_not_configured",
          "operation": "invoicesAdd",
          "message": "Currency \"CAD\" is not configured for this organization -- the request was sent without currency_id.",
          "status_code": 200
        }
      ]
    }
  ]
}

Changes