Accounting API Reference

One single API to push and pull data from multiple connectors.

10.9.0

Introduction

Welcome to the Accounting API.

You can use this API to access all Accounting API endpoints.

Base URL

The base URL for all API requests is https://unify.apideck.com

Headers

Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive.

Name Type Required Description
x-apideck-consumer-id String Yes The id of the customer stored inside Apideck Vault. This can be a user id, account id, device id or whatever entity that can have integration within your app.
x-apideck-service-id String No Describe the service you want to call (e.g., pipedrive). Only needed when a customer has activated multiple integrations for the same Unified API.
x-apideck-raw Boolean No Include raw response. Mostly used for debugging purposes.
x-apideck-app-id String Yes The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys.
Authorization String Yes Bearer API KEY

Authorization

You can interact with the API through the authorization methods below.

apiKey

To access our API, you need to sign up and obtain your unique API key. Each Unify application is assigned a single API key. You can locate your API key in the Configuration Settings section of your Apideck application. Additionally, your application’s application_id is available on the same page.

Authenticate your API requests by including your test or live secret API key in the request header.

  • Bearer authorization header: Authorization: Bearer "YOUR_API_KEY_HERE"
  • Application id header: x-apideck-app-id: "YOUR_APP_ID_HERE"

You should use the public keys on the SDKs and the secret keys to authenticate API requests.

Do not share or include your secret API keys on client side code. Your API keys carry significant privileges. Please ensure to keep them 100% secure and be sure to not share your secret API keys in areas that are publicly accessible like GitHub.

Learn how to set the Authorization header inside Postman https://learning.postman.com/docs/postman/sending-api-requests/authorization/#api-key

Go to Unify to grab your API KEY https://app.apideck.com/unify/api-keys

Security Scheme Type API Key
Header parameter name Authorization

Pagination

All API resources have support for bulk retrieval via list APIs. Apideck uses cursor-based pagination via the optional cursor and limit parameters.

To fetch the first page of results, call the list API without a cursor parameter. Afterwards you can fetch subsequent pages by providing a cursor parameter. You will find the next cursor in the response body in meta.cursors.next. If meta.cursors.next is null you're at the end of the list.

In the REST API you can also use the links from the response for added convenience. Simply call the URL in links.next to get the next page of results.

Query Parameters

Name Type Required Description
cursor String No Cursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response.
limit Number No Number of results to return. Minimum 1, Maximum 200, Default 20

Response Body

Name Type Description
meta.cursors.previous String Cursor to navigate to the previous page of results through the API
meta.cursors.current String Cursor to navigate to the current page of results through the API
meta.cursors.next String Cursor to navigate to the next page of results through the API
meta.items_on_page Number Number of items returned in the data property of the response
links.previous String Link to navigate to the previous page of results through the API
links.current String Link to navigate to the current page of results through the API
links.next String Link to navigate to the next page of results through the API

⚠️ meta.cursors.previous/links.previous is not available for all connectors.

SDKs and API Clients

We currently offer a Node.js, PHP, Python and .NET SDK. Need another SDK? Request the SDK of your choice.

Debugging

Because of the nature of the abstraction we do in Apideck Unify we still provide the option to the receive raw requests and responses being handled underlying. By including the raw flag ?raw=true in your requests you can still receive the full request. Please note that this increases the response size and can introduce extra latency.

Errors

The API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below.

Code Title Description
200 OK The request message has been successfully processed, and it has produced a response. The response message varies, depending on the request method and the requested data.
201 Created The request has been fulfilled and has resulted in one or more new resources being created.
204 No Content The server has successfully fulfilled the request and that there is no additional content to send in the response payload body.
400 Bad Request The receiving server cannot understand the request because of malformed syntax. Do not repeat the request without first modifying it; check the request for errors, fix them and then retry the request.
401 Unauthorized The request has not been applied because it lacks valid authentication credentials for the target resource.
402 Payment Required Subscription data is incomplete or out of date. You'll need to provide payment details to continue.
403 Forbidden You do not have the appropriate user rights to access the request. Do not repeat the request.
404 Not Found The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.
409 Conflict The request could not be completed due to a conflict with the current state of the target resource.
422 Unprocessable Entity The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions.
429 Too Many Requests You sent too many requests in a given amount of time ("rate limit"). Try again later
5xx Server Errors Something went wrong with the Unify API. These errors are logged on our side. You can contact our team to resolve the issue.

Handling errors

The Unify API and SDKs can produce errors for many reasons, such as a failed requests due to misconfigured integrations, invalid parameters, authentication errors, and network unavailability.

Error Types

RequestValidationError

Request is not valid for the current endpoint. The response body will include details on the validation error. Check the spelling and types of your attributes, and ensure you are not passing data that is outside of the specification.

UnsupportedFiltersError

Filters in the request are valid, but not supported by the connector. Remove the unsupported filter(s) to get a successful response.

UnsupportedSortFieldError

Sort field (sort[by]) in the request is valid, but not supported by the connector. Replace or remove the sort field to get a successful response.

InvalidCursorError

Pagination cursor in the request is not valid for the current connector. Make sure to use a cursor returned from the API, for the same connector.

ConnectorExecutionError

A Unified API request made via one of our downstream connectors returned an unexpected error. The status_code returned is proxied through to error response along with their original response via the error detail.

UnauthorizedError

We were unable to authorize the request as made. This can happen for a number of reasons, from missing header params to passing an incorrect authorization token. Verify your Api Key is being set correctly in the authorization header. ie: Authorization: 'Bearer sk_live_***'

ConnectorCredentialsError

A request using a given connector has not been authorized. Ensure the connector you are trying to use has been configured correctly and been authorized for use.

ConnectorDisabledError

A request has been made to a connector that has since been disabled. This may be temporary - You can contact our team to resolve the issue.

ConnectorRateLimitError

You sent too many request to a connector. These rate limits vary from connector to connector. You will need to try again later.

RequestLimitError

You have reached the number of requests included in your Free Tier Subscription. You will not be able to make further requests until you upgrade your subscription. Please reach out to sales@apideck.com to continue making requests.

EntityNotFoundError

You've made a request for a resource or route that does not exist. Verify your path parameters or any identifiers used to fetch this resource.

OAuthCredentialsNotFoundError

When adding a connector integration that implements OAuth, both a client_id and client_secret must be provided before any authorizations can be performed. Verify the integration has been configured properly before continuing.

IntegrationNotFoundError

The requested connector integration could not be found associated to your application_id. Verify your application_id is correct, and that this connector has been added and configured for your application.

ConnectionNotFoundError

A valid connection could not be found associated to your application_id. Something may have interrupted the authorization flow. You may need to start the connector authorization process again.

ConnectionSettingsError

The connector has required settings that were not supplied. Verify connection.settings contains all required settings for the connector to be callable.

ConnectorNotFoundError

A request was made for an unknown connector. Verify your service_id is spelled correctly, and that this connector is enabled for your provided unified_api.

OAuthRedirectUriError

A request was made either in a connector authorization flow, or attempting to revoke connector access without a valid redirect_uri. This is the url the user should be returned to on completion of process.

OAuthInvalidStateError

The state param is required and is used to ensure the outgoing authorization state has not been altered before the user is redirected back. It also contains required params needed to identify the connector being used. If this has been altered, the authorization will not succeed.

OAuthCodeExchangeError

When attempting to exchange the authorization code for an access_token during an OAuth flow, an error occurred. This may be temporary. You can reattempt authorization or contact our team to resolve the issue.

OAuthConnectorError

It seems something went wrong on the connector side. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

MappingError

There was an error attempting to retrieve the mapping for a given attribute. We've been notified and are working to fix this issue.

ConnectorMappingNotFoundError

It seems the implementation for this connector is incomplete. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

ConnectorResponseMappingNotFoundError

We were unable to retrieve the response mapping for this connector. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

ConnectorOperationMappingNotFoundError

Connector mapping has not been implemented for the requested operation. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

ConnectorWorkflowMappingError

The composite api calls required for this operation have not been mapped entirely. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

ConnectorOperationUnsupportedError

You're attempting a call that is not supported by the connector. It's likely this operation is supported by another connector, but we're unable to implement for this one.

PaginationNotSupportedError

Pagination is not yet supported for this connector, try removing limit and/or cursor from the query. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

API Design

API Styles and data formats

REST API

The API is organized around REST, providing simple and predictable URIs to access and modify objects. Requests support standard HTTP methods like GET, PUT, POST, and DELETE and standard status codes. JSON is returned by all API responses, including errors. In all API requests, you must set the content-type HTTP header to application/json. All API requests must be made over HTTPS. Calls made over HTTP will fail.

Available HTTP methods

The Apideck API uses HTTP verbs to understand if you want to read (GET), delete (DELETE) or create (POST) an object. When your web application cannot do a POST or DELETE, we provide the ability to set the method through the query parameter _method.

POST /messages
GET /messages
GET /messages/{messageId}
PATCH /messages/{messageId}
DELETE /messages/{messageId}

Response bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. For some endpoints and use cases we divert from REST to provide a better developer experience.

Schema

All API requests and response bodies adhere to a common JSON format representing individual items, collections of items, links to related items and additional meta data.

Meta

Meta data can be represented as a top level member named “meta”. Any information may be provided in the meta data. It’s most common use is to return the total number of records when requesting a collection of resources.

Request IDs

Each API request has an associated request identifier. You can find this value in the response headers, under Request-Id. You can also find request identifiers in the URLs of individual request logs in your Dashboard. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.

Fixed field types

Dates

The dates returned by the API are all represented in UTC (ISO8601 format).

This example 2019-11-14T00:55:31.820Z is defined by the ISO 8601 standard. The T in the middle separates the year-month-day portion from the hour-minute-second portion. The Z on the end means UTC, that is, an offset-from-UTC of zero hours-minutes-seconds. The Z is pronounced "Zulu" per military/aviation tradition.

The ISO 8601 standard is more modern. The formats are wisely designed to be easy to parse by machine as well as easy to read by humans across cultures.

Prices and Currencies

All prices returned by the API are represented as integer amounts in a currency’s smallest unit. For example, $5 USD would be returned as 500 (i.e, 500 cents).

For zero-decimal currencies, amounts will still be provided as an integer but without the need to divide by 100. For example, an amount of ¥5 (JPY) would be returned as 5.

All currency codes conform to ISO 4217.

Support

If you have problems or need help with your case, you can always reach out to our Support.

Static IP

Some of the APIs you want to use can require a static IP. Apideck's static IP feature allows you to use Apideck with a fixed IP avoiding the need for you to set up your own infrastructure. This feature is currently available to all Apideck customers. To use this feature, the API Vendor will need to whitelist the associated static IP addresses. The provided static IP addresses are fixed to their specified region and shared by all customers who use this feature.

Bills

The Bills model

idstring

A unique identifier for an object.

downstream_idstring or null

The third-party API ID of original entity

bill_numberstring or null

Reference to supplier bill number

supplierobject or null

The supplier this entity is linked to.

company_idstring or null

The company or subsidiary id the transaction belongs to

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

Bills example
{}

List Bills

get
https://unify.apideck.com/accounting/bills

List Bills

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

filterobjectfilter[updated_since]=2020-09-30T07:43:32.000Z

Apply filters

sortobjectsort[by]=updated_at

Apply sorting

pass_throughobjectpass_through[example_downstream_property]=example_downstream_property

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Bills
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clear Books
Exact Online
Exact Online NL
Exact Online UK
FreeAgent
FreshBooks
Microsoft Dynamics 365 Business Central
MRI Software
NetSuite
Procountor
QuickBooks
Sage Business Cloud Accounting
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
Kashflow
Request
MYOB
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.billsAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "bills",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "downstream_id": "12345",
      "bill_number": "10001",
      "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",
          "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"
        }
      },
      "company_id": "12345",
      "currency": "USD",
      "currency_rate": 0.69,
      "tax_inclusive": true,
      "bill_date": "2020-09-30",
      "due_date": "2020-10-30",
      "paid_date": "2020-10-30",
      "po_number": "90000117",
      "reference": "123456",
      "line_items": [
        {
          "id": "12345",
          "row_id": "12345",
          "code": "120-C",
          "line_number": 1,
          "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
          "type": "expense_account",
          "tax_amount": 27500,
          "total_amount": 27500,
          "quantity": 1,
          "unit_price": 27500.5,
          "unit_of_measure": "pc.",
          "discount_percentage": 0.01,
          "discount_amount": 19.99,
          "location_id": "1234",
          "department_id": "1234",
          "item": {
            "id": "12344",
            "code": "120-C",
            "name": "Model Y"
          },
          "tax_rate": {
            "id": "123456",
            "code": "N-T",
            "name": "GST on Purchases",
            "rate": 10
          },
          "ledger_account": {
            "id": "123456",
            "name": "Bank account",
            "nominal_code": "N091",
            "code": "453"
          },
          "tracking_categories": [
            {
              "id": "123456",
              "name": "New York"
            }
          ],
          "row_version": "1-12345",
          "updated_by": "12345",
          "created_by": "12345",
          "created_at": "2020-09-30T07:43:32.000Z",
          "updated_at": "2020-09-30T07:43:32.000Z"
        }
      ],
      "terms": "Net 30 days",
      "balance": 27500,
      "deposit": 0,
      "sub_total": 27500,
      "total_tax": 2500,
      "total": 27500,
      "tax_code": "1234",
      "notes": "Some notes about this bill.",
      "status": "draft",
      "ledger_account": {
        "id": "123456",
        "name": "Bank account",
        "nominal_code": "N091",
        "code": "453"
      },
      "payment_method": "cash",
      "channel": "email",
      "language": "EN",
      "accounting_by_row": false,
      "bank_account": {
        "bank_name": "Monzo",
        "account_number": "123465",
        "account_name": "SPACEX LLC",
        "account_type": "credit_card",
        "iban": "CH2989144532982975332",
        "bic": "AUDSCHGGXXX",
        "routing_number": "012345678",
        "bsb_number": "062-001",
        "branch_identifier": "001",
        "bank_code": "BNH",
        "currency": "USD"
      },
      "discount_percentage": 5.5,
      "tracking_categories": [
        {
          "id": "123456",
          "name": "New York"
        }
      ],
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z",
      "row_version": "1-12345",
      "custom_mappings": {},
      "accounting_period": "01-24"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create Bill

post
https://unify.apideck.com/accounting/bills

Create Bill

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
bill_numberstring or null

Reference to supplier bill number

supplierobject or null

The supplier this entity is linked to.

company_idstring or null

The company or subsidiary id the transaction belongs to

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

currency_ratenumber or null

Currency Exchange Rate at the time entity was recorded/generated.

tax_inclusiveboolean or null

Amounts are including tax

bill_datestring

Date bill was issued - YYYY-MM-DD.

due_datestring

The due date is the date on which a payment is scheduled to be received - YYYY-MM-DD.

paid_datestring or null

The paid date is the date on which a payment was sent to the supplier - YYYY-MM-DD.

po_numberstring or null

A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order.

referencestring or null

Optional bill reference.

line_itemsobjects
termsstring or null

Terms of payment.

balancenumber or null

Balance of bill due.

depositnumber or null

Amount of deposit made to this bill.

sub_totalnumber or null

Sub-total amount, normally before tax.

total_taxnumber or null

Total tax amount applied to this bill.

totalnumber or null

Total amount of bill, including tax.

tax_codestring or null

Applicable tax id/code override if tax is not supplied on a line item basis.

notesstring or null
statusstring or null
Enum:draftsubmittedauthorisedpartially_paid

Invoice status

ledger_accountobject or null
payment_methodstring or null

Payment method used for the transaction, such as cash, credit card, bank transfer, or check

channelstring or null

The channel through which the transaction is processed.

languagestring or null

language code according to ISO 639-1. For the United States - EN

accounting_by_rowboolean or null

Indicates if accounting by row is used (true) or not (false). Accounting by row means that a separate ledger transaction is created for each row.

bank_accountobject
discount_percentagenumber or null

Discount percentage applied to this transaction.

tracking_categoriesobjects or null or null

A list of linked tracking categories.

row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

accounting_periodstring or null

Accounting period

Responses

201Bill created
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Microsoft Dynamics 365 Business Central
MRI Software
NetSuite
Procountor
QuickBooks
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
MYOB
Request
Sage Business Cloud Accounting
Request

Request example

{
  "bill_number": "10001",
  "supplier": {
    "id": "12345",
    "display_name": "Windsurf Shop",
    "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",
      "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"
    }
  },
  "company_id": "12345",
  "currency": "USD",
  "currency_rate": 0.69,
  "tax_inclusive": true,
  "bill_date": "2020-09-30",
  "due_date": "2020-10-30",
  "paid_date": "2020-10-30",
  "po_number": "90000117",
  "reference": "123456",
  "line_items": [
    {
      "row_id": "12345",
      "code": "120-C",
      "line_number": 1,
      "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
      "type": "expense_account",
      "tax_amount": 27500,
      "total_amount": 27500,
      "quantity": 1,
      "unit_price": 27500.5,
      "unit_of_measure": "pc.",
      "discount_percentage": 0.01,
      "discount_amount": 19.99,
      "location_id": "1234",
      "department_id": "1234",
      "item": {
        "id": "12344",
        "code": "120-C",
        "name": "Model Y"
      },
      "tax_rate": {
        "id": "123456",
        "rate": 10
      },
      "ledger_account": {
        "id": "123456",
        "nominal_code": "N091",
        "code": "453"
      },
      "tracking_categories": [
        {
          "id": "123456",
          "name": "New York"
        }
      ],
      "row_version": "1-12345"
    }
  ],
  "terms": "Net 30 days",
  "balance": 27500,
  "deposit": 0,
  "sub_total": 27500,
  "total_tax": 2500,
  "total": 27500,
  "tax_code": "1234",
  "notes": "Some notes about this bill.",
  "status": "draft",
  "ledger_account": {
    "id": "123456",
    "nominal_code": "N091",
    "code": "453"
  },
  "payment_method": "cash",
  "channel": "email",
  "language": "EN",
  "accounting_by_row": false,
  "bank_account": {
    "bank_name": "Monzo",
    "account_number": "123465",
    "account_name": "SPACEX LLC",
    "account_type": "credit_card",
    "iban": "CH2989144532982975332",
    "bic": "AUDSCHGGXXX",
    "routing_number": "012345678",
    "bsb_number": "062-001",
    "branch_identifier": "001",
    "bank_code": "BNH",
    "currency": "USD"
  },
  "discount_percentage": 5.5,
  "tracking_categories": [
    {
      "id": "123456",
      "name": "New York"
    }
  ],
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ],
  "accounting_period": "01-24"
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "bills",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get Bill

get
https://unify.apideck.com/accounting/bills/{id}

Get Bill

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Bill
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clear Books
Exact Online
Exact Online NL
Exact Online UK
FreeAgent
FreshBooks
Microsoft Dynamics 365 Business Central
MRI Software
NetSuite
Procountor
QuickBooks
Sage Business Cloud Accounting
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
Kashflow
Request
MYOB
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.billsOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "bills",
  "operation": "one",
  "data": {
    "id": "12345",
    "downstream_id": "12345",
    "bill_number": "10001",
    "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",
        "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"
      }
    },
    "company_id": "12345",
    "currency": "USD",
    "currency_rate": 0.69,
    "tax_inclusive": true,
    "bill_date": "2020-09-30",
    "due_date": "2020-10-30",
    "paid_date": "2020-10-30",
    "po_number": "90000117",
    "reference": "123456",
    "line_items": [
      {
        "id": "12345",
        "row_id": "12345",
        "code": "120-C",
        "line_number": 1,
        "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
        "type": "expense_account",
        "tax_amount": 27500,
        "total_amount": 27500,
        "quantity": 1,
        "unit_price": 27500.5,
        "unit_of_measure": "pc.",
        "discount_percentage": 0.01,
        "discount_amount": 19.99,
        "location_id": "1234",
        "department_id": "1234",
        "item": {
          "id": "12344",
          "code": "120-C",
          "name": "Model Y"
        },
        "tax_rate": {
          "id": "123456",
          "code": "N-T",
          "name": "GST on Purchases",
          "rate": 10
        },
        "ledger_account": {
          "id": "123456",
          "name": "Bank account",
          "nominal_code": "N091",
          "code": "453"
        },
        "tracking_categories": [
          {
            "id": "123456",
            "name": "New York"
          }
        ],
        "row_version": "1-12345",
        "updated_by": "12345",
        "created_by": "12345",
        "created_at": "2020-09-30T07:43:32.000Z",
        "updated_at": "2020-09-30T07:43:32.000Z"
      }
    ],
    "terms": "Net 30 days",
    "balance": 27500,
    "deposit": 0,
    "sub_total": 27500,
    "total_tax": 2500,
    "total": 27500,
    "tax_code": "1234",
    "notes": "Some notes about this bill.",
    "status": "draft",
    "ledger_account": {
      "id": "123456",
      "name": "Bank account",
      "nominal_code": "N091",
      "code": "453"
    },
    "payment_method": "cash",
    "channel": "email",
    "language": "EN",
    "accounting_by_row": false,
    "bank_account": {
      "bank_name": "Monzo",
      "account_number": "123465",
      "account_name": "SPACEX LLC",
      "account_type": "credit_card",
      "iban": "CH2989144532982975332",
      "bic": "AUDSCHGGXXX",
      "routing_number": "012345678",
      "bsb_number": "062-001",
      "branch_identifier": "001",
      "bank_code": "BNH",
      "currency": "USD"
    },
    "discount_percentage": 5.5,
    "tracking_categories": [
      {
        "id": "123456",
        "name": "New York"
      }
    ],
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z",
    "row_version": "1-12345",
    "custom_mappings": {},
    "accounting_period": "01-24"
  }
}

Update Bill

patch
https://unify.apideck.com/accounting/bills/{id}

Update Bill

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
bill_numberstring or null

Reference to supplier bill number

supplierobject or null

The supplier this entity is linked to.

company_idstring or null

The company or subsidiary id the transaction belongs to

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

currency_ratenumber or null

Currency Exchange Rate at the time entity was recorded/generated.

tax_inclusiveboolean or null

Amounts are including tax

bill_datestring

Date bill was issued - YYYY-MM-DD.

due_datestring

The due date is the date on which a payment is scheduled to be received - YYYY-MM-DD.

paid_datestring or null

The paid date is the date on which a payment was sent to the supplier - YYYY-MM-DD.

po_numberstring or null

A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order.

referencestring or null

Optional bill reference.

line_itemsobjects
termsstring or null

Terms of payment.

balancenumber or null

Balance of bill due.

depositnumber or null

Amount of deposit made to this bill.

sub_totalnumber or null

Sub-total amount, normally before tax.

total_taxnumber or null

Total tax amount applied to this bill.

totalnumber or null

Total amount of bill, including tax.

tax_codestring or null

Applicable tax id/code override if tax is not supplied on a line item basis.

notesstring or null
statusstring or null
Enum:draftsubmittedauthorisedpartially_paid

Invoice status

ledger_accountobject or null
payment_methodstring or null

Payment method used for the transaction, such as cash, credit card, bank transfer, or check

channelstring or null

The channel through which the transaction is processed.

languagestring or null

language code according to ISO 639-1. For the United States - EN

accounting_by_rowboolean or null

Indicates if accounting by row is used (true) or not (false). Accounting by row means that a separate ledger transaction is created for each row.

bank_accountobject
discount_percentagenumber or null

Discount percentage applied to this transaction.

tracking_categoriesobjects or null or null

A list of linked tracking categories.

row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

accounting_periodstring or null

Accounting period

Responses

200Bill Updated
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Microsoft Dynamics 365 Business Central
NetSuite
Procountor
QuickBooks
Sage Intacct
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
MRI Software
Request
MYOB
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request

Request example

{
  "bill_number": "10001",
  "supplier": {
    "id": "12345",
    "display_name": "Windsurf Shop",
    "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",
      "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"
    }
  },
  "company_id": "12345",
  "currency": "USD",
  "currency_rate": 0.69,
  "tax_inclusive": true,
  "bill_date": "2020-09-30",
  "due_date": "2020-10-30",
  "paid_date": "2020-10-30",
  "po_number": "90000117",
  "reference": "123456",
  "line_items": [
    {
      "row_id": "12345",
      "code": "120-C",
      "line_number": 1,
      "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
      "type": "expense_account",
      "tax_amount": 27500,
      "total_amount": 27500,
      "quantity": 1,
      "unit_price": 27500.5,
      "unit_of_measure": "pc.",
      "discount_percentage": 0.01,
      "discount_amount": 19.99,
      "location_id": "1234",
      "department_id": "1234",
      "item": {
        "id": "12344",
        "code": "120-C",
        "name": "Model Y"
      },
      "tax_rate": {
        "id": "123456",
        "rate": 10
      },
      "ledger_account": {
        "id": "123456",
        "nominal_code": "N091",
        "code": "453"
      },
      "tracking_categories": [
        {
          "id": "123456",
          "name": "New York"
        }
      ],
      "row_version": "1-12345"
    }
  ],
  "terms": "Net 30 days",
  "balance": 27500,
  "deposit": 0,
  "sub_total": 27500,
  "total_tax": 2500,
  "total": 27500,
  "tax_code": "1234",
  "notes": "Some notes about this bill.",
  "status": "draft",
  "ledger_account": {
    "id": "123456",
    "nominal_code": "N091",
    "code": "453"
  },
  "payment_method": "cash",
  "channel": "email",
  "language": "EN",
  "accounting_by_row": false,
  "bank_account": {
    "bank_name": "Monzo",
    "account_number": "123465",
    "account_name": "SPACEX LLC",
    "account_type": "credit_card",
    "iban": "CH2989144532982975332",
    "bic": "AUDSCHGGXXX",
    "routing_number": "012345678",
    "bsb_number": "062-001",
    "branch_identifier": "001",
    "bank_code": "BNH",
    "currency": "USD"
  },
  "discount_percentage": 5.5,
  "tracking_categories": [
    {
      "id": "123456",
      "name": "New York"
    }
  ],
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ],
  "accounting_period": "01-24"
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "bills",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete Bill

delete
https://unify.apideck.com/accounting/bills/{id}

Delete Bill

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200Bill deleted
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
Microsoft Dynamics 365 Business Central
QuickBooks
Sage Intacct
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.billsDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "bills",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Company Info

The Company Info model

idstring

A unique identifier for an object.

company_namestring or null

The name of the company.

statusstring
Enum:activeinactive

Based on the status some functionality is enabled or disabled.

legal_namestring

The legal name of the company

countrystring or null

country code according to ISO 3166-1 alpha-2.

sales_tax_numberstring or null
Company Info example
{}

Get company info

get
https://unify.apideck.com/accounting/company-info

Get company info

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200CompanyInfo
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreeAgent
Kashflow
Microsoft Dynamics 365 Business Central
MYOB
Procountor
QuickBooks
Xero
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreshBooks
Request
MRI Software
Request
NetSuite
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Zoho Books
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.companyInfoOne({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "company-info",
  "operation": "one",
  "data": {
    "id": "12345",
    "company_name": "SpaceX",
    "status": "active",
    "legal_name": "SpaceX Inc.",
    "country": "US",
    "sales_tax_number": "111.222.333",
    "automated_sales_tax": true,
    "sales_tax_enabled": true,
    "default_sales_tax": {
      "id": "1234",
      "name": "GST on Purchases",
      "code": "ABN",
      "description": "Reduced rate GST Purchases",
      "effective_tax_rate": 10,
      "total_tax_rate": 10,
      "tax_payable_account_id": "123456",
      "tax_remitted_account_id": "123456",
      "components": [
        {
          "id": "10",
          "name": "GST",
          "rate": 10,
          "compound": true
        }
      ],
      "type": "NONE",
      "report_tax_type": "NONE",
      "original_tax_rate_id": "12345",
      "status": "active",
      "custom_mappings": {},
      "row_version": "1-12345",
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z",
      "pass_through": [
        {
          "service_id": "string",
          "operation_id": "string",
          "extend_object": {},
          "extend_paths": [
            {
              "path": "$.nested.property",
              "value": {
                "TaxClassificationRef": {
                  "value": "EUC-99990201-V1-00020000"
                }
              }
            }
          ]
        }
      ],
      "subsidiaries": [
        {
          "id": "string"
        }
      ]
    },
    "currency": "USD",
    "language": "EN",
    "fiscal_year_start_month": "January",
    "company_start_date": "2015-06-05",
    "addresses": [
      {
        "id": "123",
        "type": "primary",
        "string": "25 Spring Street, Blackburn, VIC 3130",
        "name": "HQ US",
        "line1": "Main street",
        "line2": "apt #",
        "line3": "Suite #",
        "line4": "delivery instructions",
        "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"
      }
    ],
    "phone_numbers": [
      {
        "id": "12345",
        "country_code": "1",
        "area_code": "323",
        "number": "111-111-1111",
        "extension": "105",
        "type": "primary"
      }
    ],
    "emails": [
      {
        "id": "123",
        "email": "elon@musk.com",
        "type": "primary"
      }
    ],
    "custom_mappings": {},
    "row_version": "1-12345",
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z"
  }
}

Credit Notes

The Credit Notes model

idstring
required

Unique identifier representing the entity

numberstring or null

Credit note number.

customerobject or null

The customer this entity is linked to.

company_idstring or null

The company or subsidiary id the transaction belongs to

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

currency_ratenumber or null

Currency Exchange Rate at the time entity was recorded/generated.

Credit Notes example
{}

List Credit Notes

get
https://unify.apideck.com/accounting/credit-notes

List Credit Notes

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

filterobjectfilter[updated_since]=2020-09-30T07:43:32.000Z

Apply filters

sortobjectsort[by]=updated_at

Apply sorting

pass_throughobjectpass_through[example_downstream_property]=example_downstream_property

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Credit Notes
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clear Books
Exact Online
Exact Online NL
Exact Online UK
FreeAgent
FreshBooks
Kashflow
Microsoft Dynamics 365 Business Central
NetSuite
QuickBooks
Sage Business Cloud Accounting
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
MRI Software
Request
MYOB
Request
Procountor
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.creditNotesAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "credit-notes",
  "operation": "all",
  "data": [
    {
      "id": "123456",
      "number": "OIT00546",
      "customer": {
        "id": "12345",
        "display_id": "CUST00101",
        "display_name": "Windsurf Shop",
        "name": "Windsurf Shop",
        "company_name": "The boring company",
        "email": "boring@boring.com"
      },
      "company_id": "12345",
      "currency": "USD",
      "currency_rate": 0.69,
      "tax_inclusive": true,
      "sub_total": 27500,
      "total_amount": 49.99,
      "total_tax": 2500,
      "tax_code": "1234",
      "balance": 27500,
      "remaining_credit": 27500,
      "status": "authorised",
      "reference": "123456",
      "date_issued": "2021-05-01T12:00:00.000Z",
      "date_paid": "2021-05-01T12:00:00.000Z",
      "type": "accounts_receivable_credit",
      "account": {
        "id": "123456",
        "name": "Bank account",
        "nominal_code": "N091",
        "code": "453"
      },
      "line_items": [
        {
          "id": "12345",
          "row_id": "12345",
          "code": "120-C",
          "line_number": 1,
          "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
          "type": "sales_item",
          "tax_amount": 27500,
          "total_amount": 27500,
          "quantity": 1,
          "unit_price": 27500.5,
          "unit_of_measure": "pc.",
          "discount_percentage": 0.01,
          "discount_amount": 19.99,
          "location_id": "1234",
          "department_id": "1234",
          "item": {
            "id": "12344",
            "code": "120-C",
            "name": "Model Y"
          },
          "tax_rate": {
            "id": "123456",
            "code": "N-T",
            "name": "GST on Purchases",
            "rate": 10
          },
          "tracking_categories": [
            {
              "id": "123456",
              "name": "New York"
            }
          ],
          "ledger_account": {
            "id": "123456",
            "name": "Bank account",
            "nominal_code": "N091",
            "code": "453"
          },
          "custom_fields": [
            {
              "id": "2389328923893298",
              "name": "employee_level",
              "description": "Employee Level",
              "value": "Uses Salesforce and Marketo"
            }
          ],
          "row_version": "1-12345",
          "updated_by": "12345",
          "created_by": "12345",
          "created_at": "2020-09-30T07:43:32.000Z",
          "updated_at": "2020-09-30T07:43:32.000Z"
        }
      ],
      "allocations": [
        {
          "id": "123456",
          "type": "invoice",
          "code": "N091",
          "amount": 49.99,
          "allocation_id": "123456"
        }
      ],
      "note": "Some notes about this credit note",
      "terms": "Some terms about this credit note",
      "billing_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",
        "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"
      },
      "shipping_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",
        "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"
      },
      "tracking_categories": [
        {
          "id": "123456",
          "name": "New York"
        }
      ],
      "custom_mappings": {},
      "custom_fields": [
        {
          "id": "2389328923893298",
          "name": "employee_level",
          "description": "Employee Level",
          "value": "Uses Salesforce and Marketo"
        }
      ],
      "row_version": "1-12345",
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create Credit Note

post
https://unify.apideck.com/accounting/credit-notes

Create Credit Note

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
numberstring or null

Credit note number.

customerobject or null

The customer this entity is linked to.

company_idstring or null

The company or subsidiary id the transaction belongs to

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

currency_ratenumber or null

Currency Exchange Rate at the time entity was recorded/generated.

tax_inclusiveboolean or null

Amounts are including tax

sub_totalnumber or null

Sub-total amount, normally before tax.

total_amountnumber
required

Amount of transaction

total_taxnumber or null

Total tax amount applied to this invoice.

tax_codestring or null

Applicable tax id/code override if tax is not supplied on a line item basis.

balancenumber or null

The balance reflecting any payments made against the transaction.

remaining_creditnumber or null

Indicates the total credit amount still available to apply towards the payment.

statusstring
Enum:draftauthorisedpaidvoided

Status of credit notes

referencestring or null

Optional reference message ie: Debit remittance detail.

date_issuedstring

Date credit note issued - YYYY:MM::DDThh:mm:ss.sTZD

date_paidstring or null

Date credit note paid - YYYY:MM::DDThh:mm:ss.sTZD

typestring
Enum:accounts_receivable_creditaccounts_payable_credit

Type of payment

accountobject or null
line_itemsobjects
allocationsobjects
notestring or null

Optional note to be associated with the credit note.

termsstring or null

Optional terms to be associated with the credit note.

billing_addressobject
shipping_addressobject
tracking_categoriesobjects or null or null

A list of linked tracking categories.

custom_fieldsobjects
row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

201Credit Note created
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
NetSuite
QuickBooks
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
Procountor
Request
Sage Business Cloud Accounting
Request

Request example

{
  "number": "OIT00546",
  "customer": {
    "id": "12345",
    "display_name": "Windsurf Shop",
    "name": "Windsurf Shop",
    "email": "boring@boring.com"
  },
  "company_id": "12345",
  "currency": "USD",
  "currency_rate": 0.69,
  "tax_inclusive": true,
  "sub_total": 27500,
  "total_amount": 49.99,
  "total_tax": 2500,
  "tax_code": "1234",
  "balance": 27500,
  "remaining_credit": 27500,
  "status": "authorised",
  "reference": "123456",
  "date_issued": "2021-05-01T12:00:00.000Z",
  "date_paid": "2021-05-01T12:00:00.000Z",
  "type": "accounts_receivable_credit",
  "account": {
    "id": "123456",
    "nominal_code": "N091",
    "code": "453"
  },
  "line_items": [
    {
      "id": "12345",
      "row_id": "12345",
      "code": "120-C",
      "line_number": 1,
      "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
      "type": "sales_item",
      "tax_amount": 27500,
      "total_amount": 27500,
      "quantity": 1,
      "unit_price": 27500.5,
      "unit_of_measure": "pc.",
      "discount_percentage": 0.01,
      "discount_amount": 19.99,
      "location_id": "1234",
      "department_id": "1234",
      "item": {
        "id": "12344",
        "code": "120-C",
        "name": "Model Y"
      },
      "tax_rate": {
        "id": "123456",
        "rate": 10
      },
      "tracking_categories": [
        {
          "id": "123456",
          "name": "New York"
        }
      ],
      "ledger_account": {
        "id": "123456",
        "nominal_code": "N091",
        "code": "453"
      },
      "custom_fields": [
        {
          "id": "2389328923893298",
          "name": "employee_level",
          "description": "Employee Level",
          "value": "Uses Salesforce and Marketo"
        }
      ],
      "row_version": "1-12345"
    }
  ],
  "allocations": [
    {
      "id": "123456",
      "type": "invoice",
      "amount": 49.99,
      "allocation_id": "123456"
    }
  ],
  "note": "Some notes about this credit note",
  "terms": "Some terms about this credit note",
  "billing_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",
    "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"
  },
  "shipping_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",
    "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"
  },
  "tracking_categories": [
    {
      "id": "123456",
      "name": "New York"
    }
  ],
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "credit-notes",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get Credit Note

get
https://unify.apideck.com/accounting/credit-notes/{id}

Get Credit Note

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Credit Note
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clear Books
Exact Online
Exact Online NL
Exact Online UK
FreeAgent
FreshBooks
Kashflow
Microsoft Dynamics 365 Business Central
NetSuite
QuickBooks
Sage Business Cloud Accounting
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
MRI Software
Request
MYOB
Request
Procountor
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.creditNotesOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "credit-notes",
  "operation": "one",
  "data": {
    "id": "123456",
    "number": "OIT00546",
    "customer": {
      "id": "12345",
      "display_id": "CUST00101",
      "display_name": "Windsurf Shop",
      "name": "Windsurf Shop",
      "company_name": "The boring company",
      "email": "boring@boring.com"
    },
    "company_id": "12345",
    "currency": "USD",
    "currency_rate": 0.69,
    "tax_inclusive": true,
    "sub_total": 27500,
    "total_amount": 49.99,
    "total_tax": 2500,
    "tax_code": "1234",
    "balance": 27500,
    "remaining_credit": 27500,
    "status": "authorised",
    "reference": "123456",
    "date_issued": "2021-05-01T12:00:00.000Z",
    "date_paid": "2021-05-01T12:00:00.000Z",
    "type": "accounts_receivable_credit",
    "account": {
      "id": "123456",
      "name": "Bank account",
      "nominal_code": "N091",
      "code": "453"
    },
    "line_items": [
      {
        "id": "12345",
        "row_id": "12345",
        "code": "120-C",
        "line_number": 1,
        "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
        "type": "sales_item",
        "tax_amount": 27500,
        "total_amount": 27500,
        "quantity": 1,
        "unit_price": 27500.5,
        "unit_of_measure": "pc.",
        "discount_percentage": 0.01,
        "discount_amount": 19.99,
        "location_id": "1234",
        "department_id": "1234",
        "item": {
          "id": "12344",
          "code": "120-C",
          "name": "Model Y"
        },
        "tax_rate": {
          "id": "123456",
          "code": "N-T",
          "name": "GST on Purchases",
          "rate": 10
        },
        "tracking_categories": [
          {
            "id": "123456",
            "name": "New York"
          }
        ],
        "ledger_account": {
          "id": "123456",
          "name": "Bank account",
          "nominal_code": "N091",
          "code": "453"
        },
        "custom_fields": [
          {
            "id": "2389328923893298",
            "name": "employee_level",
            "description": "Employee Level",
            "value": "Uses Salesforce and Marketo"
          }
        ],
        "row_version": "1-12345",
        "updated_by": "12345",
        "created_by": "12345",
        "created_at": "2020-09-30T07:43:32.000Z",
        "updated_at": "2020-09-30T07:43:32.000Z"
      }
    ],
    "allocations": [
      {
        "id": "123456",
        "type": "invoice",
        "code": "N091",
        "amount": 49.99,
        "allocation_id": "123456"
      }
    ],
    "note": "Some notes about this credit note",
    "terms": "Some terms about this credit note",
    "billing_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",
      "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"
    },
    "shipping_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",
      "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"
    },
    "tracking_categories": [
      {
        "id": "123456",
        "name": "New York"
      }
    ],
    "custom_mappings": {},
    "custom_fields": [
      {
        "id": "2389328923893298",
        "name": "employee_level",
        "description": "Employee Level",
        "value": "Uses Salesforce and Marketo"
      }
    ],
    "row_version": "1-12345",
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z"
  }
}

Update Credit Note

patch
https://unify.apideck.com/accounting/credit-notes/{id}

Update Credit Note

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
numberstring or null

Credit note number.

customerobject or null

The customer this entity is linked to.

company_idstring or null

The company or subsidiary id the transaction belongs to

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

currency_ratenumber or null

Currency Exchange Rate at the time entity was recorded/generated.

tax_inclusiveboolean or null

Amounts are including tax

sub_totalnumber or null

Sub-total amount, normally before tax.

total_amountnumber
required

Amount of transaction

total_taxnumber or null

Total tax amount applied to this invoice.

tax_codestring or null

Applicable tax id/code override if tax is not supplied on a line item basis.

balancenumber or null

The balance reflecting any payments made against the transaction.

remaining_creditnumber or null

Indicates the total credit amount still available to apply towards the payment.

statusstring
Enum:draftauthorisedpaidvoided

Status of credit notes

referencestring or null

Optional reference message ie: Debit remittance detail.

date_issuedstring

Date credit note issued - YYYY:MM::DDThh:mm:ss.sTZD

date_paidstring or null

Date credit note paid - YYYY:MM::DDThh:mm:ss.sTZD

typestring
Enum:accounts_receivable_creditaccounts_payable_credit

Type of payment

accountobject or null
line_itemsobjects
allocationsobjects
notestring or null

Optional note to be associated with the credit note.

termsstring or null

Optional terms to be associated with the credit note.

billing_addressobject
shipping_addressobject
tracking_categoriesobjects or null or null

A list of linked tracking categories.

custom_fieldsobjects
row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

200Credit Note updated
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
NetSuite
QuickBooks
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
Procountor
Request
Sage Business Cloud Accounting
Request

Request example

{
  "number": "OIT00546",
  "customer": {
    "id": "12345",
    "display_name": "Windsurf Shop",
    "name": "Windsurf Shop",
    "email": "boring@boring.com"
  },
  "company_id": "12345",
  "currency": "USD",
  "currency_rate": 0.69,
  "tax_inclusive": true,
  "sub_total": 27500,
  "total_amount": 49.99,
  "total_tax": 2500,
  "tax_code": "1234",
  "balance": 27500,
  "remaining_credit": 27500,
  "status": "authorised",
  "reference": "123456",
  "date_issued": "2021-05-01T12:00:00.000Z",
  "date_paid": "2021-05-01T12:00:00.000Z",
  "type": "accounts_receivable_credit",
  "account": {
    "id": "123456",
    "nominal_code": "N091",
    "code": "453"
  },
  "line_items": [
    {
      "id": "12345",
      "row_id": "12345",
      "code": "120-C",
      "line_number": 1,
      "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
      "type": "sales_item",
      "tax_amount": 27500,
      "total_amount": 27500,
      "quantity": 1,
      "unit_price": 27500.5,
      "unit_of_measure": "pc.",
      "discount_percentage": 0.01,
      "discount_amount": 19.99,
      "location_id": "1234",
      "department_id": "1234",
      "item": {
        "id": "12344",
        "code": "120-C",
        "name": "Model Y"
      },
      "tax_rate": {
        "id": "123456",
        "rate": 10
      },
      "tracking_categories": [
        {
          "id": "123456",
          "name": "New York"
        }
      ],
      "ledger_account": {
        "id": "123456",
        "nominal_code": "N091",
        "code": "453"
      },
      "custom_fields": [
        {
          "id": "2389328923893298",
          "name": "employee_level",
          "description": "Employee Level",
          "value": "Uses Salesforce and Marketo"
        }
      ],
      "row_version": "1-12345"
    }
  ],
  "allocations": [
    {
      "id": "123456",
      "type": "invoice",
      "amount": 49.99,
      "allocation_id": "123456"
    }
  ],
  "note": "Some notes about this credit note",
  "terms": "Some terms about this credit note",
  "billing_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",
    "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"
  },
  "shipping_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",
    "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"
  },
  "tracking_categories": [
    {
      "id": "123456",
      "name": "New York"
    }
  ],
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "credit-notes",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete Credit Note

delete
https://unify.apideck.com/accounting/credit-notes/{id}

Delete Credit Note

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200Credit Note deleted
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
NetSuite
QuickBooks
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
Procountor
Request
Sage Business Cloud Accounting
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.creditNotesDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "credit-notes",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Customers

The Customers model

idstring
required

A unique identifier for an object.

downstream_idstring or null

The third-party API ID of original entity

display_idstring or null

Display ID

display_namestring or null

Display name

company_namestring or null

The name of the company.

company_idstring or null

The company or subsidiary id the transaction belongs to

Customers example
{}

List Customers

get
https://unify.apideck.com/accounting/customers

List Customers

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

filterobjectfilter[company_name]=SpaceX

Apply filters

sortobjectsort[by]=updated_at

Apply sorting

pass_throughobjectpass_through[example_downstream_property]=example_downstream_property

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Customers
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clear Books
Exact Online
Exact Online NL
Exact Online UK
FreeAgent
FreshBooks
Kashflow
Microsoft Dynamics 365 Business Central
MRI Software
MYOB
NetSuite
Procountor
QuickBooks
Sage Business Cloud Accounting
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.customersAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "customers",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "downstream_id": "12345",
      "display_id": "EMP00101",
      "display_name": "Windsurf Shop",
      "company_name": "SpaceX",
      "company_id": "12345",
      "title": "CEO",
      "first_name": "Elon",
      "middle_name": "D.",
      "last_name": "Musk",
      "suffix": "Jr.",
      "individual": true,
      "project": false,
      "addresses": [
        {
          "id": "123",
          "type": "primary",
          "string": "25 Spring Street, Blackburn, VIC 3130",
          "name": "HQ US",
          "line1": "Main street",
          "line2": "apt #",
          "line3": "Suite #",
          "line4": "delivery instructions",
          "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"
        }
      ],
      "phone_numbers": [
        {
          "id": "12345",
          "country_code": "1",
          "area_code": "323",
          "number": "111-111-1111",
          "extension": "105",
          "type": "primary"
        }
      ],
      "emails": [
        {
          "id": "123",
          "email": "elon@musk.com",
          "type": "primary"
        }
      ],
      "websites": [
        {
          "id": "12345",
          "url": "http://example.com",
          "type": "primary"
        }
      ],
      "bank_accounts": [
        {
          "bank_name": "Monzo",
          "account_number": "123465",
          "account_name": "SPACEX LLC",
          "account_type": "credit_card",
          "iban": "CH2989144532982975332",
          "bic": "AUDSCHGGXXX",
          "routing_number": "012345678",
          "bsb_number": "062-001",
          "branch_identifier": "001",
          "bank_code": "BNH",
          "currency": "USD"
        }
      ],
      "notes": "Some notes about this customer",
      "tax_rate": {
        "id": "123456",
        "code": "N-T",
        "name": "GST on Purchases",
        "rate": 10
      },
      "tax_number": "US123945459",
      "currency": "USD",
      "account": {
        "id": "123456",
        "name": "Bank account",
        "nominal_code": "N091",
        "code": "453"
      },
      "parent": {
        "id": "12345",
        "name": "Windsurf Shop"
      },
      "status": "active",
      "payment_method": "cash",
      "channel": "email",
      "custom_mappings": {},
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z",
      "row_version": "1-12345"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create Customer

post
https://unify.apideck.com/accounting/customers

Create Customer

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
display_idstring or null

Display ID

display_namestring or null

Display name

company_namestring or null

The name of the company.

company_idstring or null

The company or subsidiary id the transaction belongs to

titlestring or null

The job title of the person.

first_namestring or null

The first name of the person.

middle_namestring or null

Middle name of the person.

last_namestring or null

The last name of the person.

suffixstring or null
individualboolean or null

Is this an individual or business customer

projectboolean or null

If true, indicates this is a Project.

addressesobjects
phone_numbersobjects
emailsobjects
websitesobjects
bank_accountsobjects
notesstring or null

Some notes about this customer

tax_rateobject
tax_numberstring or null
currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

accountobject or null
parentobject or null

The parent customer this entity is linked to.

statusstring or null
Enum:activeinactivearchivedgdpr-erasure-request

Customer status

payment_methodstring or null

Payment method used for the transaction, such as cash, credit card, bank transfer, or check

channelstring or null

The channel through which the transaction is processed.

row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

201Customers
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
MYOB
NetSuite
Procountor
QuickBooks
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
Sage Business Cloud Accounting
Request

Request example

{
  "display_id": "EMP00101",
  "display_name": "Windsurf Shop",
  "company_name": "SpaceX",
  "company_id": "12345",
  "title": "CEO",
  "first_name": "Elon",
  "middle_name": "D.",
  "last_name": "Musk",
  "suffix": "Jr.",
  "individual": true,
  "project": false,
  "addresses": [
    {
      "id": "123",
      "type": "primary",
      "string": "25 Spring Street, Blackburn, VIC 3130",
      "name": "HQ US",
      "line1": "Main street",
      "line2": "apt #",
      "line3": "Suite #",
      "line4": "delivery instructions",
      "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"
    }
  ],
  "phone_numbers": [
    {
      "id": "12345",
      "country_code": "1",
      "area_code": "323",
      "number": "111-111-1111",
      "extension": "105",
      "type": "primary"
    }
  ],
  "emails": [
    {
      "id": "123",
      "email": "elon@musk.com",
      "type": "primary"
    }
  ],
  "websites": [
    {
      "id": "12345",
      "url": "http://example.com",
      "type": "primary"
    }
  ],
  "bank_accounts": [
    {
      "bank_name": "Monzo",
      "account_number": "123465",
      "account_name": "SPACEX LLC",
      "account_type": "credit_card",
      "iban": "CH2989144532982975332",
      "bic": "AUDSCHGGXXX",
      "routing_number": "012345678",
      "bsb_number": "062-001",
      "branch_identifier": "001",
      "bank_code": "BNH",
      "currency": "USD"
    }
  ],
  "notes": "Some notes about this customer",
  "tax_rate": {
    "id": "123456",
    "rate": 10
  },
  "tax_number": "US123945459",
  "currency": "USD",
  "account": {
    "id": "123456",
    "nominal_code": "N091",
    "code": "453"
  },
  "parent": {
    "id": "12345",
    "name": "Windsurf Shop"
  },
  "status": "active",
  "payment_method": "cash",
  "channel": "email",
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "customers",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get Customer

get
https://unify.apideck.com/accounting/customers/{id}

Get Customer

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Customer
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clear Books
Exact Online
Exact Online NL
Exact Online UK
FreeAgent
FreshBooks
Kashflow
Microsoft Dynamics 365 Business Central
MYOB
NetSuite
Procountor
QuickBooks
Sage Business Cloud Accounting
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
MRI Software
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.customersOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "customers",
  "operation": "one",
  "data": {
    "id": "12345",
    "downstream_id": "12345",
    "display_id": "EMP00101",
    "display_name": "Windsurf Shop",
    "company_name": "SpaceX",
    "company_id": "12345",
    "title": "CEO",
    "first_name": "Elon",
    "middle_name": "D.",
    "last_name": "Musk",
    "suffix": "Jr.",
    "individual": true,
    "project": false,
    "addresses": [
      {
        "id": "123",
        "type": "primary",
        "string": "25 Spring Street, Blackburn, VIC 3130",
        "name": "HQ US",
        "line1": "Main street",
        "line2": "apt #",
        "line3": "Suite #",
        "line4": "delivery instructions",
        "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"
      }
    ],
    "phone_numbers": [
      {
        "id": "12345",
        "country_code": "1",
        "area_code": "323",
        "number": "111-111-1111",
        "extension": "105",
        "type": "primary"
      }
    ],
    "emails": [
      {
        "id": "123",
        "email": "elon@musk.com",
        "type": "primary"
      }
    ],
    "websites": [
      {
        "id": "12345",
        "url": "http://example.com",
        "type": "primary"
      }
    ],
    "bank_accounts": [
      {
        "bank_name": "Monzo",
        "account_number": "123465",
        "account_name": "SPACEX LLC",
        "account_type": "credit_card",
        "iban": "CH2989144532982975332",
        "bic": "AUDSCHGGXXX",
        "routing_number": "012345678",
        "bsb_number": "062-001",
        "branch_identifier": "001",
        "bank_code": "BNH",
        "currency": "USD"
      }
    ],
    "notes": "Some notes about this customer",
    "tax_rate": {
      "id": "123456",
      "code": "N-T",
      "name": "GST on Purchases",
      "rate": 10
    },
    "tax_number": "US123945459",
    "currency": "USD",
    "account": {
      "id": "123456",
      "name": "Bank account",
      "nominal_code": "N091",
      "code": "453"
    },
    "parent": {
      "id": "12345",
      "name": "Windsurf Shop"
    },
    "status": "active",
    "payment_method": "cash",
    "channel": "email",
    "custom_mappings": {},
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z",
    "row_version": "1-12345"
  }
}

Update Customer

patch
https://unify.apideck.com/accounting/customers/{id}

Update Customer

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
display_idstring or null

Display ID

display_namestring or null

Display name

company_namestring or null

The name of the company.

company_idstring or null

The company or subsidiary id the transaction belongs to

titlestring or null

The job title of the person.

first_namestring or null

The first name of the person.

middle_namestring or null

Middle name of the person.

last_namestring or null

The last name of the person.

suffixstring or null
individualboolean or null

Is this an individual or business customer

projectboolean or null

If true, indicates this is a Project.

addressesobjects
phone_numbersobjects
emailsobjects
websitesobjects
bank_accountsobjects
notesstring or null

Some notes about this customer

tax_rateobject
tax_numberstring or null
currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

accountobject or null
parentobject or null

The parent customer this entity is linked to.

statusstring or null
Enum:activeinactivearchivedgdpr-erasure-request

Customer status

payment_methodstring or null

Payment method used for the transaction, such as cash, credit card, bank transfer, or check

channelstring or null

The channel through which the transaction is processed.

row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

200Customers
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
MYOB
NetSuite
Procountor
QuickBooks
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
Sage Business Cloud Accounting
Request

Request example

{
  "display_id": "EMP00101",
  "display_name": "Windsurf Shop",
  "company_name": "SpaceX",
  "company_id": "12345",
  "title": "CEO",
  "first_name": "Elon",
  "middle_name": "D.",
  "last_name": "Musk",
  "suffix": "Jr.",
  "individual": true,
  "project": false,
  "addresses": [
    {
      "id": "123",
      "type": "primary",
      "string": "25 Spring Street, Blackburn, VIC 3130",
      "name": "HQ US",
      "line1": "Main street",
      "line2": "apt #",
      "line3": "Suite #",
      "line4": "delivery instructions",
      "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"
    }
  ],
  "phone_numbers": [
    {
      "id": "12345",
      "country_code": "1",
      "area_code": "323",
      "number": "111-111-1111",
      "extension": "105",
      "type": "primary"
    }
  ],
  "emails": [
    {
      "id": "123",
      "email": "elon@musk.com",
      "type": "primary"
    }
  ],
  "websites": [
    {
      "id": "12345",
      "url": "http://example.com",
      "type": "primary"
    }
  ],
  "bank_accounts": [
    {
      "bank_name": "Monzo",
      "account_number": "123465",
      "account_name": "SPACEX LLC",
      "account_type": "credit_card",
      "iban": "CH2989144532982975332",
      "bic": "AUDSCHGGXXX",
      "routing_number": "012345678",
      "bsb_number": "062-001",
      "branch_identifier": "001",
      "bank_code": "BNH",
      "currency": "USD"
    }
  ],
  "notes": "Some notes about this customer",
  "tax_rate": {
    "id": "123456",
    "rate": 10
  },
  "tax_number": "US123945459",
  "currency": "USD",
  "account": {
    "id": "123456",
    "nominal_code": "N091",
    "code": "453"
  },
  "parent": {
    "id": "12345",
    "name": "Windsurf Shop"
  },
  "status": "active",
  "payment_method": "cash",
  "channel": "email",
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "customers",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete Customer

delete
https://unify.apideck.com/accounting/customers/{id}

Delete Customer

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200Customers
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
MYOB
QuickBooks
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
NetSuite
Request
Procountor
Request
Sage Business Cloud Accounting
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.customersDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "customers",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Invoices

The Invoices model

idstring

A unique identifier for an object.

downstream_idstring or null

The third-party API ID of original entity

typestring or null
Enum:standardcreditserviceproduct

Invoice type

numberstring or null

Invoice number.

customerobject or null

The customer this entity is linked to.

company_idstring or null

The company or subsidiary id the transaction belongs to

Invoices example
{}

List Invoices

get
https://unify.apideck.com/accounting/invoices

List Invoices

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

filterobjectfilter[updated_since]=2020-09-30T07:43:32.000Z

Apply filters

sortobjectsort[by]=updated_at

Apply sorting

pass_throughobjectpass_through[example_downstream_property]=example_downstream_property

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Invoices
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

banqUP
Clear Books
Exact Online
Exact Online NL
Exact Online UK
FreeAgent
FreshBooks
Kashflow
Microsoft Dynamics 365 Business Central
MYOB
NetSuite
Procountor
QuickBooks
Sage Business Cloud Accounting
Sage Intacct
Visma Netvisor
Xero
Zoho Books
MRI Software
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.invoicesAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "invoices",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "downstream_id": "12345",
      "type": "service",
      "number": "OIT00546",
      "customer": {
        "id": "12345",
        "display_id": "CUST00101",
        "display_name": "Windsurf Shop",
        "name": "Windsurf Shop",
        "company_name": "The boring company",
        "email": "boring@boring.com"
      },
      "company_id": "12345",
      "invoice_date": "2020-09-30",
      "due_date": "2020-09-30",
      "terms": "Net 30 days",
      "po_number": "90000117",
      "reference": "123456",
      "status": "draft",
      "invoice_sent": true,
      "currency": "USD",
      "currency_rate": 0.69,
      "tax_inclusive": true,
      "sub_total": 27500,
      "total_tax": 2500,
      "tax_code": "1234",
      "discount_percentage": 5.5,
      "discount_amount": 25,
      "total": 27500,
      "balance": 27500,
      "deposit": 0,
      "customer_memo": "Thank you for your business and have a great day!",
      "tracking_category": {
        "id": "123456",
        "name": "New York"
      },
      "tracking_categories": [
        {
          "id": "123456",
          "name": "New York"
        }
      ],
      "line_items": [
        {
          "id": "12345",
          "row_id": "12345",
          "code": "120-C",
          "line_number": 1,
          "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
          "type": "sales_item",
          "tax_amount": 27500,
          "total_amount": 27500,
          "quantity": 1,
          "unit_price": 27500.5,
          "unit_of_measure": "pc.",
          "discount_percentage": 0.01,
          "discount_amount": 19.99,
          "location_id": "1234",
          "department_id": "1234",
          "item": {
            "id": "12344",
            "code": "120-C",
            "name": "Model Y"
          },
          "tax_rate": {
            "id": "123456",
            "code": "N-T",
            "name": "GST on Purchases",
            "rate": 10
          },
          "tracking_categories": [
            {
              "id": "123456",
              "name": "New York"
            }
          ],
          "ledger_account": {
            "id": "123456",
            "name": "Bank account",
            "nominal_code": "N091",
            "code": "453"
          },
          "custom_fields": [
            {
              "id": "2389328923893298",
              "name": "employee_level",
              "description": "Employee Level",
              "value": "Uses Salesforce and Marketo"
            }
          ],
          "row_version": "1-12345",
          "updated_by": "12345",
          "created_by": "12345",
          "created_at": "2020-09-30T07:43:32.000Z",
          "updated_at": "2020-09-30T07:43:32.000Z"
        }
      ],
      "billing_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",
        "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"
      },
      "shipping_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",
        "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"
      },
      "template_id": "123456",
      "source_document_url": "https://www.invoicesolution.com/invoice/123456",
      "payment_method": "cash",
      "channel": "email",
      "language": "EN",
      "accounting_by_row": false,
      "bank_account": {
        "bank_name": "Monzo",
        "account_number": "123465",
        "account_name": "SPACEX LLC",
        "account_type": "credit_card",
        "iban": "CH2989144532982975332",
        "bic": "AUDSCHGGXXX",
        "routing_number": "012345678",
        "bsb_number": "062-001",
        "branch_identifier": "001",
        "bank_code": "BNH",
        "currency": "USD"
      },
      "ledger_account": {
        "id": "123456",
        "name": "Bank account",
        "nominal_code": "N091",
        "code": "453"
      },
      "custom_mappings": {},
      "custom_fields": [
        {
          "id": "2389328923893298",
          "name": "employee_level",
          "description": "Employee Level",
          "value": "Uses Salesforce and Marketo"
        }
      ],
      "row_version": "1-12345",
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create Invoice

post
https://unify.apideck.com/accounting/invoices

Create Invoice

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
typestring or null
Enum:standardcreditserviceproduct

Invoice type

numberstring or null

Invoice number.

customerobject or null

The customer this entity is linked to.

company_idstring or null

The company or subsidiary id the transaction belongs to

invoice_datestring or null

Date invoice was issued - YYYY-MM-DD.

due_datestring or null

The invoice due date is the date on which a payment or invoice is scheduled to be received by the seller - YYYY-MM-DD.

termsstring or null

Terms of payment.

po_numberstring or null

A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order.

referencestring or null

Optional invoice reference.

statusstring or null
Enum:draftsubmittedauthorisedpartially_paid

Invoice status

invoice_sentboolean

Invoice sent to contact/customer.

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

currency_ratenumber or null

Currency Exchange Rate at the time entity was recorded/generated.

tax_inclusiveboolean or null

Amounts are including tax

sub_totalnumber or null

Sub-total amount, normally before tax.

total_taxnumber or null

Total tax amount applied to this invoice.

tax_codestring or null

Applicable tax id/code override if tax is not supplied on a line item basis.

discount_percentagenumber or null

Discount percentage applied to this invoice.

discount_amountnumber or null

Discount amount applied to this invoice.

totalnumber or null

Total amount of invoice, including tax.

balancenumber or null

Balance of invoice due.

depositnumber or null

Amount of deposit made to this invoice.

customer_memostring or null

Customer memo

tracking_categoryobject or null
deprecated
tracking_categoriesobjects or null or null

A list of linked tracking categories.

line_itemsobjects
billing_addressobject
shipping_addressobject
template_idstring or null

Optional invoice template

source_document_urlstring or null

URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero.

payment_methodstring or null

Payment method used for the transaction, such as cash, credit card, bank transfer, or check

channelstring or null

The channel through which the transaction is processed.

languagestring or null

language code according to ISO 639-1. For the United States - EN

accounting_by_rowboolean or null

Indicates if accounting by row is used (true) or not (false). Accounting by row means that a separate ledger transaction is created for each row.

bank_accountobject
ledger_accountobject or null
custom_fieldsobjects
row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

201Invoice created
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Exact Online
Exact Online NL
Exact Online UK
FreshBooks
Microsoft Dynamics 365 Business Central
MYOB
NetSuite
Procountor
QuickBooks
Sage Business Cloud Accounting
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
Clear Books
Request
FreeAgent
Request
Kashflow
Request
MRI Software
Request

Request example

{
  "type": "service",
  "number": "OIT00546",
  "customer": {
    "id": "12345",
    "display_name": "Windsurf Shop",
    "name": "Windsurf Shop",
    "email": "boring@boring.com"
  },
  "company_id": "12345",
  "invoice_date": "2020-09-30",
  "due_date": "2020-09-30",
  "terms": "Net 30 days",
  "po_number": "90000117",
  "reference": "123456",
  "status": "draft",
  "invoice_sent": true,
  "currency": "USD",
  "currency_rate": 0.69,
  "tax_inclusive": true,
  "sub_total": 27500,
  "total_tax": 2500,
  "tax_code": "1234",
  "discount_percentage": 5.5,
  "discount_amount": 25,
  "total": 27500,
  "balance": 27500,
  "deposit": 0,
  "customer_memo": "Thank you for your business and have a great day!",
  "tracking_category": {
    "id": "123456",
    "name": "New York"
  },
  "tracking_categories": [
    {
      "id": "123456",
      "name": "New York"
    }
  ],
  "line_items": [
    {
      "id": "12345",
      "row_id": "12345",
      "code": "120-C",
      "line_number": 1,
      "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
      "type": "sales_item",
      "tax_amount": 27500,
      "total_amount": 27500,
      "quantity": 1,
      "unit_price": 27500.5,
      "unit_of_measure": "pc.",
      "discount_percentage": 0.01,
      "discount_amount": 19.99,
      "location_id": "1234",
      "department_id": "1234",
      "item": {
        "id": "12344",
        "code": "120-C",
        "name": "Model Y"
      },
      "tax_rate": {
        "id": "123456",
        "rate": 10
      },
      "tracking_categories": [
        {
          "id": "123456",
          "name": "New York"
        }
      ],
      "ledger_account": {
        "id": "123456",
        "nominal_code": "N091",
        "code": "453"
      },
      "custom_fields": [
        {
          "id": "2389328923893298",
          "name": "employee_level",
          "description": "Employee Level",
          "value": "Uses Salesforce and Marketo"
        }
      ],
      "row_version": "1-12345"
    }
  ],
  "billing_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",
    "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"
  },
  "shipping_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",
    "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"
  },
  "template_id": "123456",
  "source_document_url": "https://www.invoicesolution.com/invoice/123456",
  "payment_method": "cash",
  "channel": "email",
  "language": "EN",
  "accounting_by_row": false,
  "bank_account": {
    "bank_name": "Monzo",
    "account_number": "123465",
    "account_name": "SPACEX LLC",
    "account_type": "credit_card",
    "iban": "CH2989144532982975332",
    "bic": "AUDSCHGGXXX",
    "routing_number": "012345678",
    "bsb_number": "062-001",
    "branch_identifier": "001",
    "bank_code": "BNH",
    "currency": "USD"
  },
  "ledger_account": {
    "id": "123456",
    "nominal_code": "N091",
    "code": "453"
  },
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "invoices",
  "operation": "add",
  "data": {
    "id": "12345",
    "downstream_id": "12345"
  }
}

Get Invoice

get
https://unify.apideck.com/accounting/invoices/{id}

Get Invoice

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Invoice
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

banqUP
Clear Books
Exact Online
Exact Online NL
Exact Online UK
FreeAgent
FreshBooks
Kashflow
Microsoft Dynamics 365 Business Central
MYOB
NetSuite
Procountor
QuickBooks
Sage Business Cloud Accounting
Sage Intacct
Visma Netvisor
Xero
Zoho Books
MRI Software
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.invoicesOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "invoices",
  "operation": "one",
  "data": {
    "id": "12345",
    "downstream_id": "12345",
    "type": "service",
    "number": "OIT00546",
    "customer": {
      "id": "12345",
      "display_id": "CUST00101",
      "display_name": "Windsurf Shop",
      "name": "Windsurf Shop",
      "company_name": "The boring company",
      "email": "boring@boring.com"
    },
    "company_id": "12345",
    "invoice_date": "2020-09-30",
    "due_date": "2020-09-30",
    "terms": "Net 30 days",
    "po_number": "90000117",
    "reference": "123456",
    "status": "draft",
    "invoice_sent": true,
    "currency": "USD",
    "currency_rate": 0.69,
    "tax_inclusive": true,
    "sub_total": 27500,
    "total_tax": 2500,
    "tax_code": "1234",
    "discount_percentage": 5.5,
    "discount_amount": 25,
    "total": 27500,
    "balance": 27500,
    "deposit": 0,
    "customer_memo": "Thank you for your business and have a great day!",
    "tracking_category": {
      "id": "123456",
      "name": "New York"
    },
    "tracking_categories": [
      {
        "id": "123456",
        "name": "New York"
      }
    ],
    "line_items": [
      {
        "id": "12345",
        "row_id": "12345",
        "code": "120-C",
        "line_number": 1,
        "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
        "type": "sales_item",
        "tax_amount": 27500,
        "total_amount": 27500,
        "quantity": 1,
        "unit_price": 27500.5,
        "unit_of_measure": "pc.",
        "discount_percentage": 0.01,
        "discount_amount": 19.99,
        "location_id": "1234",
        "department_id": "1234",
        "item": {
          "id": "12344",
          "code": "120-C",
          "name": "Model Y"
        },
        "tax_rate": {
          "id": "123456",
          "code": "N-T",
          "name": "GST on Purchases",
          "rate": 10
        },
        "tracking_categories": [
          {
            "id": "123456",
            "name": "New York"
          }
        ],
        "ledger_account": {
          "id": "123456",
          "name": "Bank account",
          "nominal_code": "N091",
          "code": "453"
        },
        "custom_fields": [
          {
            "id": "2389328923893298",
            "name": "employee_level",
            "description": "Employee Level",
            "value": "Uses Salesforce and Marketo"
          }
        ],
        "row_version": "1-12345",
        "updated_by": "12345",
        "created_by": "12345",
        "created_at": "2020-09-30T07:43:32.000Z",
        "updated_at": "2020-09-30T07:43:32.000Z"
      }
    ],
    "billing_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",
      "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"
    },
    "shipping_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",
      "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"
    },
    "template_id": "123456",
    "source_document_url": "https://www.invoicesolution.com/invoice/123456",
    "payment_method": "cash",
    "channel": "email",
    "language": "EN",
    "accounting_by_row": false,
    "bank_account": {
      "bank_name": "Monzo",
      "account_number": "123465",
      "account_name": "SPACEX LLC",
      "account_type": "credit_card",
      "iban": "CH2989144532982975332",
      "bic": "AUDSCHGGXXX",
      "routing_number": "012345678",
      "bsb_number": "062-001",
      "branch_identifier": "001",
      "bank_code": "BNH",
      "currency": "USD"
    },
    "ledger_account": {
      "id": "123456",
      "name": "Bank account",
      "nominal_code": "N091",
      "code": "453"
    },
    "custom_mappings": {},
    "custom_fields": [
      {
        "id": "2389328923893298",
        "name": "employee_level",
        "description": "Employee Level",
        "value": "Uses Salesforce and Marketo"
      }
    ],
    "row_version": "1-12345",
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z"
  }
}

Update Invoice

patch
https://unify.apideck.com/accounting/invoices/{id}

Update Invoice

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
typestring or null
Enum:standardcreditserviceproduct

Invoice type

numberstring or null

Invoice number.

customerobject or null

The customer this entity is linked to.

company_idstring or null

The company or subsidiary id the transaction belongs to

invoice_datestring or null

Date invoice was issued - YYYY-MM-DD.

due_datestring or null

The invoice due date is the date on which a payment or invoice is scheduled to be received by the seller - YYYY-MM-DD.

termsstring or null

Terms of payment.

po_numberstring or null

A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order.

referencestring or null

Optional invoice reference.

statusstring or null
Enum:draftsubmittedauthorisedpartially_paid

Invoice status

invoice_sentboolean

Invoice sent to contact/customer.

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

currency_ratenumber or null

Currency Exchange Rate at the time entity was recorded/generated.

tax_inclusiveboolean or null

Amounts are including tax

sub_totalnumber or null

Sub-total amount, normally before tax.

total_taxnumber or null

Total tax amount applied to this invoice.

tax_codestring or null

Applicable tax id/code override if tax is not supplied on a line item basis.

discount_percentagenumber or null

Discount percentage applied to this invoice.

discount_amountnumber or null

Discount amount applied to this invoice.

totalnumber or null

Total amount of invoice, including tax.

balancenumber or null

Balance of invoice due.

depositnumber or null

Amount of deposit made to this invoice.

customer_memostring or null

Customer memo

tracking_categoryobject or null
deprecated
tracking_categoriesobjects or null or null

A list of linked tracking categories.

line_itemsobjects
billing_addressobject
shipping_addressobject
template_idstring or null

Optional invoice template

source_document_urlstring or null

URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero.

payment_methodstring or null

Payment method used for the transaction, such as cash, credit card, bank transfer, or check

channelstring or null

The channel through which the transaction is processed.

languagestring or null

language code according to ISO 639-1. For the United States - EN

accounting_by_rowboolean or null

Indicates if accounting by row is used (true) or not (false). Accounting by row means that a separate ledger transaction is created for each row.

bank_accountobject
ledger_accountobject or null
custom_fieldsobjects
row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

200Invoice updated
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
Microsoft Dynamics 365 Business Central
MYOB
NetSuite
Procountor
QuickBooks
Sage Business Cloud Accounting
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
MRI Software
Request

Request example

{
  "type": "service",
  "number": "OIT00546",
  "customer": {
    "id": "12345",
    "display_name": "Windsurf Shop",
    "name": "Windsurf Shop",
    "email": "boring@boring.com"
  },
  "company_id": "12345",
  "invoice_date": "2020-09-30",
  "due_date": "2020-09-30",
  "terms": "Net 30 days",
  "po_number": "90000117",
  "reference": "123456",
  "status": "draft",
  "invoice_sent": true,
  "currency": "USD",
  "currency_rate": 0.69,
  "tax_inclusive": true,
  "sub_total": 27500,
  "total_tax": 2500,
  "tax_code": "1234",
  "discount_percentage": 5.5,
  "discount_amount": 25,
  "total": 27500,
  "balance": 27500,
  "deposit": 0,
  "customer_memo": "Thank you for your business and have a great day!",
  "tracking_category": {
    "id": "123456",
    "name": "New York"
  },
  "tracking_categories": [
    {
      "id": "123456",
      "name": "New York"
    }
  ],
  "line_items": [
    {
      "id": "12345",
      "row_id": "12345",
      "code": "120-C",
      "line_number": 1,
      "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
      "type": "sales_item",
      "tax_amount": 27500,
      "total_amount": 27500,
      "quantity": 1,
      "unit_price": 27500.5,
      "unit_of_measure": "pc.",
      "discount_percentage": 0.01,
      "discount_amount": 19.99,
      "location_id": "1234",
      "department_id": "1234",
      "item": {
        "id": "12344",
        "code": "120-C",
        "name": "Model Y"
      },
      "tax_rate": {
        "id": "123456",
        "rate": 10
      },
      "tracking_categories": [
        {
          "id": "123456",
          "name": "New York"
        }
      ],
      "ledger_account": {
        "id": "123456",
        "nominal_code": "N091",
        "code": "453"
      },
      "custom_fields": [
        {
          "id": "2389328923893298",
          "name": "employee_level",
          "description": "Employee Level",
          "value": "Uses Salesforce and Marketo"
        }
      ],
      "row_version": "1-12345"
    }
  ],
  "billing_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",
    "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"
  },
  "shipping_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",
    "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"
  },
  "template_id": "123456",
  "source_document_url": "https://www.invoicesolution.com/invoice/123456",
  "payment_method": "cash",
  "channel": "email",
  "language": "EN",
  "accounting_by_row": false,
  "bank_account": {
    "bank_name": "Monzo",
    "account_number": "123465",
    "account_name": "SPACEX LLC",
    "account_type": "credit_card",
    "iban": "CH2989144532982975332",
    "bic": "AUDSCHGGXXX",
    "routing_number": "012345678",
    "bsb_number": "062-001",
    "branch_identifier": "001",
    "bank_code": "BNH",
    "currency": "USD"
  },
  "ledger_account": {
    "id": "123456",
    "nominal_code": "N091",
    "code": "453"
  },
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "invoices",
  "operation": "update",
  "data": {
    "id": "12345",
    "downstream_id": "12345"
  }
}

Delete Invoice

delete
https://unify.apideck.com/accounting/invoices/{id}

Delete Invoice

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200Invoice deleted
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Exact Online
Exact Online NL
Exact Online UK
FreshBooks
Microsoft Dynamics 365 Business Central
MYOB
QuickBooks
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
Clear Books
Request
FreeAgent
Request
Kashflow
Request
MRI Software
Request
NetSuite
Request
Procountor
Request
Sage Business Cloud Accounting
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.invoicesDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "invoices",
  "operation": "delete",
  "data": {
    "id": "12345",
    "downstream_id": "12345"
  }
}

Invoice Items

Invoice items are stored from invoice lines to be used later on when creating new invoices.

The Invoice Items model

idstring

The ID of the item.

namestring or null

Item name

descriptionstring or null

A short description of the item

codestring or null

User defined item code

soldboolean or null

Item will be available on sales transactions

purchasedboolean or null

Item is available for purchase transactions

Invoice Items example
{}

List Invoice Items

get
https://unify.apideck.com/accounting/invoice-items

List Invoice Items

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

filterobjectfilter[name]=Widgets Large

Apply filters

pass_throughobjectpass_through[example_downstream_property]=example_downstream_property

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200InvoiceItems
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Exact Online
Exact Online NL
Exact Online UK
FreeAgent
FreshBooks
Kashflow
Microsoft Dynamics 365 Business Central
MYOB
NetSuite
Procountor
QuickBooks
Sage Business Cloud Accounting
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
Clear Books
Request
MRI Software
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.invoiceItemsAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "invoice-items",
  "operation": "all",
  "data": [
    {
      "id": "123456",
      "name": "Model Y",
      "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
      "code": "120-C",
      "sold": true,
      "purchased": true,
      "tracked": true,
      "taxable": true,
      "inventory_date": "2020-10-30",
      "type": "inventory",
      "sales_details": {
        "unit_price": 27500.5,
        "unit_of_measure": "pc.",
        "tax_inclusive": true,
        "tax_rate": {
          "id": "123456",
          "code": "N-T",
          "name": "GST on Purchases",
          "rate": 10
        }
      },
      "purchase_details": {
        "unit_price": 27500.5,
        "unit_of_measure": "pc.",
        "tax_inclusive": true,
        "tax_rate": {
          "id": "123456",
          "code": "N-T",
          "name": "GST on Purchases",
          "rate": 10
        }
      },
      "quantity": 1,
      "unit_price": 27500.5,
      "asset_account": {
        "id": "123456",
        "name": "Bank account",
        "nominal_code": "N091",
        "code": "453"
      },
      "income_account": {
        "id": "123456",
        "name": "Bank account",
        "nominal_code": "N091",
        "code": "453"
      },
      "expense_account": {
        "id": "123456",
        "name": "Bank account",
        "nominal_code": "N091",
        "code": "453"
      },
      "tracking_category": {
        "id": "123456",
        "name": "New York"
      },
      "tracking_categories": [
        {
          "id": "123456",
          "name": "New York"
        }
      ],
      "active": true,
      "custom_mappings": {},
      "row_version": "1-12345",
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create Invoice Item

post
https://unify.apideck.com/accounting/invoice-items

Create Invoice Item

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
namestring or null

Item name

descriptionstring or null

A short description of the item

codestring or null

User defined item code

soldboolean or null

Item will be available on sales transactions

purchasedboolean or null

Item is available for purchase transactions

trackedboolean or null

Item is inventoried

taxableboolean or null

If true, transactions for this item are taxable

inventory_datestring or null

The date of opening balance if inventory item is tracked - YYYY-MM-DD.

typestring or null
Enum:inventoryserviceother

Item type

sales_detailsobject
purchase_detailsobject
quantitynumber or null
unit_pricenumber or null
asset_accountobject or null
income_accountobject or null
expense_accountobject or null
tracking_categoryobject or null
deprecated
tracking_categoriesobjects or null or null

A list of linked tracking categories.

activeboolean or null
row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

201InvoiceItems
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
MYOB
NetSuite
Procountor
QuickBooks
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
Sage Business Cloud Accounting
Request

Request example

{
  "name": "Model Y",
  "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
  "code": "120-C",
  "sold": true,
  "purchased": true,
  "tracked": true,
  "taxable": true,
  "inventory_date": "2020-10-30",
  "type": "inventory",
  "sales_details": {
    "unit_price": 27500.5,
    "unit_of_measure": "pc.",
    "tax_inclusive": true,
    "tax_rate": {
      "id": "123456",
      "rate": 10
    }
  },
  "purchase_details": {
    "unit_price": 27500.5,
    "unit_of_measure": "pc.",
    "tax_inclusive": true,
    "tax_rate": {
      "id": "123456",
      "rate": 10
    }
  },
  "quantity": 1,
  "unit_price": 27500.5,
  "asset_account": {
    "id": "123456",
    "nominal_code": "N091",
    "code": "453"
  },
  "income_account": {
    "id": "123456",
    "nominal_code": "N091",
    "code": "453"
  },
  "expense_account": {
    "id": "123456",
    "nominal_code": "N091",
    "code": "453"
  },
  "tracking_category": {
    "id": "123456",
    "name": "New York"
  },
  "tracking_categories": [
    {
      "id": "123456",
      "name": "New York"
    }
  ],
  "active": true,
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "invoice-items",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get Invoice Item

get
https://unify.apideck.com/accounting/invoice-items/{id}

Get Invoice Item

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

filterobjectfilter[type]=service

Apply filters

Responses

200InvoiceItems
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Exact Online
Exact Online NL
Exact Online UK
FreeAgent
FreshBooks
Microsoft Dynamics 365 Business Central
MYOB
NetSuite
Procountor
QuickBooks
Sage Business Cloud Accounting
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Kashflow
Request
MRI Software
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.invoiceItemsOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "invoice-items",
  "operation": "one",
  "data": {
    "id": "123456",
    "name": "Model Y",
    "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
    "code": "120-C",
    "sold": true,
    "purchased": true,
    "tracked": true,
    "taxable": true,
    "inventory_date": "2020-10-30",
    "type": "inventory",
    "sales_details": {
      "unit_price": 27500.5,
      "unit_of_measure": "pc.",
      "tax_inclusive": true,
      "tax_rate": {
        "id": "123456",
        "code": "N-T",
        "name": "GST on Purchases",
        "rate": 10
      }
    },
    "purchase_details": {
      "unit_price": 27500.5,
      "unit_of_measure": "pc.",
      "tax_inclusive": true,
      "tax_rate": {
        "id": "123456",
        "code": "N-T",
        "name": "GST on Purchases",
        "rate": 10
      }
    },
    "quantity": 1,
    "unit_price": 27500.5,
    "asset_account": {
      "id": "123456",
      "name": "Bank account",
      "nominal_code": "N091",
      "code": "453"
    },
    "income_account": {
      "id": "123456",
      "name": "Bank account",
      "nominal_code": "N091",
      "code": "453"
    },
    "expense_account": {
      "id": "123456",
      "name": "Bank account",
      "nominal_code": "N091",
      "code": "453"
    },
    "tracking_category": {
      "id": "123456",
      "name": "New York"
    },
    "tracking_categories": [
      {
        "id": "123456",
        "name": "New York"
      }
    ],
    "active": true,
    "custom_mappings": {},
    "row_version": "1-12345",
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z"
  }
}

Update Invoice Item

patch
https://unify.apideck.com/accounting/invoice-items/{id}

Update Invoice Item

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
namestring or null

Item name

descriptionstring or null

A short description of the item

codestring or null

User defined item code

soldboolean or null

Item will be available on sales transactions

purchasedboolean or null

Item is available for purchase transactions

trackedboolean or null

Item is inventoried

taxableboolean or null

If true, transactions for this item are taxable

inventory_datestring or null

The date of opening balance if inventory item is tracked - YYYY-MM-DD.

typestring or null
Enum:inventoryserviceother

Item type

sales_detailsobject
purchase_detailsobject
quantitynumber or null
unit_pricenumber or null
asset_accountobject or null
income_accountobject or null
expense_accountobject or null
tracking_categoryobject or null
deprecated
tracking_categoriesobjects or null or null

A list of linked tracking categories.

activeboolean or null
row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

200InvoiceItems
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
MYOB
NetSuite
Procountor
QuickBooks
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
Sage Business Cloud Accounting
Request

Request example

{
  "name": "Model Y",
  "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
  "code": "120-C",
  "sold": true,
  "purchased": true,
  "tracked": true,
  "taxable": true,
  "inventory_date": "2020-10-30",
  "type": "inventory",
  "sales_details": {
    "unit_price": 27500.5,
    "unit_of_measure": "pc.",
    "tax_inclusive": true,
    "tax_rate": {
      "id": "123456",
      "rate": 10
    }
  },
  "purchase_details": {
    "unit_price": 27500.5,
    "unit_of_measure": "pc.",
    "tax_inclusive": true,
    "tax_rate": {
      "id": "123456",
      "rate": 10
    }
  },
  "quantity": 1,
  "unit_price": 27500.5,
  "asset_account": {
    "id": "123456",
    "nominal_code": "N091",
    "code": "453"
  },
  "income_account": {
    "id": "123456",
    "nominal_code": "N091",
    "code": "453"
  },
  "expense_account": {
    "id": "123456",
    "nominal_code": "N091",
    "code": "453"
  },
  "tracking_category": {
    "id": "123456",
    "name": "New York"
  },
  "tracking_categories": [
    {
      "id": "123456",
      "name": "New York"
    }
  ],
  "active": true,
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "invoice-items",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete Invoice Item

delete
https://unify.apideck.com/accounting/invoice-items/{id}

Delete Invoice Item

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200InvoiceItems
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
MYOB
Sage Intacct
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
NetSuite
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.invoiceItemsDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "tax-rates",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Ledger Accounts

The Ledger Accounts model

idstring

A unique identifier for an object.

display_idstring

The human readable display ID used when displaying the account

nominal_codestring or null
deprecated

The nominal code of the ledger account.

codestring or null

The code assigned to the account.

classificationstring or null
Enum:assetequityexpenseliability

The classification of account.

typestring
Enum:accounts_receivablerevenuesalesother_income

The type of account.

Ledger Accounts example
{}

List Ledger Accounts

get
https://unify.apideck.com/accounting/ledger-accounts

List Ledger Accounts

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

filterobjectfilter[updated_since]=2020-09-30T07:43:32.000Z

Apply filters

sortobjectsort[by]=updated_at

Apply sorting

pass_throughobjectpass_through[example_downstream_property]=example_downstream_property

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200LedgerAccounts
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clear Books
Exact Online
Exact Online NL
Exact Online UK
FreeAgent
FreshBooks
Kashflow
Microsoft Dynamics 365 Business Central
MRI Software
MYOB
NetSuite
Procountor
QuickBooks
Sage Business Cloud Accounting
Sage Intacct
Xero
Zoho Books
banqUP
Request
Visma Netvisor
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.ledgerAccountsAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "ledger-accounts",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "display_id": "1-12345",
      "nominal_code": "N091",
      "code": "453",
      "classification": "asset",
      "type": "bank",
      "sub_type": "CHECKING_ACCOUNT",
      "name": "Bank account",
      "fully_qualified_name": "Asset.Bank.Checking_Account",
      "description": "Main checking account",
      "opening_balance": 75000,
      "current_balance": 20000,
      "currency": "USD",
      "tax_type": "NONE",
      "tax_rate": {
        "id": "123456",
        "code": "N-T",
        "name": "GST on Purchases",
        "rate": 10
      },
      "level": 1,
      "active": true,
      "status": "active",
      "header": true,
      "bank_account": {
        "bank_name": "Monzo",
        "account_number": "123465",
        "account_name": "SPACEX LLC",
        "account_type": "credit_card",
        "iban": "CH2989144532982975332",
        "bic": "AUDSCHGGXXX",
        "routing_number": "012345678",
        "bsb_number": "062-001",
        "branch_identifier": "001",
        "bank_code": "BNH",
        "currency": "USD"
      },
      "categories": [
        {
          "id": "12345",
          "name": "Finance Charges Expense"
        }
      ],
      "parent_account": {
        "id": "12345",
        "name": "Bank Accounts",
        "display_id": "1-1100"
      },
      "sub_account": false,
      "sub_accounts": [
        {
          "id": "12345",
          "account_sub_name": "Petty Cash"
        }
      ],
      "last_reconciliation_date": "2020-09-30",
      "subsidiaries": [
        {
          "id": "string"
        }
      ],
      "custom_mappings": {},
      "row_version": "1-12345",
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create Ledger Account

post
https://unify.apideck.com/accounting/ledger-accounts

Create Ledger Account

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
display_idstring

The human readable display ID used when displaying the account

nominal_codestring or null
deprecated

The nominal code of the ledger account.

codestring or null

The code assigned to the account.

classificationstring or null
Enum:assetequityexpenseliability

The classification of account.

typestring
Enum:accounts_receivablerevenuesalesother_income

The type of account.

sub_typestring or null

The sub type of account.

namestring or null

The name of the account.

fully_qualified_namestring or null

The fully qualified name of the account.

descriptionstring or null

The description of the account.

opening_balancenumber or null

The opening balance of the account.

current_balancenumber or null

The current balance of the account.

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

tax_typestring or null

The tax type of the account.

tax_rateobject
levelnumber or null
activeboolean or null

Whether the account is active or not.

statusstring or null
Enum:activeinactivearchived

The status of the account.

headerboolean or null

Whether the account is a header or not.

bank_accountobject
parent_accountobject
sub_accountboolean or null

Whether the account is a sub account or not.

last_reconciliation_datestring or null

Reconciliation Date means the last calendar day of each Reconciliation Period.

subsidiariesobjects

The subsidiaries the account belongs to.

row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

201LedgerAccount created
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
MYOB
NetSuite
QuickBooks
Sage Intacct
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request

Request example

{
  "display_id": "1-12345",
  "nominal_code": "N091",
  "code": "453",
  "classification": "asset",
  "type": "bank",
  "sub_type": "CHECKING_ACCOUNT",
  "name": "Bank account",
  "fully_qualified_name": "Asset.Bank.Checking_Account",
  "description": "Main checking account",
  "opening_balance": 75000,
  "current_balance": 20000,
  "currency": "USD",
  "tax_type": "NONE",
  "tax_rate": {
    "id": "123456",
    "rate": 10
  },
  "level": 1,
  "active": true,
  "status": "active",
  "header": true,
  "bank_account": {
    "bank_name": "Monzo",
    "account_number": "123465",
    "account_name": "SPACEX LLC",
    "account_type": "credit_card",
    "iban": "CH2989144532982975332",
    "bic": "AUDSCHGGXXX",
    "routing_number": "012345678",
    "bsb_number": "062-001",
    "branch_identifier": "001",
    "bank_code": "BNH",
    "currency": "USD"
  },
  "parent_account": {
    "id": "12345",
    "name": "Bank Accounts",
    "display_id": "1-1100"
  },
  "sub_account": false,
  "last_reconciliation_date": "2020-09-30",
  "subsidiaries": [
    {
      "id": "string"
    }
  ],
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "ledger-accounts",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get Ledger Account

get
https://unify.apideck.com/accounting/ledger-accounts/{id}

Get Ledger Account

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200LedgerAccount
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Exact Online
Exact Online NL
Exact Online UK
FreeAgent
FreshBooks
Microsoft Dynamics 365 Business Central
MYOB
NetSuite
QuickBooks
Sage Business Cloud Accounting
Sage Intacct
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Kashflow
Request
MRI Software
Request
Procountor
Request
Visma Netvisor
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.ledgerAccountsOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "ledger-accounts",
  "operation": "one",
  "data": {
    "id": "12345",
    "display_id": "1-12345",
    "nominal_code": "N091",
    "code": "453",
    "classification": "asset",
    "type": "bank",
    "sub_type": "CHECKING_ACCOUNT",
    "name": "Bank account",
    "fully_qualified_name": "Asset.Bank.Checking_Account",
    "description": "Main checking account",
    "opening_balance": 75000,
    "current_balance": 20000,
    "currency": "USD",
    "tax_type": "NONE",
    "tax_rate": {
      "id": "123456",
      "code": "N-T",
      "name": "GST on Purchases",
      "rate": 10
    },
    "level": 1,
    "active": true,
    "status": "active",
    "header": true,
    "bank_account": {
      "bank_name": "Monzo",
      "account_number": "123465",
      "account_name": "SPACEX LLC",
      "account_type": "credit_card",
      "iban": "CH2989144532982975332",
      "bic": "AUDSCHGGXXX",
      "routing_number": "012345678",
      "bsb_number": "062-001",
      "branch_identifier": "001",
      "bank_code": "BNH",
      "currency": "USD"
    },
    "categories": [
      {
        "id": "12345",
        "name": "Finance Charges Expense"
      }
    ],
    "parent_account": {
      "id": "12345",
      "name": "Bank Accounts",
      "display_id": "1-1100"
    },
    "sub_account": false,
    "sub_accounts": [
      {
        "id": "12345",
        "account_sub_name": "Petty Cash"
      }
    ],
    "last_reconciliation_date": "2020-09-30",
    "subsidiaries": [
      {
        "id": "string"
      }
    ],
    "custom_mappings": {},
    "row_version": "1-12345",
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z"
  }
}

Update Ledger Account

patch
https://unify.apideck.com/accounting/ledger-accounts/{id}

Update Ledger Account

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
display_idstring

The human readable display ID used when displaying the account

nominal_codestring or null
deprecated

The nominal code of the ledger account.

codestring or null

The code assigned to the account.

classificationstring or null
Enum:assetequityexpenseliability

The classification of account.

typestring
Enum:accounts_receivablerevenuesalesother_income

The type of account.

sub_typestring or null

The sub type of account.

namestring or null

The name of the account.

fully_qualified_namestring or null

The fully qualified name of the account.

descriptionstring or null

The description of the account.

opening_balancenumber or null

The opening balance of the account.

current_balancenumber or null

The current balance of the account.

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

tax_typestring or null

The tax type of the account.

tax_rateobject
levelnumber or null
activeboolean or null

Whether the account is active or not.

statusstring or null
Enum:activeinactivearchived

The status of the account.

headerboolean or null

Whether the account is a header or not.

bank_accountobject
parent_accountobject
sub_accountboolean or null

Whether the account is a sub account or not.

last_reconciliation_datestring or null

Reconciliation Date means the last calendar day of each Reconciliation Period.

subsidiariesobjects

The subsidiaries the account belongs to.

row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

200LedgerAccount updated
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
MYOB
NetSuite
QuickBooks
Sage Intacct
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request

Request example

{
  "display_id": "1-12345",
  "nominal_code": "N091",
  "code": "453",
  "classification": "asset",
  "type": "bank",
  "sub_type": "CHECKING_ACCOUNT",
  "name": "Bank account",
  "fully_qualified_name": "Asset.Bank.Checking_Account",
  "description": "Main checking account",
  "opening_balance": 75000,
  "current_balance": 20000,
  "currency": "USD",
  "tax_type": "NONE",
  "tax_rate": {
    "id": "123456",
    "rate": 10
  },
  "level": 1,
  "active": true,
  "status": "active",
  "header": true,
  "bank_account": {
    "bank_name": "Monzo",
    "account_number": "123465",
    "account_name": "SPACEX LLC",
    "account_type": "credit_card",
    "iban": "CH2989144532982975332",
    "bic": "AUDSCHGGXXX",
    "routing_number": "012345678",
    "bsb_number": "062-001",
    "branch_identifier": "001",
    "bank_code": "BNH",
    "currency": "USD"
  },
  "parent_account": {
    "id": "12345",
    "name": "Bank Accounts",
    "display_id": "1-1100"
  },
  "sub_account": false,
  "last_reconciliation_date": "2020-09-30",
  "subsidiaries": [
    {
      "id": "string"
    }
  ],
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "ledger-accounts",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete Ledger Account

delete
https://unify.apideck.com/accounting/ledger-accounts/{id}

Delete Ledger Account

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200LedgerAccount deleted
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

MYOB
Sage Intacct
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
NetSuite
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.ledgerAccountsDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "ledger-accounts",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Payments

The Payments model

idstring
required

A unique identifier for an object.

downstream_idstring or null

The third-party API ID of original entity

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

currency_ratenumber or null

Currency Exchange Rate at the time entity was recorded/generated.

total_amountnumber or null
required

The total amount of the transaction

referencestring or null

Optional transaction reference message ie: Debit remittance detail.

Payments example
{}

List Payments

get
https://unify.apideck.com/accounting/payments

List Payments

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

filterobjectfilter[updated_since]=2020-09-30T07:43:32.000Z

Apply filters

sortobjectsort[by]=updated_at

Apply sorting

pass_throughobjectpass_through[example_downstream_property]=example_downstream_property

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Payments
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Exact Online
Exact Online NL
Exact Online UK
FreshBooks
Kashflow
Microsoft Dynamics 365 Business Central
MYOB
NetSuite
Procountor
QuickBooks
Sage Business Cloud Accounting
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
Clear Books
Request
FreeAgent
Request
MRI Software
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.paymentsAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "payments",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "downstream_id": "12345",
      "currency": "USD",
      "currency_rate": 0.69,
      "total_amount": 49.99,
      "reference": "123456",
      "payment_method": "cash",
      "payment_method_reference": "123456",
      "payment_method_id": "12345",
      "accounts_receivable_account_type": "Account",
      "accounts_receivable_account_id": "123456",
      "account": {
        "id": "123456",
        "name": "Bank account",
        "nominal_code": "N091",
        "code": "453"
      },
      "transaction_date": "2021-05-01T12:00:00.000Z",
      "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",
          "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"
        }
      },
      "company_id": "12345",
      "reconciled": true,
      "status": "authorised",
      "type": "accounts_receivable",
      "allocations": [
        {
          "id": "123456",
          "type": "invoice",
          "code": "N091",
          "amount": 49.99,
          "allocation_id": "123456"
        }
      ],
      "note": "Some notes about this transaction",
      "number": "123456",
      "tracking_categories": [
        {
          "id": "123456",
          "name": "New York"
        }
      ],
      "custom_fields": [
        {
          "id": "2389328923893298",
          "name": "employee_level",
          "description": "Employee Level",
          "value": "Uses Salesforce and Marketo"
        }
      ],
      "row_version": "1-12345",
      "display_id": "123456",
      "custom_mappings": {},
      "updated_by": "12345",
      "created_by": "12345",
      "created_at": "2020-09-30T07:43:32.000Z",
      "updated_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create Payment

post
https://unify.apideck.com/accounting/payments

Create Payment

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

currency_ratenumber or null

Currency Exchange Rate at the time entity was recorded/generated.

total_amountnumber or null
required

The total amount of the transaction

referencestring or null

Optional transaction reference message ie: Debit remittance detail.

payment_methodstring or null

Payment method used for the transaction, such as cash, credit card, bank transfer, or check

payment_method_referencestring or null

Optional reference message returned by payment method on processing

payment_method_idstring or null

A unique identifier for an object.

accounts_receivable_account_typestring or null
deprecated

Type of accounts receivable account.

accounts_receivable_account_idstring or null
deprecated

Unique identifier for the account to allocate payment to.

accountobject or null
transaction_datestring or null
required

The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD

customerobject or null

The customer this entity is linked to.

supplierobject or null
deprecated

The supplier this entity is linked to.

company_idstring or null

The company or subsidiary id the transaction belongs to

reconciledboolean or null

Indicates if the transaction has been reconciled.

statusstring
Enum:authorisedpaidvoideddeleted

Status of payment

typestring
Enum:accounts_receivableaccounts_payableaccounts_receivable_creditaccounts_payable_credit

Type of payment

allocationsobjects
notestring or null

Note associated with the transaction

numberstring or null

Number associated with the transaction

tracking_categoriesobjects or null or null

A list of linked tracking categories.

custom_fieldsobjects
row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

display_idstring or null

Id to be displayed.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

201Payment created
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
MYOB
NetSuite
QuickBooks
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
Procountor
Request
Sage Business Cloud Accounting
Request

Request example

{
  "currency": "USD",
  "currency_rate": 0.69,
  "total_amount": 49.99,
  "reference": "123456",
  "payment_method": "cash",
  "payment_method_reference": "123456",
  "payment_method_id": "12345",
  "accounts_receivable_account_type": "Account",
  "accounts_receivable_account_id": "123456",
  "account": {
    "id": "123456",
    "nominal_code": "N091",
    "code": "453"
  },
  "transaction_date": "2021-05-01T12:00:00.000Z",
  "customer": {
    "id": "12345",
    "display_name": "Windsurf Shop",
    "name": "Windsurf Shop",
    "email": "boring@boring.com"
  },
  "supplier": {
    "display_name": "Windsurf Shop",
    "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",
      "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"
    }
  },
  "company_id": "12345",
  "reconciled": true,
  "status": "authorised",
  "type": "accounts_receivable",
  "allocations": [
    {
      "id": "123456",
      "type": "invoice",
      "amount": 49.99,
      "allocation_id": "123456"
    }
  ],
  "note": "Some notes about this transaction",
  "number": "123456",
  "tracking_categories": [
    {
      "id": "123456",
      "name": "New York"
    }
  ],
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "row_version": "1-12345",
  "display_id": "123456",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "payments",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get Payment

get
https://unify.apideck.com/accounting/payments/{id}

Get Payment

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Payment
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Exact Online
Exact Online NL
Exact Online UK
FreshBooks
Microsoft Dynamics 365 Business Central
MYOB
NetSuite
Procountor
QuickBooks
Sage Business Cloud Accounting
Sage Intacct
Xero
Zoho Books
banqUP
Request
Clear Books
Request
FreeAgent
Request
Kashflow
Request
MRI Software
Request
Visma Netvisor
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.paymentsOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "payments",
  "operation": "one",
  "data": {
    "id": "12345",
    "downstream_id": "12345",
    "currency": "USD",
    "currency_rate": 0.69,
    "total_amount": 49.99,
    "reference": "123456",
    "payment_method": "cash",
    "payment_method_reference": "123456",
    "payment_method_id": "12345",
    "accounts_receivable_account_type": "Account",
    "accounts_receivable_account_id": "123456",
    "account": {
      "id": "123456",
      "name": "Bank account",
      "nominal_code": "N091",
      "code": "453"
    },
    "transaction_date": "2021-05-01T12:00:00.000Z",
    "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",
        "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"
      }
    },
    "company_id": "12345",
    "reconciled": true,
    "status": "authorised",
    "type": "accounts_receivable",
    "allocations": [
      {
        "id": "123456",
        "type": "invoice",
        "code": "N091",
        "amount": 49.99,
        "allocation_id": "123456"
      }
    ],
    "note": "Some notes about this transaction",
    "number": "123456",
    "tracking_categories": [
      {
        "id": "123456",
        "name": "New York"
      }
    ],
    "custom_fields": [
      {
        "id": "2389328923893298",
        "name": "employee_level",
        "description": "Employee Level",
        "value": "Uses Salesforce and Marketo"
      }
    ],
    "row_version": "1-12345",
    "display_id": "123456",
    "custom_mappings": {},
    "updated_by": "12345",
    "created_by": "12345",
    "created_at": "2020-09-30T07:43:32.000Z",
    "updated_at": "2020-09-30T07:43:32.000Z"
  }
}

Update Payment

patch
https://unify.apideck.com/accounting/payments/{id}

Update Payment

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

currency_ratenumber or null

Currency Exchange Rate at the time entity was recorded/generated.

total_amountnumber or null
required

The total amount of the transaction

referencestring or null

Optional transaction reference message ie: Debit remittance detail.

payment_methodstring or null

Payment method used for the transaction, such as cash, credit card, bank transfer, or check

payment_method_referencestring or null

Optional reference message returned by payment method on processing

payment_method_idstring or null

A unique identifier for an object.

accounts_receivable_account_typestring or null
deprecated

Type of accounts receivable account.

accounts_receivable_account_idstring or null
deprecated

Unique identifier for the account to allocate payment to.

accountobject or null
transaction_datestring or null
required

The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD

customerobject or null

The customer this entity is linked to.

supplierobject or null
deprecated

The supplier this entity is linked to.

company_idstring or null

The company or subsidiary id the transaction belongs to

reconciledboolean or null

Indicates if the transaction has been reconciled.

statusstring
Enum:authorisedpaidvoideddeleted

Status of payment

typestring
Enum:accounts_receivableaccounts_payableaccounts_receivable_creditaccounts_payable_credit

Type of payment

allocationsobjects
notestring or null

Note associated with the transaction

numberstring or null

Number associated with the transaction

tracking_categoriesobjects or null or null

A list of linked tracking categories.

custom_fieldsobjects
row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

display_idstring or null

Id to be displayed.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

200Payment Updated
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
MYOB
NetSuite
QuickBooks
Sage Intacct
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request
Xero
Request

Request example

{
  "currency": "USD",
  "currency_rate": 0.69,
  "total_amount": 49.99,
  "reference": "123456",
  "payment_method": "cash",
  "payment_method_reference": "123456",
  "payment_method_id": "12345",
  "accounts_receivable_account_type": "Account",
  "accounts_receivable_account_id": "123456",
  "account": {
    "id": "123456",
    "nominal_code": "N091",
    "code": "453"
  },
  "transaction_date": "2021-05-01T12:00:00.000Z",
  "customer": {
    "id": "12345",
    "display_name": "Windsurf Shop",
    "name": "Windsurf Shop",
    "email": "boring@boring.com"
  },
  "supplier": {
    "display_name": "Windsurf Shop",
    "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",
      "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"
    }
  },
  "company_id": "12345",
  "reconciled": true,
  "status": "authorised",
  "type": "accounts_receivable",
  "allocations": [
    {
      "id": "123456",
      "type": "invoice",
      "amount": 49.99,
      "allocation_id": "123456"
    }
  ],
  "note": "Some notes about this transaction",
  "number": "123456",
  "tracking_categories": [
    {
      "id": "123456",
      "name": "New York"
    }
  ],
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "row_version": "1-12345",
  "display_id": "123456",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "payments",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete Payment

delete
https://unify.apideck.com/accounting/payments/{id}

Delete Payment

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200Payment deleted
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
MYOB
QuickBooks
Sage Intacct
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
NetSuite
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.paymentsDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "payments",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Suppliers

The Suppliers model

idstring
required

A unique identifier for an object.

downstream_idstring or null

The third-party API ID of original entity

display_idstring or null

Display ID

display_namestring or null

Display name

company_namestring or null

The name of the company.

company_idstring or null

The company or subsidiary id the transaction belongs to

Suppliers example
{}

List Suppliers

get
https://unify.apideck.com/accounting/suppliers

List Suppliers

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

filterobjectfilter[company_name]=SpaceX

Apply filters

sortobjectsort[by]=updated_at

Apply sorting

pass_throughobjectpass_through[example_downstream_property]=example_downstream_property

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Suppliers
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clear Books
Exact Online
Exact Online NL
Exact Online UK
FreeAgent
FreshBooks
Kashflow
Microsoft Dynamics 365 Business Central
MRI Software
NetSuite
Procountor
QuickBooks
Sage Business Cloud Accounting
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
MYOB
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.suppliersAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "suppliers",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "downstream_id": "12345",
      "display_id": "EMP00101",
      "display_name": "Windsurf Shop",
      "company_name": "SpaceX",
      "company_id": "12345",
      "title": "CEO",
      "first_name": "Elon",
      "middle_name": "D.",
      "last_name": "Musk",
      "suffix": "Jr.",
      "individual": true,
      "addresses": [
        {
          "id": "123",
          "type": "primary",
          "string": "25 Spring Street, Blackburn, VIC 3130",
          "name": "HQ US",
          "line1": "Main street",
          "line2": "apt #",
          "line3": "Suite #",
          "line4": "delivery instructions",
          "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"
        }
      ],
      "phone_numbers": [
        {
          "id": "12345",
          "country_code": "1",
          "area_code": "323",
          "number": "111-111-1111",
          "extension": "105",
          "type": "primary"
        }
      ],
      "emails": [
        {
          "id": "123",
          "email": "elon@musk.com",
          "type": "primary"
        }
      ],
      "websites": [
        {
          "id": "12345",
          "url": "http://example.com",
          "type": "primary"
        }
      ],
      "bank_accounts": [
        {
          "bank_name": "Monzo",
          "account_number": "123465",
          "account_name": "SPACEX LLC",
          "account_type": "credit_card",
          "iban": "CH2989144532982975332",
          "bic": "AUDSCHGGXXX",
          "routing_number": "012345678",
          "bsb_number": "062-001",
          "branch_identifier": "001",
          "bank_code": "BNH",
          "currency": "USD"
        }
      ],
      "notes": "Some notes about this supplier",
      "tax_rate": {
        "id": "123456",
        "code": "N-T",
        "name": "GST on Purchases",
        "rate": 10
      },
      "tax_number": "US123945459",
      "currency": "USD",
      "account": {
        "id": "123456",
        "name": "Bank account",
        "nominal_code": "N091",
        "code": "453"
      },
      "status": "active",
      "payment_method": "cash",
      "channel": "email",
      "custom_mappings": {},
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z",
      "row_version": "1-12345",
      "subsidiary_id": "12345"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create Supplier

post
https://unify.apideck.com/accounting/suppliers

Create Supplier

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
display_idstring or null

Display ID

display_namestring or null

Display name

company_namestring or null

The name of the company.

company_idstring or null

The company or subsidiary id the transaction belongs to

titlestring or null

The job title of the person.

first_namestring or null

The first name of the person.

middle_namestring or null

Middle name of the person.

last_namestring or null

The last name of the person.

suffixstring or null
individualboolean or null

Is this an individual or business supplier

addressesobjects
phone_numbersobjects
emailsobjects
websitesobjects
bank_accountsobjects
notesstring or null

Some notes about this supplier

tax_rateobject
tax_numberstring or null
currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

accountobject or null
statusstring or null
Enum:activeinactivearchivedgdpr-erasure-request

Supplier status

payment_methodstring or null

Payment method used for the transaction, such as cash, credit card, bank transfer, or check

channelstring or null

The channel through which the transaction is processed.

row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

subsidiary_idstring

The subsidiary the supplier belongs to.

Responses

201Supplier created
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
Microsoft Dynamics 365 Business Central
MRI Software
NetSuite
Procountor
QuickBooks
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
MYOB
Request
Sage Business Cloud Accounting
Request

Request example

{
  "display_id": "EMP00101",
  "display_name": "Windsurf Shop",
  "company_name": "SpaceX",
  "company_id": "12345",
  "title": "CEO",
  "first_name": "Elon",
  "middle_name": "D.",
  "last_name": "Musk",
  "suffix": "Jr.",
  "individual": true,
  "addresses": [
    {
      "id": "123",
      "type": "primary",
      "string": "25 Spring Street, Blackburn, VIC 3130",
      "name": "HQ US",
      "line1": "Main street",
      "line2": "apt #",
      "line3": "Suite #",
      "line4": "delivery instructions",
      "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"
    }
  ],
  "phone_numbers": [
    {
      "id": "12345",
      "country_code": "1",
      "area_code": "323",
      "number": "111-111-1111",
      "extension": "105",
      "type": "primary"
    }
  ],
  "emails": [
    {
      "id": "123",
      "email": "elon@musk.com",
      "type": "primary"
    }
  ],
  "websites": [
    {
      "id": "12345",
      "url": "http://example.com",
      "type": "primary"
    }
  ],
  "bank_accounts": [
    {
      "bank_name": "Monzo",
      "account_number": "123465",
      "account_name": "SPACEX LLC",
      "account_type": "credit_card",
      "iban": "CH2989144532982975332",
      "bic": "AUDSCHGGXXX",
      "routing_number": "012345678",
      "bsb_number": "062-001",
      "branch_identifier": "001",
      "bank_code": "BNH",
      "currency": "USD"
    }
  ],
  "notes": "Some notes about this supplier",
  "tax_rate": {
    "id": "123456",
    "rate": 10
  },
  "tax_number": "US123945459",
  "currency": "USD",
  "account": {
    "id": "123456",
    "nominal_code": "N091",
    "code": "453"
  },
  "status": "active",
  "payment_method": "cash",
  "channel": "email",
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ],
  "subsidiary_id": "12345"
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "payments",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get Supplier

get
https://unify.apideck.com/accounting/suppliers/{id}

Get Supplier

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Supplier
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clear Books
Exact Online
Exact Online NL
Exact Online UK
FreeAgent
Kashflow
Microsoft Dynamics 365 Business Central
MRI Software
NetSuite
Procountor
QuickBooks
Sage Business Cloud Accounting
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
FreshBooks
Request
MYOB
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.suppliersOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "suppliers",
  "operation": "one",
  "data": {
    "id": "12345",
    "downstream_id": "12345",
    "display_id": "EMP00101",
    "display_name": "Windsurf Shop",
    "company_name": "SpaceX",
    "company_id": "12345",
    "title": "CEO",
    "first_name": "Elon",
    "middle_name": "D.",
    "last_name": "Musk",
    "suffix": "Jr.",
    "individual": true,
    "addresses": [
      {
        "id": "123",
        "type": "primary",
        "string": "25 Spring Street, Blackburn, VIC 3130",
        "name": "HQ US",
        "line1": "Main street",
        "line2": "apt #",
        "line3": "Suite #",
        "line4": "delivery instructions",
        "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"
      }
    ],
    "phone_numbers": [
      {
        "id": "12345",
        "country_code": "1",
        "area_code": "323",
        "number": "111-111-1111",
        "extension": "105",
        "type": "primary"
      }
    ],
    "emails": [
      {
        "id": "123",
        "email": "elon@musk.com",
        "type": "primary"
      }
    ],
    "websites": [
      {
        "id": "12345",
        "url": "http://example.com",
        "type": "primary"
      }
    ],
    "bank_accounts": [
      {
        "bank_name": "Monzo",
        "account_number": "123465",
        "account_name": "SPACEX LLC",
        "account_type": "credit_card",
        "iban": "CH2989144532982975332",
        "bic": "AUDSCHGGXXX",
        "routing_number": "012345678",
        "bsb_number": "062-001",
        "branch_identifier": "001",
        "bank_code": "BNH",
        "currency": "USD"
      }
    ],
    "notes": "Some notes about this supplier",
    "tax_rate": {
      "id": "123456",
      "code": "N-T",
      "name": "GST on Purchases",
      "rate": 10
    },
    "tax_number": "US123945459",
    "currency": "USD",
    "account": {
      "id": "123456",
      "name": "Bank account",
      "nominal_code": "N091",
      "code": "453"
    },
    "status": "active",
    "payment_method": "cash",
    "channel": "email",
    "custom_mappings": {},
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z",
    "row_version": "1-12345",
    "subsidiary_id": "12345"
  }
}

Update Supplier

patch
https://unify.apideck.com/accounting/suppliers/{id}

Update Supplier

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
display_idstring or null

Display ID

display_namestring or null

Display name

company_namestring or null

The name of the company.

company_idstring or null

The company or subsidiary id the transaction belongs to

titlestring or null

The job title of the person.

first_namestring or null

The first name of the person.

middle_namestring or null

Middle name of the person.

last_namestring or null

The last name of the person.

suffixstring or null
individualboolean or null

Is this an individual or business supplier

addressesobjects
phone_numbersobjects
emailsobjects
websitesobjects
bank_accountsobjects
notesstring or null

Some notes about this supplier

tax_rateobject
tax_numberstring or null
currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

accountobject or null
statusstring or null
Enum:activeinactivearchivedgdpr-erasure-request

Supplier status

payment_methodstring or null

Payment method used for the transaction, such as cash, credit card, bank transfer, or check

channelstring or null

The channel through which the transaction is processed.

row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

subsidiary_idstring

The subsidiary the supplier belongs to.

Responses

200Supplier updated
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
Microsoft Dynamics 365 Business Central
NetSuite
Procountor
QuickBooks
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
MRI Software
Request
MYOB
Request
Sage Business Cloud Accounting
Request

Request example

{
  "display_id": "EMP00101",
  "display_name": "Windsurf Shop",
  "company_name": "SpaceX",
  "company_id": "12345",
  "title": "CEO",
  "first_name": "Elon",
  "middle_name": "D.",
  "last_name": "Musk",
  "suffix": "Jr.",
  "individual": true,
  "addresses": [
    {
      "id": "123",
      "type": "primary",
      "string": "25 Spring Street, Blackburn, VIC 3130",
      "name": "HQ US",
      "line1": "Main street",
      "line2": "apt #",
      "line3": "Suite #",
      "line4": "delivery instructions",
      "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"
    }
  ],
  "phone_numbers": [
    {
      "id": "12345",
      "country_code": "1",
      "area_code": "323",
      "number": "111-111-1111",
      "extension": "105",
      "type": "primary"
    }
  ],
  "emails": [
    {
      "id": "123",
      "email": "elon@musk.com",
      "type": "primary"
    }
  ],
  "websites": [
    {
      "id": "12345",
      "url": "http://example.com",
      "type": "primary"
    }
  ],
  "bank_accounts": [
    {
      "bank_name": "Monzo",
      "account_number": "123465",
      "account_name": "SPACEX LLC",
      "account_type": "credit_card",
      "iban": "CH2989144532982975332",
      "bic": "AUDSCHGGXXX",
      "routing_number": "012345678",
      "bsb_number": "062-001",
      "branch_identifier": "001",
      "bank_code": "BNH",
      "currency": "USD"
    }
  ],
  "notes": "Some notes about this supplier",
  "tax_rate": {
    "id": "123456",
    "rate": 10
  },
  "tax_number": "US123945459",
  "currency": "USD",
  "account": {
    "id": "123456",
    "nominal_code": "N091",
    "code": "453"
  },
  "status": "active",
  "payment_method": "cash",
  "channel": "email",
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ],
  "subsidiary_id": "12345"
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "suppliers",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete Supplier

delete
https://unify.apideck.com/accounting/suppliers/{id}

Delete Supplier

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200Supplier deleted
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
Microsoft Dynamics 365 Business Central
QuickBooks
Sage Intacct
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.suppliersDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "suppliers",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Tax Rates

The Tax Rates model

idstring or null

ID assigned to identify this tax rate.

namestringnon-empty

Name assigned to identify this tax rate.

codestring or null

Tax code assigned to identify this tax rate.

descriptionstring or null

Description of tax rate

effective_tax_ratenumber or null

Effective tax rate

total_tax_ratenumber or null

Not compounded sum of the components of a tax rate

Tax Rates example
{}

List Tax Rates

get
https://unify.apideck.com/accounting/tax-rates

List Tax Rates. Note: Not all connectors return the actual rate/percentage value. In this case, only the tax code or reference is returned. Connectors Affected: Quickbooks

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

filterobjectfilter[assets]=true

Apply filters

pass_throughobjectpass_through[example_downstream_property]=example_downstream_property

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200TaxRates
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Exact Online
Exact Online NL
Exact Online UK
FreshBooks
Kashflow
Microsoft Dynamics 365 Business Central
MRI Software
MYOB
NetSuite
Procountor
QuickBooks
Sage Business Cloud Accounting
Sage Intacct
Xero
Zoho Books
banqUP
Request
Clear Books
Request
FreeAgent
Request
Visma Netvisor
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.taxRatesAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "tax-rates",
  "operation": "all",
  "data": [
    {
      "id": "1234",
      "name": "GST on Purchases",
      "code": "ABN",
      "description": "Reduced rate GST Purchases",
      "effective_tax_rate": 10,
      "total_tax_rate": 10,
      "tax_payable_account_id": "123456",
      "tax_remitted_account_id": "123456",
      "components": [
        {
          "id": "10",
          "name": "GST",
          "rate": 10,
          "compound": true
        }
      ],
      "type": "NONE",
      "report_tax_type": "NONE",
      "original_tax_rate_id": "12345",
      "status": "active",
      "custom_mappings": {},
      "row_version": "1-12345",
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z",
      "subsidiaries": [
        {
          "id": "string"
        }
      ]
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create Tax Rate

post
https://unify.apideck.com/accounting/tax-rates

Create Tax Rate

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
idstring or null

ID assigned to identify this tax rate.

namestringnon-empty

Name assigned to identify this tax rate.

codestring or null

Tax code assigned to identify this tax rate.

descriptionstring or null

Description of tax rate

effective_tax_ratenumber or null

Effective tax rate

total_tax_ratenumber or null

Not compounded sum of the components of a tax rate

tax_payable_account_idstring or null

Unique identifier for the account for tax collected.

tax_remitted_account_idstring or null

Unique identifier for the account for tax remitted.

componentsobjects or null
typestring or null

Tax type used to indicate the source of tax collected or paid

report_tax_typestring or null

Report Tax type to aggregate tax collected or paid for reporting purposes

original_tax_rate_idstring or null

ID of the original tax rate from which the new tax rate is derived. Helps to understand the relationship between corresponding tax rate entities.

statusstring or null
Enum:activeinactivearchived

Tax rate status

row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

subsidiariesobjects

The subsidiaries this belongs to.

Responses

201TaxRate created
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
MYOB
NetSuite
QuickBooks
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request

Request example

{
  "id": "1234",
  "name": "GST on Purchases",
  "code": "ABN",
  "description": "Reduced rate GST Purchases",
  "effective_tax_rate": 10,
  "total_tax_rate": 10,
  "tax_payable_account_id": "123456",
  "tax_remitted_account_id": "123456",
  "components": [
    {
      "id": "10",
      "name": "GST",
      "rate": 10,
      "compound": true
    }
  ],
  "type": "NONE",
  "report_tax_type": "NONE",
  "original_tax_rate_id": "12345",
  "status": "active",
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ],
  "subsidiaries": [
    {
      "id": "string"
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "tax-rates",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get Tax Rate

get
https://unify.apideck.com/accounting/tax-rates/{id}

Get Tax Rate. Note: Not all connectors return the actual rate/percentage value. In this case, only the tax code or reference is returned. Support will soon be added to return the actual rate/percentage by doing additional calls in the background to provide the full view of a given tax rate. Connectors Affected: Quickbooks

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200TaxRate
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Exact Online
Exact Online NL
Exact Online UK
FreshBooks
Microsoft Dynamics 365 Business Central
MYOB
NetSuite
QuickBooks
Sage Business Cloud Accounting
Sage Intacct
Xero
Zoho Books
banqUP
Request
Clear Books
Request
FreeAgent
Request
Kashflow
Request
MRI Software
Request
Procountor
Request
Visma Netvisor
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.taxRatesOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "tax-rates",
  "operation": "one",
  "data": {
    "id": "1234",
    "name": "GST on Purchases",
    "code": "ABN",
    "description": "Reduced rate GST Purchases",
    "effective_tax_rate": 10,
    "total_tax_rate": 10,
    "tax_payable_account_id": "123456",
    "tax_remitted_account_id": "123456",
    "components": [
      {
        "id": "10",
        "name": "GST",
        "rate": 10,
        "compound": true
      }
    ],
    "type": "NONE",
    "report_tax_type": "NONE",
    "original_tax_rate_id": "12345",
    "status": "active",
    "custom_mappings": {},
    "row_version": "1-12345",
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z",
    "subsidiaries": [
      {
        "id": "string"
      }
    ]
  }
}

Update Tax Rate

patch
https://unify.apideck.com/accounting/tax-rates/{id}

Update Tax Rate

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
idstring or null

ID assigned to identify this tax rate.

namestringnon-empty

Name assigned to identify this tax rate.

codestring or null

Tax code assigned to identify this tax rate.

descriptionstring or null

Description of tax rate

effective_tax_ratenumber or null

Effective tax rate

total_tax_ratenumber or null

Not compounded sum of the components of a tax rate

tax_payable_account_idstring or null

Unique identifier for the account for tax collected.

tax_remitted_account_idstring or null

Unique identifier for the account for tax remitted.

componentsobjects or null
typestring or null

Tax type used to indicate the source of tax collected or paid

report_tax_typestring or null

Report Tax type to aggregate tax collected or paid for reporting purposes

original_tax_rate_idstring or null

ID of the original tax rate from which the new tax rate is derived. Helps to understand the relationship between corresponding tax rate entities.

statusstring or null
Enum:activeinactivearchived

Tax rate status

row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

subsidiariesobjects

The subsidiaries this belongs to.

Responses

200TaxRate updated
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
MYOB
NetSuite
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request

Request example

{
  "id": "1234",
  "name": "GST on Purchases",
  "code": "ABN",
  "description": "Reduced rate GST Purchases",
  "effective_tax_rate": 10,
  "total_tax_rate": 10,
  "tax_payable_account_id": "123456",
  "tax_remitted_account_id": "123456",
  "components": [
    {
      "id": "10",
      "name": "GST",
      "rate": 10,
      "compound": true
    }
  ],
  "type": "NONE",
  "report_tax_type": "NONE",
  "original_tax_rate_id": "12345",
  "status": "active",
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ],
  "subsidiaries": [
    {
      "id": "string"
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "tax-rates",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete Tax Rate

delete
https://unify.apideck.com/accounting/tax-rates/{id}

Delete Tax Rate

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200TaxRates deleted
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
MYOB
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
NetSuite
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.taxRatesDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "tax-rates",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Balance Sheet

The Balance Sheet model

reportsobjects
required
Balance Sheet example
{}

Get BalanceSheet

get
https://unify.apideck.com/accounting/balance-sheet

Get BalanceSheet

Authorizations:

Header parameters

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.

Query parameters

pass_throughobjectpass_through[example_downstream_property]=example_downstream_property

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

filterobjectfilter[start_date]=2021-01-01

Apply filters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200BalanceSheet
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Exact Online
Exact Online NL
Exact Online UK
FreeAgent
FreshBooks
QuickBooks
Xero
banqUP
Request
Clear Books
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Zoho Books
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.balanceSheetOne({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "BalanceSheets",
  "operation": "one",
  "data": {
    "reports": [
      {
        "id": "12345",
        "report_name": "BalanceSheet",
        "start_date": "2017-01-01",
        "end_date": "2017-01-31",
        "currency": "USD",
        "assets": {
          "account_id": "1",
          "code": "1000",
          "name": "Assets",
          "value": 50000,
          "items": [
            {
              "account_id": "101",
              "code": "1100",
              "name": "Current Assets",
              "value": 20000,
              "items": [
                {
                  "account_id": "1011",
                  "code": "1101",
                  "name": "Cash and Cash Equivalents",
                  "value": 10000
                },
                {
                  "account_id": "1012",
                  "code": "1102",
                  "name": "Accounts Receivable",
                  "value": 5000
                },
                {
                  "account_id": "1013",
                  "code": "1103",
                  "name": "Inventory",
                  "value": 3000
                },
                {
                  "account_id": "1014",
                  "code": "1104",
                  "name": "Prepaid Expenses",
                  "value": 2000
                }
              ]
            },
            {
              "account_id": "102",
              "code": "1200",
              "name": "Non-Current Assets",
              "value": 30000,
              "items": [
                {
                  "account_id": "1021",
                  "code": "1201",
                  "name": "Property, Plant, and Equipment (PPE)",
                  "value": 25000
                },
                {
                  "account_id": "1022",
                  "code": "1202",
                  "name": "Intangible Assets",
                  "value": 5000,
                  "items": [
                    {
                      "account_id": "10221",
                      "code": "1203",
                      "name": "Goodwill",
                      "value": 3000
                    },
                    {
                      "account_id": "10222",
                      "code": "1204",
                      "name": "Patents",
                      "value": 2000
                    }
                  ]
                }
              ]
            }
          ]
        },
        "liabilities": {
          "account_id": "2",
          "code": "2000",
          "name": "Liabilities",
          "value": 30000,
          "items": [
            {
              "account_id": "201",
              "code": "2100",
              "name": "Current Liabilities",
              "value": 10000,
              "items": [
                {
                  "account_id": "2011",
                  "code": "2101",
                  "name": "Accounts Payable",
                  "value": 4000
                },
                {
                  "account_id": "2012",
                  "code": "2102",
                  "name": "Short-Term Debt",
                  "value": 2000
                },
                {
                  "account_id": "2013",
                  "code": "2103",
                  "name": "Accrued Expenses",
                  "value": 1000
                },
                {
                  "account_id": "2014",
                  "code": "2104",
                  "name": "Current Portion of Long-Term Debt",
                  "value": 3000
                }
              ]
            },
            {
              "account_id": "202",
              "code": "2200",
              "name": "Non-Current Liabilities",
              "value": 20000,
              "items": [
                {
                  "account_id": "2021",
                  "code": "2201",
                  "name": "Long-Term Debt",
                  "value": 15000
                },
                {
                  "account_id": "2022",
                  "code": "2202",
                  "name": "Deferred Tax Liabilities",
                  "value": 3000
                },
                {
                  "account_id": "2023",
                  "code": "2203",
                  "name": "Pension Liabilities",
                  "value": 2000
                }
              ]
            }
          ]
        },
        "equity": {
          "account_id": "3",
          "code": "3000",
          "name": "Equity",
          "value": 20000,
          "items": [
            {
              "account_id": "301",
              "code": "3100",
              "name": "Common Stock",
              "value": 5000
            },
            {
              "account_id": "302",
              "code": "3200",
              "name": "Retained Earnings",
              "value": 10000
            },
            {
              "account_id": "303",
              "code": "3300",
              "name": "Additional Paid-In Capital",
              "value": 3000
            },
            {
              "account_id": "304",
              "code": "3400",
              "name": "Treasury Stock",
              "value": -1000
            },
            {
              "account_id": "305",
              "code": "3500",
              "name": "Other Comprehensive Income",
              "value": 3000
            }
          ]
        },
        "net_assets": 1000,
        "custom_mappings": {},
        "updated_by": "12345",
        "created_by": "12345",
        "updated_at": "2020-09-30T07:43:32.000Z",
        "created_at": "2020-09-30T07:43:32.000Z",
        "uncategorized_items": {
          "account_id": "3",
          "code": "3000",
          "name": "Uncategorized Items",
          "value": 1000,
          "items": [
            {
              "account_id": "301",
              "code": "3100",
              "name": "not linked account",
              "value": 1000
            }
          ]
        }
      }
    ]
  }
}

Profit and Loss

The Profit and Loss model

idstring

A unique identifier for an object.

report_namestring
required

The name of the report

start_datestring

The start date of the report

end_datestring

The start date of the report

currencystring
required
customer_idstring

Customer id

Profit and Loss example
{}

Get Profit and Loss

get
https://unify.apideck.com/accounting/profit-and-loss

Get Profit and Loss

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

filterobjectfilter[customer_id]=123abc

Apply filters

pass_throughobjectpass_through[example_downstream_property]=example_downstream_property

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Profit & Loss Report
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Exact Online
Exact Online UK
FreeAgent
FreshBooks
QuickBooks
Xero
banqUP
Request
Clear Books
Request
Exact Online NL
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Zoho Books
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.profitAndLossOne({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "ProfitAndLosses",
  "operation": "one",
  "data": {
    "id": "12345",
    "report_name": "ProfitAndLoss",
    "start_date": "2017-01-01",
    "end_date": "2017-01-01",
    "currency": "USD",
    "customer_id": "123",
    "income": {
      "total": 200000,
      "records": [
        {
          "id": "123",
          "name": "Income 1",
          "amount": 10000
        },
        {
          "id": "456",
          "name": "Income 2",
          "amount": 20000
        }
      ]
    },
    "expenses": {
      "total": 200000,
      "records": [
        {
          "id": "123",
          "name": "Expense 1",
          "amount": 10000
        },
        {
          "id": "456",
          "name": "Expense 2",
          "amount": 20000
        }
      ]
    },
    "net_income": {
      "total": 200000
    },
    "net_operating_income": {
      "total": 200000
    },
    "gross_profit": {
      "total": 200000
    },
    "custom_mappings": {}
  }
}

Journal Entries

The Journal Entries model

idstring

A unique identifier for an object.

titlestring or null

Journal entry title

currency_ratenumber or null

Currency Exchange Rate at the time entity was recorded/generated.

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

company_idstring or null

The company or subsidiary id the transaction belongs to

line_itemsobjects>= 2 items

Requires a minimum of 2 line items that sum to 0

Journal Entries example
{}

List Journal Entries

get
https://unify.apideck.com/accounting/journal-entries

List Journal Entries

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

filterobjectfilter[updated_since]=2020-09-30T07:43:32.000Z

Apply filters

sortobjectsort[by]=updated_at

Apply sorting

pass_throughobjectpass_through[example_downstream_property]=example_downstream_property

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200JournalEntry
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Exact Online
Exact Online NL
Exact Online UK
FreeAgent
FreshBooks
Kashflow
Microsoft Dynamics 365 Business Central
MRI Software
NetSuite
Procountor
QuickBooks
Sage Business Cloud Accounting
Sage Intacct
Visma Netvisor
Xero
Zoho Books
banqUP
Request
Clear Books
Request
MYOB
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.journalEntriesAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "journal-entries",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "title": "Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry",
      "currency_rate": 0.69,
      "currency": "USD",
      "company_id": "12345",
      "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,
          "type": "debit",
          "tax_rate": {
            "id": "123456",
            "code": "N-T",
            "name": "GST on Purchases",
            "rate": 10
          },
          "tracking_category": {
            "id": "123456",
            "name": "New York"
          },
          "tracking_categories": [
            {
              "id": "123456",
              "name": "New York"
            }
          ],
          "ledger_account": {
            "id": "123456",
            "name": "Bank account",
            "nominal_code": "N091",
            "code": "453"
          },
          "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",
              "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"
            }
          },
          "department_id": "12345",
          "location_id": "12345",
          "line_number": 1
        },
        {
          "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,
          "type": "debit",
          "tax_rate": {
            "id": "123456",
            "code": "N-T",
            "name": "GST on Purchases",
            "rate": 10
          },
          "tracking_category": {
            "id": "123456",
            "name": "New York"
          },
          "tracking_categories": [
            {
              "id": "123456",
              "name": "New York"
            }
          ],
          "ledger_account": {
            "id": "123456",
            "name": "Bank account",
            "nominal_code": "N091",
            "code": "453"
          },
          "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",
              "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"
            }
          },
          "department_id": "12345",
          "location_id": "12345",
          "line_number": 1
        }
      ],
      "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",
          "name": "New York"
        }
      ],
      "accounting_period": "01-24",
      "custom_mappings": {},
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z",
      "row_version": "1-12345"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create Journal Entry

post
https://unify.apideck.com/accounting/journal-entries

Create Journal Entry

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
titlestring or null

Journal entry title

currency_ratenumber or null

Currency Exchange Rate at the time entity was recorded/generated.

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

company_idstring or null

The company or subsidiary id the transaction belongs to

line_itemsobjects>= 2 items

Requires a minimum of 2 line items that sum to 0

memostring or null

Reference for the journal entry.

posted_atstring

This is the date on which the journal entry was added. This can be different from the creation date and can also be backdated.

journal_symbolstring or null

Journal symbol of the entry. For example IND for indirect costs

tax_typestring or null

The specific category of tax associated with a transaction like sales or purchase

tax_codestring or null

Applicable tax id/code override if tax is not supplied on a line item basis.

numberstring or null

Journal entry number.

tracking_categoriesobjects or null or null

A list of linked tracking categories.

accounting_periodstring or null

Accounting period

row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

201JournalEntries
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Exact Online
Exact Online NL
Exact Online UK
MRI Software
NetSuite
Procountor
QuickBooks
Sage Intacct
Xero
Zoho Books
banqUP
Request
Clear Books
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MYOB
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request

Request example

{
  "title": "Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry",
  "currency_rate": 0.69,
  "currency": "USD",
  "company_id": "12345",
  "line_items": [
    {
      "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,
      "type": "debit",
      "tax_rate": {
        "id": "123456",
        "rate": 10
      },
      "tracking_category": {
        "id": "123456",
        "name": "New York"
      },
      "tracking_categories": [
        {
          "id": "123456",
          "name": "New York"
        }
      ],
      "ledger_account": {
        "id": "123456",
        "nominal_code": "N091",
        "code": "453"
      },
      "customer": {
        "id": "12345",
        "display_name": "Windsurf Shop",
        "name": "Windsurf Shop",
        "email": "boring@boring.com"
      },
      "supplier": {
        "id": "12345",
        "display_name": "Windsurf Shop",
        "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",
          "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"
        }
      },
      "line_number": 1
    },
    {
      "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,
      "type": "debit",
      "tax_rate": {
        "id": "123456",
        "rate": 10
      },
      "tracking_category": {
        "id": "123456",
        "name": "New York"
      },
      "tracking_categories": [
        {
          "id": "123456",
          "name": "New York"
        }
      ],
      "ledger_account": {
        "id": "123456",
        "nominal_code": "N091",
        "code": "453"
      },
      "customer": {
        "id": "12345",
        "display_name": "Windsurf Shop",
        "name": "Windsurf Shop",
        "email": "boring@boring.com"
      },
      "supplier": {
        "id": "12345",
        "display_name": "Windsurf Shop",
        "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",
          "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"
        }
      },
      "line_number": 1
    }
  ],
  "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",
      "name": "New York"
    }
  ],
  "accounting_period": "01-24",
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "journal-entries",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get Journal Entry

get
https://unify.apideck.com/accounting/journal-entries/{id}

Get Journal Entry

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200JournalEntries
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Exact Online
Exact Online NL
Exact Online UK
FreeAgent
Kashflow
Microsoft Dynamics 365 Business Central
NetSuite
Procountor
QuickBooks
Sage Business Cloud Accounting
Sage Intacct
Xero
Zoho Books
banqUP
Request
Clear Books
Request
FreshBooks
Request
MRI Software
Request
MYOB
Request
Visma Netvisor
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.journalEntriesOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "journal-entries",
  "operation": "one",
  "data": {
    "id": "12345",
    "title": "Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry",
    "currency_rate": 0.69,
    "currency": "USD",
    "company_id": "12345",
    "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,
        "type": "debit",
        "tax_rate": {
          "id": "123456",
          "code": "N-T",
          "name": "GST on Purchases",
          "rate": 10
        },
        "tracking_category": {
          "id": "123456",
          "name": "New York"
        },
        "tracking_categories": [
          {
            "id": "123456",
            "name": "New York"
          }
        ],
        "ledger_account": {
          "id": "123456",
          "name": "Bank account",
          "nominal_code": "N091",
          "code": "453"
        },
        "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",
            "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"
          }
        },
        "department_id": "12345",
        "location_id": "12345",
        "line_number": 1
      },
      {
        "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,
        "type": "debit",
        "tax_rate": {
          "id": "123456",
          "code": "N-T",
          "name": "GST on Purchases",
          "rate": 10
        },
        "tracking_category": {
          "id": "123456",
          "name": "New York"
        },
        "tracking_categories": [
          {
            "id": "123456",
            "name": "New York"
          }
        ],
        "ledger_account": {
          "id": "123456",
          "name": "Bank account",
          "nominal_code": "N091",
          "code": "453"
        },
        "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",
            "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"
          }
        },
        "department_id": "12345",
        "location_id": "12345",
        "line_number": 1
      }
    ],
    "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",
        "name": "New York"
      }
    ],
    "accounting_period": "01-24",
    "custom_mappings": {},
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z",
    "row_version": "1-12345"
  }
}

Update Journal Entry

patch
https://unify.apideck.com/accounting/journal-entries/{id}

Update Journal Entry

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
titlestring or null

Journal entry title

currency_ratenumber or null

Currency Exchange Rate at the time entity was recorded/generated.

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

company_idstring or null

The company or subsidiary id the transaction belongs to

line_itemsobjects>= 2 items

Requires a minimum of 2 line items that sum to 0

memostring or null

Reference for the journal entry.

posted_atstring

This is the date on which the journal entry was added. This can be different from the creation date and can also be backdated.

journal_symbolstring or null

Journal symbol of the entry. For example IND for indirect costs

tax_typestring or null

The specific category of tax associated with a transaction like sales or purchase

tax_codestring or null

Applicable tax id/code override if tax is not supplied on a line item basis.

numberstring or null

Journal entry number.

tracking_categoriesobjects or null or null

A list of linked tracking categories.

accounting_periodstring or null

Accounting period

row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

200JournalEntries
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

NetSuite
Procountor
QuickBooks
Sage Intacct
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request
Xero
Request

Request example

{
  "title": "Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry",
  "currency_rate": 0.69,
  "currency": "USD",
  "company_id": "12345",
  "line_items": [
    {
      "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,
      "type": "debit",
      "tax_rate": {
        "id": "123456",
        "rate": 10
      },
      "tracking_category": {
        "id": "123456",
        "name": "New York"
      },
      "tracking_categories": [
        {
          "id": "123456",
          "name": "New York"
        }
      ],
      "ledger_account": {
        "id": "123456",
        "nominal_code": "N091",
        "code": "453"
      },
      "customer": {
        "id": "12345",
        "display_name": "Windsurf Shop",
        "name": "Windsurf Shop",
        "email": "boring@boring.com"
      },
      "supplier": {
        "id": "12345",
        "display_name": "Windsurf Shop",
        "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",
          "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"
        }
      },
      "line_number": 1
    },
    {
      "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,
      "type": "debit",
      "tax_rate": {
        "id": "123456",
        "rate": 10
      },
      "tracking_category": {
        "id": "123456",
        "name": "New York"
      },
      "tracking_categories": [
        {
          "id": "123456",
          "name": "New York"
        }
      ],
      "ledger_account": {
        "id": "123456",
        "nominal_code": "N091",
        "code": "453"
      },
      "customer": {
        "id": "12345",
        "display_name": "Windsurf Shop",
        "name": "Windsurf Shop",
        "email": "boring@boring.com"
      },
      "supplier": {
        "id": "12345",
        "display_name": "Windsurf Shop",
        "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",
          "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"
        }
      },
      "line_number": 1
    }
  ],
  "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",
      "name": "New York"
    }
  ],
  "accounting_period": "01-24",
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "journal-entries",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete Journal Entry

delete
https://unify.apideck.com/accounting/journal-entries/{id}

Delete Journal Entry

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200JournalEntries
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Exact Online
Exact Online NL
Exact Online UK
QuickBooks
Sage Intacct
Zoho Books
banqUP
Request
Clear Books
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request
Xero
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.journalEntriesDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "journal-entries",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Purchase Orders

The Purchase Orders model

idstring

A unique identifier for an object.

downstream_idstring or null

The third-party API ID of original entity

po_numberstring or null

A PO Number uniquely identifies a purchase order and is generally defined by the buyer.

referencestring or null

Optional purchase order reference.

supplierobject or null

The supplier this entity is linked to.

company_idstring or null

The company or subsidiary id the transaction belongs to

Purchase Orders example
{}

List Purchase Orders

get
https://unify.apideck.com/accounting/purchase-orders

List Purchase Orders

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

pass_throughobjectpass_through[example_downstream_property]=example_downstream_property

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

filterobjectfilter[updated_since]=2020-09-30T07:43:32.000Z

Apply filters

sortobjectsort[by]=updated_at

Apply sorting

Responses

200PurchaseOrders
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Microsoft Dynamics 365 Business Central
MRI Software
NetSuite
Procountor
QuickBooks
Visma Netvisor
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
MYOB
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.purchaseOrdersAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "PurchaseOrders",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "downstream_id": "12345",
      "po_number": "90000117",
      "reference": "123456",
      "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",
          "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"
        }
      },
      "company_id": "12345",
      "status": "open",
      "issued_date": "2020-09-30",
      "delivery_date": "2020-09-30",
      "expected_arrival_date": "2020-09-30",
      "currency": "USD",
      "currency_rate": 0.69,
      "sub_total": 27500,
      "total_tax": 2500,
      "total": 27500,
      "tax_inclusive": true,
      "line_items": [
        {
          "id": "12345",
          "row_id": "12345",
          "code": "120-C",
          "line_number": 1,
          "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
          "type": "sales_item",
          "tax_amount": 27500,
          "total_amount": 27500,
          "quantity": 1,
          "unit_price": 27500.5,
          "unit_of_measure": "pc.",
          "discount_percentage": 0.01,
          "discount_amount": 19.99,
          "location_id": "1234",
          "department_id": "1234",
          "item": {
            "id": "12344",
            "code": "120-C",
            "name": "Model Y"
          },
          "tax_rate": {
            "id": "123456",
            "code": "N-T",
            "name": "GST on Purchases",
            "rate": 10
          },
          "tracking_categories": [
            {
              "id": "123456",
              "name": "New York"
            }
          ],
          "ledger_account": {
            "id": "123456",
            "name": "Bank account",
            "nominal_code": "N091",
            "code": "453"
          },
          "custom_fields": [
            {
              "id": "2389328923893298",
              "name": "employee_level",
              "description": "Employee Level",
              "value": "Uses Salesforce and Marketo"
            }
          ],
          "row_version": "1-12345",
          "updated_by": "12345",
          "created_by": "12345",
          "created_at": "2020-09-30T07:43:32.000Z",
          "updated_at": "2020-09-30T07:43:32.000Z"
        }
      ],
      "shipping_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",
        "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"
      },
      "ledger_account": {
        "id": "123456",
        "name": "Bank account",
        "nominal_code": "N091",
        "code": "453"
      },
      "template_id": "123456",
      "discount_percentage": 5.5,
      "bank_account": {
        "bank_name": "Monzo",
        "account_number": "123465",
        "account_name": "SPACEX LLC",
        "account_type": "credit_card",
        "iban": "CH2989144532982975332",
        "bic": "AUDSCHGGXXX",
        "routing_number": "012345678",
        "bsb_number": "062-001",
        "branch_identifier": "001",
        "bank_code": "BNH",
        "currency": "USD"
      },
      "accounting_by_row": false,
      "due_date": "2020-10-30",
      "payment_method": "cash",
      "tax_code": "1234",
      "channel": "email",
      "memo": "Thank you for the partnership and have a great day!",
      "tracking_categories": [
        {
          "id": "123456",
          "name": "New York"
        }
      ],
      "custom_mappings": {},
      "row_version": "1-12345",
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create Purchase Order

post
https://unify.apideck.com/accounting/purchase-orders

Create Purchase Order

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
po_numberstring or null

A PO Number uniquely identifies a purchase order and is generally defined by the buyer.

referencestring or null

Optional purchase order reference.

supplierobject or null

The supplier this entity is linked to.

company_idstring or null

The company or subsidiary id the transaction belongs to

statusstring or null
Enum:draftopencloseddeleted
issued_datestring or null

Date purchase order was issued - YYYY-MM-DD.

delivery_datestring or null

The date on which the purchase order is to be delivered - YYYY-MM-DD.

expected_arrival_datestring or null

The date on which the order is expected to arrive - YYYY-MM-DD.

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

currency_ratenumber or null

Currency Exchange Rate at the time entity was recorded/generated.

sub_totalnumber or null

Sub-total amount, normally before tax.

total_taxnumber or null

Total tax amount applied to this invoice.

totalnumber or null

Total amount of invoice, including tax.

tax_inclusiveboolean or null

Amounts are including tax

line_itemsobjects
shipping_addressobject
ledger_accountobject or null
template_idstring or null

Optional purchase order template

discount_percentagenumber or null

Discount percentage applied to this transaction.

bank_accountobject
accounting_by_rowboolean or null

Indicates if accounting by row is used (true) or not (false). Accounting by row means that a separate ledger transaction is created for each row.

due_datestring

The due date is the date on which a payment is scheduled to be received - YYYY-MM-DD.

payment_methodstring or null

Payment method used for the transaction, such as cash, credit card, bank transfer, or check

tax_codestring or null

Applicable tax id/code override if tax is not supplied on a line item basis.

channelstring or null

The channel through which the transaction is processed.

memostring or null

Message for the supplier. This text appears on the Purchase Order.

tracking_categoriesobjects or null or null

A list of linked tracking categories.

row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

201PurchaseOrders
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Microsoft Dynamics 365 Business Central
NetSuite
Procountor
QuickBooks
Visma Netvisor
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
MRI Software
Request
MYOB
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request

Request example

{
  "po_number": "90000117",
  "reference": "123456",
  "supplier": {
    "id": "12345",
    "display_name": "Windsurf Shop",
    "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",
      "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"
    }
  },
  "company_id": "12345",
  "status": "open",
  "issued_date": "2020-09-30",
  "delivery_date": "2020-09-30",
  "expected_arrival_date": "2020-09-30",
  "currency": "USD",
  "currency_rate": 0.69,
  "sub_total": 27500,
  "total_tax": 2500,
  "total": 27500,
  "tax_inclusive": true,
  "line_items": [
    {
      "id": "12345",
      "row_id": "12345",
      "code": "120-C",
      "line_number": 1,
      "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
      "type": "sales_item",
      "tax_amount": 27500,
      "total_amount": 27500,
      "quantity": 1,
      "unit_price": 27500.5,
      "unit_of_measure": "pc.",
      "discount_percentage": 0.01,
      "discount_amount": 19.99,
      "location_id": "1234",
      "department_id": "1234",
      "item": {
        "id": "12344",
        "code": "120-C",
        "name": "Model Y"
      },
      "tax_rate": {
        "id": "123456",
        "rate": 10
      },
      "tracking_categories": [
        {
          "id": "123456",
          "name": "New York"
        }
      ],
      "ledger_account": {
        "id": "123456",
        "nominal_code": "N091",
        "code": "453"
      },
      "custom_fields": [
        {
          "id": "2389328923893298",
          "name": "employee_level",
          "description": "Employee Level",
          "value": "Uses Salesforce and Marketo"
        }
      ],
      "row_version": "1-12345"
    }
  ],
  "shipping_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",
    "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"
  },
  "ledger_account": {
    "id": "123456",
    "nominal_code": "N091",
    "code": "453"
  },
  "template_id": "123456",
  "discount_percentage": 5.5,
  "bank_account": {
    "bank_name": "Monzo",
    "account_number": "123465",
    "account_name": "SPACEX LLC",
    "account_type": "credit_card",
    "iban": "CH2989144532982975332",
    "bic": "AUDSCHGGXXX",
    "routing_number": "012345678",
    "bsb_number": "062-001",
    "branch_identifier": "001",
    "bank_code": "BNH",
    "currency": "USD"
  },
  "accounting_by_row": false,
  "due_date": "2020-10-30",
  "payment_method": "cash",
  "tax_code": "1234",
  "channel": "email",
  "memo": "Thank you for the partnership and have a great day!",
  "tracking_categories": [
    {
      "id": "123456",
      "name": "New York"
    }
  ],
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "PurchaseOrders",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get Purchase Order

get
https://unify.apideck.com/accounting/purchase-orders/{id}

Get Purchase Order

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200PurchaseOrders
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Microsoft Dynamics 365 Business Central
MRI Software
NetSuite
Procountor
QuickBooks
Visma Netvisor
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
MYOB
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.purchaseOrdersOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "PurchaseOrders",
  "operation": "one",
  "data": {
    "id": "12345",
    "downstream_id": "12345",
    "po_number": "90000117",
    "reference": "123456",
    "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",
        "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"
      }
    },
    "company_id": "12345",
    "status": "open",
    "issued_date": "2020-09-30",
    "delivery_date": "2020-09-30",
    "expected_arrival_date": "2020-09-30",
    "currency": "USD",
    "currency_rate": 0.69,
    "sub_total": 27500,
    "total_tax": 2500,
    "total": 27500,
    "tax_inclusive": true,
    "line_items": [
      {
        "id": "12345",
        "row_id": "12345",
        "code": "120-C",
        "line_number": 1,
        "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
        "type": "sales_item",
        "tax_amount": 27500,
        "total_amount": 27500,
        "quantity": 1,
        "unit_price": 27500.5,
        "unit_of_measure": "pc.",
        "discount_percentage": 0.01,
        "discount_amount": 19.99,
        "location_id": "1234",
        "department_id": "1234",
        "item": {
          "id": "12344",
          "code": "120-C",
          "name": "Model Y"
        },
        "tax_rate": {
          "id": "123456",
          "code": "N-T",
          "name": "GST on Purchases",
          "rate": 10
        },
        "tracking_categories": [
          {
            "id": "123456",
            "name": "New York"
          }
        ],
        "ledger_account": {
          "id": "123456",
          "name": "Bank account",
          "nominal_code": "N091",
          "code": "453"
        },
        "custom_fields": [
          {
            "id": "2389328923893298",
            "name": "employee_level",
            "description": "Employee Level",
            "value": "Uses Salesforce and Marketo"
          }
        ],
        "row_version": "1-12345",
        "updated_by": "12345",
        "created_by": "12345",
        "created_at": "2020-09-30T07:43:32.000Z",
        "updated_at": "2020-09-30T07:43:32.000Z"
      }
    ],
    "shipping_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",
      "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"
    },
    "ledger_account": {
      "id": "123456",
      "name": "Bank account",
      "nominal_code": "N091",
      "code": "453"
    },
    "template_id": "123456",
    "discount_percentage": 5.5,
    "bank_account": {
      "bank_name": "Monzo",
      "account_number": "123465",
      "account_name": "SPACEX LLC",
      "account_type": "credit_card",
      "iban": "CH2989144532982975332",
      "bic": "AUDSCHGGXXX",
      "routing_number": "012345678",
      "bsb_number": "062-001",
      "branch_identifier": "001",
      "bank_code": "BNH",
      "currency": "USD"
    },
    "accounting_by_row": false,
    "due_date": "2020-10-30",
    "payment_method": "cash",
    "tax_code": "1234",
    "channel": "email",
    "memo": "Thank you for the partnership and have a great day!",
    "tracking_categories": [
      {
        "id": "123456",
        "name": "New York"
      }
    ],
    "custom_mappings": {},
    "row_version": "1-12345",
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z"
  }
}

Update Purchase Order

patch
https://unify.apideck.com/accounting/purchase-orders/{id}

Update Purchase Order

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
po_numberstring or null

A PO Number uniquely identifies a purchase order and is generally defined by the buyer.

referencestring or null

Optional purchase order reference.

supplierobject or null

The supplier this entity is linked to.

company_idstring or null

The company or subsidiary id the transaction belongs to

statusstring or null
Enum:draftopencloseddeleted
issued_datestring or null

Date purchase order was issued - YYYY-MM-DD.

delivery_datestring or null

The date on which the purchase order is to be delivered - YYYY-MM-DD.

expected_arrival_datestring or null

The date on which the order is expected to arrive - YYYY-MM-DD.

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

currency_ratenumber or null

Currency Exchange Rate at the time entity was recorded/generated.

sub_totalnumber or null

Sub-total amount, normally before tax.

total_taxnumber or null

Total tax amount applied to this invoice.

totalnumber or null

Total amount of invoice, including tax.

tax_inclusiveboolean or null

Amounts are including tax

line_itemsobjects
shipping_addressobject
ledger_accountobject or null
template_idstring or null

Optional purchase order template

discount_percentagenumber or null

Discount percentage applied to this transaction.

bank_accountobject
accounting_by_rowboolean or null

Indicates if accounting by row is used (true) or not (false). Accounting by row means that a separate ledger transaction is created for each row.

due_datestring

The due date is the date on which a payment is scheduled to be received - YYYY-MM-DD.

payment_methodstring or null

Payment method used for the transaction, such as cash, credit card, bank transfer, or check

tax_codestring or null

Applicable tax id/code override if tax is not supplied on a line item basis.

channelstring or null

The channel through which the transaction is processed.

memostring or null

Message for the supplier. This text appears on the Purchase Order.

tracking_categoriesobjects or null or null

A list of linked tracking categories.

row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

200PurchaseOrders
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Microsoft Dynamics 365 Business Central
NetSuite
Procountor
QuickBooks
Visma Netvisor
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
MRI Software
Request
MYOB
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request

Request example

{
  "po_number": "90000117",
  "reference": "123456",
  "supplier": {
    "id": "12345",
    "display_name": "Windsurf Shop",
    "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",
      "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"
    }
  },
  "company_id": "12345",
  "status": "open",
  "issued_date": "2020-09-30",
  "delivery_date": "2020-09-30",
  "expected_arrival_date": "2020-09-30",
  "currency": "USD",
  "currency_rate": 0.69,
  "sub_total": 27500,
  "total_tax": 2500,
  "total": 27500,
  "tax_inclusive": true,
  "line_items": [
    {
      "id": "12345",
      "row_id": "12345",
      "code": "120-C",
      "line_number": 1,
      "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
      "type": "sales_item",
      "tax_amount": 27500,
      "total_amount": 27500,
      "quantity": 1,
      "unit_price": 27500.5,
      "unit_of_measure": "pc.",
      "discount_percentage": 0.01,
      "discount_amount": 19.99,
      "location_id": "1234",
      "department_id": "1234",
      "item": {
        "id": "12344",
        "code": "120-C",
        "name": "Model Y"
      },
      "tax_rate": {
        "id": "123456",
        "rate": 10
      },
      "tracking_categories": [
        {
          "id": "123456",
          "name": "New York"
        }
      ],
      "ledger_account": {
        "id": "123456",
        "nominal_code": "N091",
        "code": "453"
      },
      "custom_fields": [
        {
          "id": "2389328923893298",
          "name": "employee_level",
          "description": "Employee Level",
          "value": "Uses Salesforce and Marketo"
        }
      ],
      "row_version": "1-12345"
    }
  ],
  "shipping_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",
    "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"
  },
  "ledger_account": {
    "id": "123456",
    "nominal_code": "N091",
    "code": "453"
  },
  "template_id": "123456",
  "discount_percentage": 5.5,
  "bank_account": {
    "bank_name": "Monzo",
    "account_number": "123465",
    "account_name": "SPACEX LLC",
    "account_type": "credit_card",
    "iban": "CH2989144532982975332",
    "bic": "AUDSCHGGXXX",
    "routing_number": "012345678",
    "bsb_number": "062-001",
    "branch_identifier": "001",
    "bank_code": "BNH",
    "currency": "USD"
  },
  "accounting_by_row": false,
  "due_date": "2020-10-30",
  "payment_method": "cash",
  "tax_code": "1234",
  "channel": "email",
  "memo": "Thank you for the partnership and have a great day!",
  "tracking_categories": [
    {
      "id": "123456",
      "name": "New York"
    }
  ],
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "PurchaseOrders",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete Purchase Order

delete
https://unify.apideck.com/accounting/purchase-orders/{id}

Delete Purchase Order

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200PurchaseOrders
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Microsoft Dynamics 365 Business Central
QuickBooks
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.purchaseOrdersDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "PurchaseOrders",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Subsidiaries

The Subsidiaries model

idstring

A unique identifier for an object.

parent_idstring or null

A unique identifier for an object.

namestring or null

The name of the company.

statusstring
Enum:activeinactive

Based on the status some functionality is enabled or disabled.

custom_mappingsobject or null

When custom mappings are configured on the resource, the result is included here.

row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

Subsidiaries example
{}

List Subsidiaries

get
https://unify.apideck.com/accounting/subsidiaries

List Subsidiaries

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Subsidiaries
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

MRI Software
NetSuite
Sage Business Cloud Accounting
Sage Intacct
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MYOB
Request
Procountor
Request
QuickBooks
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.subsidiariesAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "subsidiaries",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "parent_id": "12345",
      "name": "SpaceX",
      "status": "active",
      "custom_mappings": {},
      "row_version": "1-12345",
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create Subsidiary

post
https://unify.apideck.com/accounting/subsidiaries

Create Subsidiary

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
parent_idstring or null

A unique identifier for an object.

namestring or null

The name of the company.

statusstring
Enum:activeinactive

Based on the status some functionality is enabled or disabled.

row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

201Subsidiaries
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

NetSuite
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Request example

{
  "parent_id": "12345",
  "name": "SpaceX",
  "status": "active",
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "subsidiaries",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get Subsidiary

get
https://unify.apideck.com/accounting/subsidiaries/{id}

Get Subsidiary

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Subsidiary
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

NetSuite
Sage Business Cloud Accounting
Sage Intacct
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
Procountor
Request
QuickBooks
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.subsidiariesOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "subsidiaries",
  "operation": "one",
  "data": {
    "id": "12345",
    "parent_id": "12345",
    "name": "SpaceX",
    "status": "active",
    "custom_mappings": {},
    "row_version": "1-12345",
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z"
  }
}

Update Subsidiary

patch
https://unify.apideck.com/accounting/subsidiaries/{id}

Update Subsidiary

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
parent_idstring or null

A unique identifier for an object.

namestring or null

The name of the company.

statusstring
Enum:activeinactive

Based on the status some functionality is enabled or disabled.

row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

200Subsidiaries
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

NetSuite
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Request example

{
  "parent_id": "12345",
  "name": "SpaceX",
  "status": "active",
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "subsidiaries",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete Subsidiary

delete
https://unify.apideck.com/accounting/subsidiaries/{id}

Delete Subsidiary

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200Subsidiarys
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

NetSuite
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.subsidiariesDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "subsidiaries",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Locations

The Locations model

idstring

A unique identifier for an object.

parent_idstring or null

A unique identifier for an object.

company_namestring or null

The name of the company.

display_namestring or null

The display name of the location.

statusstring
Enum:activeinactive

Based on the status some functionality is enabled or disabled.

addressesobjects
Locations example
{}

List Locations

get
https://unify.apideck.com/accounting/locations

List Locations

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

filterobjectfilter[subsidiary]=1

Apply filters

Responses

200Locations
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Microsoft Dynamics 365 Business Central
MRI Software
NetSuite
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
MYOB
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.locationsAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "subsidiaries",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "parent_id": "12345",
      "company_name": "SpaceX",
      "display_name": "11 UT - South Jordan",
      "status": "active",
      "addresses": [
        {
          "id": "123",
          "type": "primary",
          "string": "25 Spring Street, Blackburn, VIC 3130",
          "name": "HQ US",
          "line1": "Main street",
          "line2": "apt #",
          "line3": "Suite #",
          "line4": "delivery instructions",
          "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"
        }
      ],
      "subsidiaries": [
        {
          "id": "12345",
          "name": "SpaceX"
        }
      ],
      "custom_mappings": {},
      "row_version": "1-12345",
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create Location

post
https://unify.apideck.com/accounting/locations

Create Location

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
parent_idstring or null

A unique identifier for an object.

company_namestring or null

The name of the company.

display_namestring or null

The display name of the location.

statusstring
Enum:activeinactive

Based on the status some functionality is enabled or disabled.

addressesobjects
subsidiariesobjects
row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

201Location
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Request example

{
  "parent_id": "12345",
  "company_name": "SpaceX",
  "display_name": "11 UT - South Jordan",
  "status": "active",
  "addresses": [
    {
      "id": "123",
      "type": "primary",
      "string": "25 Spring Street, Blackburn, VIC 3130",
      "name": "HQ US",
      "line1": "Main street",
      "line2": "apt #",
      "line3": "Suite #",
      "line4": "delivery instructions",
      "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"
    }
  ],
  "subsidiaries": [
    {
      "name": "SpaceX"
    }
  ],
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "locations",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get Location

get
https://unify.apideck.com/accounting/locations/{id}

Get Location

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Location
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Microsoft Dynamics 365 Business Central
NetSuite
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
MRI Software
Request
MYOB
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.locationsOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "subsidiaries",
  "operation": "one",
  "data": {
    "id": "12345",
    "parent_id": "12345",
    "company_name": "SpaceX",
    "display_name": "11 UT - South Jordan",
    "status": "active",
    "addresses": [
      {
        "id": "123",
        "type": "primary",
        "string": "25 Spring Street, Blackburn, VIC 3130",
        "name": "HQ US",
        "line1": "Main street",
        "line2": "apt #",
        "line3": "Suite #",
        "line4": "delivery instructions",
        "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"
      }
    ],
    "subsidiaries": [
      {
        "id": "12345",
        "name": "SpaceX"
      }
    ],
    "custom_mappings": {},
    "row_version": "1-12345",
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z"
  }
}

Update Location

patch
https://unify.apideck.com/accounting/locations/{id}

Update Location

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
parent_idstring or null

A unique identifier for an object.

company_namestring or null

The name of the company.

display_namestring or null

The display name of the location.

statusstring
Enum:activeinactive

Based on the status some functionality is enabled or disabled.

addressesobjects
subsidiariesobjects
row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

200Location
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Request example

{
  "parent_id": "12345",
  "company_name": "SpaceX",
  "display_name": "11 UT - South Jordan",
  "status": "active",
  "addresses": [
    {
      "id": "123",
      "type": "primary",
      "string": "25 Spring Street, Blackburn, VIC 3130",
      "name": "HQ US",
      "line1": "Main street",
      "line2": "apt #",
      "line3": "Suite #",
      "line4": "delivery instructions",
      "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"
    }
  ],
  "subsidiaries": [
    {
      "name": "SpaceX"
    }
  ],
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "locations",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete Location

delete
https://unify.apideck.com/accounting/locations/{id}

Delete Location

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200Location deleted
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.locationsDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "locations",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Departments

The Departments model

idstring

A unique identifier for an object.

parent_idstring or null

A unique identifier for an object.

namestring or null

The name of the department.

statusstring
Enum:activeinactive

Based on the status some functionality is enabled or disabled.

subsidiariesobjects
custom_mappingsobject or null

When custom mappings are configured on the resource, the result is included here.

Departments example
{}

List Departments

get
https://unify.apideck.com/accounting/departments

List Departments

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

filterobjectfilter[subsidiary]=1

Apply filters

Responses

200Departments
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

MRI Software
NetSuite
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MYOB
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.departmentsAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "subsidiaries",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "parent_id": "12345",
      "name": "Sales",
      "status": "active",
      "subsidiaries": [
        {
          "id": "12345",
          "name": "SpaceX"
        }
      ],
      "custom_mappings": {},
      "row_version": "1-12345",
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create Department

post
https://unify.apideck.com/accounting/departments

Create Department

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
parent_idstring or null

A unique identifier for an object.

namestring or null

The name of the department.

statusstring
Enum:activeinactive

Based on the status some functionality is enabled or disabled.

subsidiariesobjects
row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

201Department
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Request example

{
  "parent_id": "12345",
  "name": "Sales",
  "status": "active",
  "subsidiaries": [
    {
      "name": "SpaceX"
    }
  ],
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "departments",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get Department

get
https://unify.apideck.com/accounting/departments/{id}

Get Department

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Location
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

NetSuite
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.departmentsOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "subsidiaries",
  "operation": "one",
  "data": {
    "id": "12345",
    "parent_id": "12345",
    "name": "Sales",
    "status": "active",
    "subsidiaries": [
      {
        "id": "12345",
        "name": "SpaceX"
      }
    ],
    "custom_mappings": {},
    "row_version": "1-12345",
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z"
  }
}

Update Department

patch
https://unify.apideck.com/accounting/departments/{id}

Update Department

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
parent_idstring or null

A unique identifier for an object.

namestring or null

The name of the department.

statusstring
Enum:activeinactive

Based on the status some functionality is enabled or disabled.

subsidiariesobjects
row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

200Department
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Request example

{
  "parent_id": "12345",
  "name": "Sales",
  "status": "active",
  "subsidiaries": [
    {
      "name": "SpaceX"
    }
  ],
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "departments",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete Department

delete
https://unify.apideck.com/accounting/departments/{id}

Delete Department

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200Department deleted
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.departmentsDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "departments",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Attachments

The Attachments model

idstring

A unique identifier for an object.

display_idstring or null

The display id of the file

namestring or null

The name of the file

mime_typestring or null

The MIME type of the file.

sizeinteger or null

The size of the file in bytes

referenceobject
Attachments example
{}

List Attachments

get
https://unify.apideck.com/accounting/attachments/{reference_type}/{reference_id}

List Attachments

Authorizations:

Path parameters

reference_typestring
required
Enum:invoicebillexpense

The reference type of the document.

reference_idstring
required

The reference id of the object to retrieve.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Attachments
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

QuickBooks
Sage Business Cloud Accounting
Xero
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
Sage Intacct
Request
Visma Netvisor
Request
Zoho Books
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

const params = {
  referenceType: 'invoice',
  referenceId: '123456'
}

try {
  const { data } = await apideck.accounting.attachmentsAll(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "PurchaseOrders",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "display_id": "sample ID",
      "name": "sample.jpg",
      "mime_type": "image/jpeg",
      "size": 1810673,
      "reference": {
        "type": "invoice",
        "id": "12345"
      },
      "description": "A sample image",
      "parent_folder_id": "123",
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Upload attachment
No SDK Support

post
https://upload.apideck.com/accounting/attachments/{reference_type}/{reference_id}

Upload attachment

Authorizations:

Path parameters

reference_typestring
required
Enum:invoicebillexpense

The reference type of the document.

reference_idstring
required

The reference id of the object to retrieve.

Header parameters

x-apideck-metadataobject
required

Metadata to attach to the attachment file

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

content-typestring
required

The content-type of the file being uploaded

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

201Attachments
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

NetSuite
QuickBooks
Sage Business Cloud Accounting
Sage Intacct
Xero
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
Procountor
Request
Visma Netvisor
Request
Zoho Books
Request

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "google-drive",
  "resource": "files",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get Attachment

get
https://unify.apideck.com/accounting/attachments/{reference_type}/{reference_id}/{id}

Get Attachment

Authorizations:

Path parameters

reference_typestring
required
Enum:invoicebillexpense

The reference type of the document.

reference_idstring
required

The reference id of the object to retrieve.

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Attachments
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

NetSuite
QuickBooks
Sage Business Cloud Accounting
Sage Intacct
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
Procountor
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

const params = {
  referenceType: 'invoice',
  referenceId: '123456',
  id: 'id_example'
}

try {
  const { data } = await apideck.accounting.attachmentsOne(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "payments",
  "operation": "one",
  "data": {
    "id": "12345",
    "display_id": "sample ID",
    "name": "sample.jpg",
    "mime_type": "image/jpeg",
    "size": 1810673,
    "reference": {
      "type": "invoice",
      "id": "12345"
    },
    "description": "A sample image",
    "parent_folder_id": "123",
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z"
  }
}

Delete Attachment

delete
https://unify.apideck.com/accounting/attachments/{reference_type}/{reference_id}/{id}

Delete Attachment

Authorizations:

Path parameters

reference_typestring
required
Enum:invoicebillexpense

The reference type of the document.

reference_idstring
required

The reference id of the object to retrieve.

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200Attachments
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

QuickBooks
Sage Business Cloud Accounting
Sage Intacct
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

const params = {
  referenceType: 'invoice',
  referenceId: '123456',
  id: 'id_example'
}

try {
  const { data } = await apideck.accounting.attachmentsDelete(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "google-drive",
  "resource": "files",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Download Attachment

get
https://unify.apideck.com/accounting/attachments/{reference_type}/{reference_id}/{id}/download

Download Attachment

Authorizations:

Path parameters

reference_typestring
required
Enum:invoicebillexpense

The reference type of the document.

reference_idstring
required

The reference id of the object to retrieve.

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Attachment Download
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

NetSuite
QuickBooks
Sage Intacct
Xero
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request
Zoho Books
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

const params = {
  referenceType: 'invoice',
  referenceId: '123456',
  id: 'id_example'
}

try {
  const { data } = await apideck.accounting.attachmentsDownload(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 400,
  "error": "Bad Request",
  "type_name": "RequestValidationError",
  "message": "Invalid Params",
  "detail": "Missing property foobar",
  "ref": "https://developers.apideck.com/errors#requestvalidationerror"
}

Tracking Categories

The Tracking Categories model

idstring

A unique identifier for an object.

parent_idstring or null

A unique identifier for an object.

namestring

The name of the tracking category.

codestring or null

The code of the tracking category.

statusstring
Enum:activeinactive

Based on the status some functionality is enabled or disabled.

custom_mappingsobject or null

When custom mappings are configured on the resource, the result is included here.

Tracking Categories example
{}

List Tracking Categories

get
https://unify.apideck.com/accounting/tracking-categories

List Tracking Categories

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

pass_throughobjectpass_through[example_downstream_property]=example_downstream_property

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Tracking categories
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

NetSuite
QuickBooks
Sage Intacct
Xero
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request
Zoho Books
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.trackingCategoriesAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "tracking-categories",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "parent_id": "12345",
      "name": "Department",
      "code": "100",
      "status": "active",
      "custom_mappings": {},
      "row_version": "1-12345",
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z",
      "subsidiaries": [
        {
          "id": "string"
        }
      ]
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create Tracking Category

post
https://unify.apideck.com/accounting/tracking-categories

Create Tracking Category

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
parent_idstring or null

A unique identifier for an object.

namestring

The name of the tracking category.

codestring or null

The code of the tracking category.

statusstring
Enum:activeinactive

Based on the status some functionality is enabled or disabled.

row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

subsidiariesobjects

The subsidiaries the account belongs to.

Responses

201Tracking category created
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

NetSuite
QuickBooks
Sage Intacct
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Request example

{
  "parent_id": "12345",
  "name": "Department",
  "code": "100",
  "status": "active",
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ],
  "subsidiaries": [
    {
      "id": "string"
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "tracking-categories",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get Tracking Category

get
https://unify.apideck.com/accounting/tracking-categories/{id}

Get Tracking Category

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Tracking category
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

NetSuite
QuickBooks
Sage Intacct
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.trackingCategoriesOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "tracking-categories",
  "operation": "one",
  "data": {
    "id": "12345",
    "parent_id": "12345",
    "name": "Department",
    "code": "100",
    "status": "active",
    "custom_mappings": {},
    "row_version": "1-12345",
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z",
    "subsidiaries": [
      {
        "id": "string"
      }
    ]
  }
}

Update Tracking Category

patch
https://unify.apideck.com/accounting/tracking-categories/{id}

Update Tracking Category

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
parent_idstring or null

A unique identifier for an object.

namestring

The name of the tracking category.

codestring or null

The code of the tracking category.

statusstring
Enum:activeinactive

Based on the status some functionality is enabled or disabled.

row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

subsidiariesobjects

The subsidiaries the account belongs to.

Responses

200Tracking category updated
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

NetSuite
QuickBooks
Sage Intacct
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Request example

{
  "parent_id": "12345",
  "name": "Department",
  "code": "100",
  "status": "active",
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ],
  "subsidiaries": [
    {
      "id": "string"
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "tracking-categories",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete Tracking Category

delete
https://unify.apideck.com/accounting/tracking-categories/{id}

Delete Tracking Category

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200Tracking category deleted
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

NetSuite
Sage Intacct
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.trackingCategoriesDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "tracking-categories",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Bill Payments

The Bill Payments model

idstring
required

A unique identifier for an object.

downstream_idstring or null

The third-party API ID of original entity

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

currency_ratenumber or null

Currency Exchange Rate at the time entity was recorded/generated.

total_amountnumber or null
required

The total amount of the transaction

referencestring or null

Optional transaction reference message ie: Debit remittance detail.

Bill Payments example
{}

List Bill Payments

get
https://unify.apideck.com/accounting/bill-payments

List Bill Payments

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

filterobjectfilter[updated_since]=2020-09-30T07:43:32.000Z

Apply filters

sortobjectsort[by]=updated_at

Apply sorting

pass_throughobjectpass_through[example_downstream_property]=example_downstream_property

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Bill Payments
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
NetSuite
QuickBooks
Sage Intacct
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.billPaymentsAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "payments",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "downstream_id": "12345",
      "currency": "USD",
      "currency_rate": 0.69,
      "total_amount": 49.99,
      "reference": "123456",
      "payment_method": "cash",
      "payment_method_reference": "123456",
      "payment_method_id": "12345",
      "account": {
        "id": "123456",
        "name": "Bank account",
        "nominal_code": "N091",
        "code": "453"
      },
      "transaction_date": "2021-05-01T12:00:00.000Z",
      "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",
          "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"
        }
      },
      "company_id": "12345",
      "reconciled": true,
      "status": "authorised",
      "type": "accounts_payable",
      "allocations": [
        {
          "id": "12345",
          "type": "bill",
          "code": "N091",
          "amount": 49.99,
          "allocation_id": "123456"
        }
      ],
      "note": "Some notes about this transaction",
      "number": "123456",
      "tracking_categories": [
        {
          "id": "123456",
          "name": "New York"
        }
      ],
      "custom_fields": [
        {
          "id": "2389328923893298",
          "name": "employee_level",
          "description": "Employee Level",
          "value": "Uses Salesforce and Marketo"
        }
      ],
      "row_version": "1-12345",
      "display_id": "123456",
      "custom_mappings": {},
      "updated_by": "12345",
      "created_by": "12345",
      "created_at": "2020-09-30T07:43:32.000Z",
      "updated_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create Bill Payment

post
https://unify.apideck.com/accounting/bill-payments

Create Bill Payment

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

currency_ratenumber or null

Currency Exchange Rate at the time entity was recorded/generated.

total_amountnumber or null
required

The total amount of the transaction

referencestring or null

Optional transaction reference message ie: Debit remittance detail.

payment_methodstring or null

Payment method used for the transaction, such as cash, credit card, bank transfer, or check

payment_method_referencestring or null

Optional reference message returned by payment method on processing

payment_method_idstring or null

A unique identifier for an object.

accountobject or null
transaction_datestring or null
required

The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD

supplierobject or null

The supplier this entity is linked to.

company_idstring or null

The company or subsidiary id the transaction belongs to

reconciledboolean or null

Indicates if the transaction has been reconciled.

statusstring
Enum:authorisedpaidvoideddeleted

Status of payment

typestring
Enum:accounts_payable_creditaccounts_payable_overpaymentaccounts_payable_prepaymentaccounts_payable

Type of payment

allocationsobjects
notestring or null

Note associated with the transaction

numberstring or null

Number associated with the transaction

tracking_categoriesobjects or null or null

A list of linked tracking categories.

custom_fieldsobjects
row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

display_idstring or null

Id to be displayed.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

201Bill Payment created
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
NetSuite
QuickBooks
Sage Intacct
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request

Request example

{
  "currency": "USD",
  "currency_rate": 0.69,
  "total_amount": 49.99,
  "reference": "123456",
  "payment_method": "cash",
  "payment_method_reference": "123456",
  "payment_method_id": "12345",
  "account": {
    "id": "123456",
    "nominal_code": "N091",
    "code": "453"
  },
  "transaction_date": "2021-05-01T12:00:00.000Z",
  "supplier": {
    "id": "12345",
    "display_name": "Windsurf Shop",
    "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",
      "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"
    }
  },
  "company_id": "12345",
  "reconciled": true,
  "status": "authorised",
  "type": "accounts_payable",
  "allocations": [
    {
      "id": "12345",
      "type": "bill",
      "amount": 49.99,
      "allocation_id": "123456"
    }
  ],
  "note": "Some notes about this transaction",
  "number": "123456",
  "tracking_categories": [
    {
      "id": "123456",
      "name": "New York"
    }
  ],
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "row_version": "1-12345",
  "display_id": "123456",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "payments",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get Bill Payment

get
https://unify.apideck.com/accounting/bill-payments/{id}

Get Bill Payment

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Bill Payment
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
NetSuite
QuickBooks
Sage Intacct
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.billPaymentsOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "payments",
  "operation": "one",
  "data": {
    "id": "12345",
    "downstream_id": "12345",
    "currency": "USD",
    "currency_rate": 0.69,
    "total_amount": 49.99,
    "reference": "123456",
    "payment_method": "cash",
    "payment_method_reference": "123456",
    "payment_method_id": "12345",
    "account": {
      "id": "123456",
      "name": "Bank account",
      "nominal_code": "N091",
      "code": "453"
    },
    "transaction_date": "2021-05-01T12:00:00.000Z",
    "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",
        "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"
      }
    },
    "company_id": "12345",
    "reconciled": true,
    "status": "authorised",
    "type": "accounts_payable",
    "allocations": [
      {
        "id": "12345",
        "type": "bill",
        "code": "N091",
        "amount": 49.99,
        "allocation_id": "123456"
      }
    ],
    "note": "Some notes about this transaction",
    "number": "123456",
    "tracking_categories": [
      {
        "id": "123456",
        "name": "New York"
      }
    ],
    "custom_fields": [
      {
        "id": "2389328923893298",
        "name": "employee_level",
        "description": "Employee Level",
        "value": "Uses Salesforce and Marketo"
      }
    ],
    "row_version": "1-12345",
    "display_id": "123456",
    "custom_mappings": {},
    "updated_by": "12345",
    "created_by": "12345",
    "created_at": "2020-09-30T07:43:32.000Z",
    "updated_at": "2020-09-30T07:43:32.000Z"
  }
}

Update Bill Payment

patch
https://unify.apideck.com/accounting/bill-payments/{id}

Update Bill Payment

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

currency_ratenumber or null

Currency Exchange Rate at the time entity was recorded/generated.

total_amountnumber or null
required

The total amount of the transaction

referencestring or null

Optional transaction reference message ie: Debit remittance detail.

payment_methodstring or null

Payment method used for the transaction, such as cash, credit card, bank transfer, or check

payment_method_referencestring or null

Optional reference message returned by payment method on processing

payment_method_idstring or null

A unique identifier for an object.

accountobject or null
transaction_datestring or null
required

The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD

supplierobject or null

The supplier this entity is linked to.

company_idstring or null

The company or subsidiary id the transaction belongs to

reconciledboolean or null

Indicates if the transaction has been reconciled.

statusstring
Enum:authorisedpaidvoideddeleted

Status of payment

typestring
Enum:accounts_payable_creditaccounts_payable_overpaymentaccounts_payable_prepaymentaccounts_payable

Type of payment

allocationsobjects
notestring or null

Note associated with the transaction

numberstring or null

Number associated with the transaction

tracking_categoriesobjects or null or null

A list of linked tracking categories.

custom_fieldsobjects
row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

display_idstring or null

Id to be displayed.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

200Bill Payment updated
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
NetSuite
QuickBooks
Sage Intacct
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request
Xero
Request

Request example

{
  "currency": "USD",
  "currency_rate": 0.69,
  "total_amount": 49.99,
  "reference": "123456",
  "payment_method": "cash",
  "payment_method_reference": "123456",
  "payment_method_id": "12345",
  "account": {
    "id": "123456",
    "nominal_code": "N091",
    "code": "453"
  },
  "transaction_date": "2021-05-01T12:00:00.000Z",
  "supplier": {
    "id": "12345",
    "display_name": "Windsurf Shop",
    "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",
      "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"
    }
  },
  "company_id": "12345",
  "reconciled": true,
  "status": "authorised",
  "type": "accounts_payable",
  "allocations": [
    {
      "id": "12345",
      "type": "bill",
      "amount": 49.99,
      "allocation_id": "123456"
    }
  ],
  "note": "Some notes about this transaction",
  "number": "123456",
  "tracking_categories": [
    {
      "id": "123456",
      "name": "New York"
    }
  ],
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "row_version": "1-12345",
  "display_id": "123456",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "payments",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete Bill Payment

delete
https://unify.apideck.com/accounting/bill-payments/{id}

Delete Bill Payment

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200Bill Payment deleted
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

FreshBooks
QuickBooks
Sage Intacct
Xero
Zoho Books
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.billPaymentsDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "payments",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Expenses

The Expenses model

idstring

A unique identifier for an object.

numberstring or null

Number.

transaction_datestring or null
required

The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD

account_idstring
required

The unique identifier for the ledger account that this expense should be credited to.

customer_idstring

The ID of the customer this entity is linked to. Used for expenses that should be marked as billable to customers.

supplier_idstring

The ID of the supplier this entity is linked to.

Expenses example
{}

List Expenses

get
https://unify.apideck.com/accounting/expenses

List Expenses

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

Responses

200Expenses
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

QuickBooks
Xero
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Zoho Books
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.expensesAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "Expenses",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "number": "OIT00546",
      "transaction_date": "2021-05-01T12:00:00.000Z",
      "account_id": "123456",
      "customer_id": "12345",
      "supplier_id": "12345",
      "company_id": "12345",
      "department_id": "12345",
      "payment_type": "cash",
      "currency": "USD",
      "currency_rate": 0.69,
      "type": "expense",
      "memo": "For travel expenses incurred on 2024-05-15",
      "tax_rate": {
        "id": "123456",
        "code": "N-T",
        "name": "GST on Purchases",
        "rate": 10
      },
      "total_amount": 275,
      "line_items": [
        {
          "id": "12345",
          "tracking_categories": [
            {
              "id": "123456",
              "name": "New York"
            }
          ],
          "account_id": "123456",
          "customer_id": "12345",
          "department_id": "12345",
          "location_id": "12345",
          "tax_rate": {
            "id": "123456",
            "code": "N-T",
            "name": "GST on Purchases",
            "rate": 10
          },
          "description": "Travel US.",
          "total_amount": 275,
          "billable": true
        }
      ],
      "custom_fields": [
        {
          "id": "2389328923893298",
          "name": "employee_level",
          "description": "Employee Level",
          "value": "Uses Salesforce and Marketo"
        }
      ],
      "custom_mappings": {},
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z",
      "row_version": "1-12345"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create Expense

post
https://unify.apideck.com/accounting/expenses

Create Expense

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
numberstring or null

Number.

transaction_datestring or null
required

The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD

account_idstring
required

The unique identifier for the ledger account that this expense should be credited to.

customer_idstring

The ID of the customer this entity is linked to. Used for expenses that should be marked as billable to customers.

supplier_idstring

The ID of the supplier this entity is linked to.

company_idstring or null

The company or subsidiary id the transaction belongs to

department_idstring

The ID of the department this expense is linked to.

payment_typestring or null
Enum:cashcheckcredit_card

The type of payment for the expense.

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

currency_ratenumber or null

Currency Exchange Rate at the time entity was recorded/generated.

typestring or null
Enum:expenserefund

The type of expense.

memostring or null

The memo of the expense.

tax_rateobject
total_amountnumber or null

The total amount of the expense line item.

line_itemsobjectsnon-empty
required

Expense line items linked to this expense.

custom_fieldsobjects
row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

201Expenses
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

QuickBooks
Xero
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Zoho Books
Request

Request example

{
  "number": "OIT00546",
  "transaction_date": "2021-05-01T12:00:00.000Z",
  "account_id": "123456",
  "customer_id": "12345",
  "supplier_id": "12345",
  "company_id": "12345",
  "department_id": "12345",
  "payment_type": "cash",
  "currency": "USD",
  "currency_rate": 0.69,
  "type": "expense",
  "memo": "For travel expenses incurred on 2024-05-15",
  "tax_rate": {
    "id": "123456",
    "rate": 10
  },
  "total_amount": 275,
  "line_items": [
    {
      "tracking_categories": [
        {
          "id": "123456",
          "name": "New York"
        }
      ],
      "account_id": "123456",
      "customer_id": "12345",
      "department_id": "12345",
      "location_id": "12345",
      "tax_rate": {
        "id": "123456",
        "rate": 10
      },
      "description": "Travel US.",
      "total_amount": 275,
      "billable": true
    }
  ],
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "Expenses",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get Expense

get
https://unify.apideck.com/accounting/expenses/{id}

Get Expense

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200Expenses
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

QuickBooks
Xero
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Zoho Books
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.expensesOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "Expenses",
  "operation": "one",
  "data": {
    "id": "12345",
    "number": "OIT00546",
    "transaction_date": "2021-05-01T12:00:00.000Z",
    "account_id": "123456",
    "customer_id": "12345",
    "supplier_id": "12345",
    "company_id": "12345",
    "department_id": "12345",
    "payment_type": "cash",
    "currency": "USD",
    "currency_rate": 0.69,
    "type": "expense",
    "memo": "For travel expenses incurred on 2024-05-15",
    "tax_rate": {
      "id": "123456",
      "code": "N-T",
      "name": "GST on Purchases",
      "rate": 10
    },
    "total_amount": 275,
    "line_items": [
      {
        "id": "12345",
        "tracking_categories": [
          {
            "id": "123456",
            "name": "New York"
          }
        ],
        "account_id": "123456",
        "customer_id": "12345",
        "department_id": "12345",
        "location_id": "12345",
        "tax_rate": {
          "id": "123456",
          "code": "N-T",
          "name": "GST on Purchases",
          "rate": 10
        },
        "description": "Travel US.",
        "total_amount": 275,
        "billable": true
      }
    ],
    "custom_fields": [
      {
        "id": "2389328923893298",
        "name": "employee_level",
        "description": "Employee Level",
        "value": "Uses Salesforce and Marketo"
      }
    ],
    "custom_mappings": {},
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z",
    "row_version": "1-12345"
  }
}

Update Expense

patch
https://unify.apideck.com/accounting/expenses/{id}

Update Expense

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
numberstring or null

Number.

transaction_datestring or null
required

The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD

account_idstring
required

The unique identifier for the ledger account that this expense should be credited to.

customer_idstring

The ID of the customer this entity is linked to. Used for expenses that should be marked as billable to customers.

supplier_idstring

The ID of the supplier this entity is linked to.

company_idstring or null

The company or subsidiary id the transaction belongs to

department_idstring

The ID of the department this expense is linked to.

payment_typestring or null
Enum:cashcheckcredit_card

The type of payment for the expense.

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

currency_ratenumber or null

Currency Exchange Rate at the time entity was recorded/generated.

typestring or null
Enum:expenserefund

The type of expense.

memostring or null

The memo of the expense.

tax_rateobject
total_amountnumber or null

The total amount of the expense line item.

line_itemsobjectsnon-empty
required

Expense line items linked to this expense.

custom_fieldsobjects
row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

200Expenses
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

QuickBooks
Xero
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Zoho Books
Request

Request example

{
  "number": "OIT00546",
  "transaction_date": "2021-05-01T12:00:00.000Z",
  "account_id": "123456",
  "customer_id": "12345",
  "supplier_id": "12345",
  "company_id": "12345",
  "department_id": "12345",
  "payment_type": "cash",
  "currency": "USD",
  "currency_rate": 0.69,
  "type": "expense",
  "memo": "For travel expenses incurred on 2024-05-15",
  "tax_rate": {
    "id": "123456",
    "rate": 10
  },
  "total_amount": 275,
  "line_items": [
    {
      "tracking_categories": [
        {
          "id": "123456",
          "name": "New York"
        }
      ],
      "account_id": "123456",
      "customer_id": "12345",
      "department_id": "12345",
      "location_id": "12345",
      "tax_rate": {
        "id": "123456",
        "rate": 10
      },
      "description": "Travel US.",
      "total_amount": 275,
      "billable": true
    }
  ],
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "row_version": "1-12345",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "Expenses",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete Expense

delete
https://unify.apideck.com/accounting/expenses/{id}

Delete Expense

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200Expenses
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

QuickBooks
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.expensesDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "Expenses",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Aged Creditors

The Aged Creditors model

report_generated_atstring

The exact date and time the report was generated.

report_as_of_datestring

The cutoff date for transactions included in the report.

period_countinteger
Default:4

Number of aging periods shown in the report.

period_lengthinteger
Default:30

Length of each aging period in days.

outstanding_balancesobjects
Aged Creditors example
{}

Get Aged Creditors
Upcoming

get
https://unify.apideck.com/accounting/aged-creditors

Get Aged Creditors

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

filterobjectfilter[customer_id]=123abc

Apply filters

pass_throughobjectpass_through[example_downstream_property]=example_downstream_property

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Aged Creditors
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.agedCreditorsOne({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "AgedCreditors",
  "operation": "one",
  "data": {
    "report_generated_at": "2024-11-14T12:00:00.000Z",
    "report_as_of_date": "2024-11-13",
    "period_count": 4,
    "period_length": 30,
    "outstanding_balances": [
      {
        "customer_id": "123",
        "customer_name": "Super Store",
        "outstanding_balances_by_currency": [
          {
            "currency": "USD",
            "balances_by_period": [
              {
                "start_date": "2024-01-01",
                "end_date": "2024-01-30",
                "total_amount": 1500,
                "balances_by_transaction": [
                  {}
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

Aged Debtors

The Aged Debtors model

report_generated_atstring

The exact date and time the report was generated.

report_as_of_datestring

The cutoff date for transactions included in the report.

period_countinteger
Default:4

Number of aging periods shown in the report.

period_lengthinteger
Default:30

Length of each aging period in days.

outstanding_balancesobjects
Aged Debtors example
{}

Get Aged Debtors
Upcoming

get
https://unify.apideck.com/accounting/aged-debtors

Get Aged Debtors

Authorizations:

Header parameters

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.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

filterobjectfilter[customer_id]=123abc

Apply filters

pass_throughobjectpass_through[example_downstream_property]=example_downstream_property

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Aged Debtors
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.accounting.agedDebtorsOne({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "AgedDebtors",
  "operation": "one",
  "data": {
    "report_generated_at": "2024-11-14T12:00:00.000Z",
    "report_as_of_date": "2024-11-13",
    "period_count": 4,
    "period_length": 30,
    "outstanding_balances": [
      {
        "customer_id": "123",
        "customer_name": "Super Store",
        "outstanding_balances_by_currency": [
          {
            "currency": "USD",
            "balances_by_period": [
              {
                "start_date": "2024-01-01",
                "end_date": "2024-01-30",
                "total_amount": 1500,
                "balances_by_transaction": [
                  {}
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

Webhook Events

Customer Created
Webhook

Event broadcast when a customer has been created.

Header parameters

x-apideck-event-typestring
required
Enum:*accounting.customer.createdaccounting.customer.updatedaccounting.customer.deleted

The type of event that was triggered

x-apideck-idempotency-keystring
required

An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.

Request body schema

application/json
payloadobject

Responses

200Return a 200 status to indicate that the data was received successfully.

Mapping coverage per connector

QuickBooks
native event
Sage Intacct
virtual event
Zoho Books
virtual event
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request
Xero
Request

Example Event

Payload
{
  "payload": {
    "event_type": "accounting.customer.created",
    "unified_api": "accounting",
    "service_id": "xero",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/accounting/customers/123456ASDF",
    "entity_type": "customer",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Customer Updated
Webhook

Event broadcast when a customer has been updated.

Header parameters

x-apideck-event-typestring
required
Enum:*accounting.customer.createdaccounting.customer.updatedaccounting.customer.deleted

The type of event that was triggered

x-apideck-idempotency-keystring
required

An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.

Request body schema

application/json
payloadobject

Responses

200Return a 200 status to indicate that the data was received successfully.

Mapping coverage per connector

QuickBooks
native event
Sage Intacct
virtual event
Zoho Books
virtual event
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request
Xero
Request

Example Event

Payload
{
  "payload": {
    "event_type": "accounting.customer.updated",
    "unified_api": "accounting",
    "service_id": "xero",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/accounting/customers/123456ASDF",
    "entity_type": "customer",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Customer Deleted
Webhook

Event broadcast when a customer has been deleted.

Header parameters

x-apideck-event-typestring
required
Enum:*accounting.customer.createdaccounting.customer.updatedaccounting.customer.deleted

The type of event that was triggered

x-apideck-idempotency-keystring
required

An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.

Request body schema

application/json
payloadobject

Responses

200Return a 200 status to indicate that the data was received successfully.

Mapping coverage per connector

QuickBooks
native event
Sage Intacct
virtual event
Zoho Books
virtual event
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request
Xero
Request

Example Event

Payload
{
  "payload": {
    "event_type": "accounting.customer.deleted",
    "unified_api": "accounting",
    "service_id": "xero",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/accounting/customers/123456ASDF",
    "entity_type": "customer",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Invoice Created
Webhook

Event broadcast when an invoice has been created.

Header parameters

x-apideck-event-typestring
required
Enum:*accounting.customer.createdaccounting.customer.updatedaccounting.customer.deleted

The type of event that was triggered

x-apideck-idempotency-keystring
required

An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.

Request body schema

application/json
payloadobject

Responses

200Return a 200 status to indicate that the data was received successfully.

Mapping coverage per connector

QuickBooks
native event
Sage Intacct
virtual event
Xero
native event
Zoho Books
virtual event
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request

Example Event

Payload
{
  "payload": {
    "event_type": "accounting.invoice.created",
    "unified_api": "accounting",
    "service_id": "xero",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/accounting/invoices/123456ASDF",
    "entity_type": "invoice",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Invoice Updated
Webhook

Event broadcast when an invoice has been updated.

Header parameters

x-apideck-event-typestring
required
Enum:*accounting.customer.createdaccounting.customer.updatedaccounting.customer.deleted

The type of event that was triggered

x-apideck-idempotency-keystring
required

An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.

Request body schema

application/json
payloadobject

Responses

200Return a 200 status to indicate that the data was received successfully.

Mapping coverage per connector

QuickBooks
native event
Sage Intacct
virtual event
Xero
native event
Zoho Books
virtual event
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request

Example Event

Payload
{
  "payload": {
    "event_type": "accounting.invoice.updated",
    "unified_api": "accounting",
    "service_id": "xero",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/accounting/invoices/123456ASDF",
    "entity_type": "invoice",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Invoice Deleted
Webhook

Event broadcast when an invoice has been deleted.

Header parameters

x-apideck-event-typestring
required
Enum:*accounting.customer.createdaccounting.customer.updatedaccounting.customer.deleted

The type of event that was triggered

x-apideck-idempotency-keystring
required

An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.

Request body schema

application/json
payloadobject

Responses

200Return a 200 status to indicate that the data was received successfully.

Mapping coverage per connector

QuickBooks
native event
Sage Intacct
virtual event
Zoho Books
virtual event
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Visma Netvisor
Request
Xero
Request

Example Event

Payload
{
  "payload": {
    "event_type": "accounting.invoice.deleted",
    "unified_api": "accounting",
    "service_id": "xero",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/accounting/invoices/123456ASDF",
    "entity_type": "invoice",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Invoice Item Created
Webhook

Event broadcast when an invoice has been item created.

Header parameters

x-apideck-event-typestring
required
Enum:*accounting.customer.createdaccounting.customer.updatedaccounting.customer.deleted

The type of event that was triggered

x-apideck-idempotency-keystring
required

An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.

Request body schema

application/json
payloadobject

Responses

200Return a 200 status to indicate that the data was received successfully.
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Example Event

Payload
{
  "payload": {
    "event_type": "accounting.invoice_item.created",
    "unified_api": "accounting",
    "service_id": "xero",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/accounting/invoice_items/123456ASDF",
    "entity_type": "invoice_item",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Invoice Item Updated
Webhook

Event broadcast when an invoice has been item updated.

Header parameters

x-apideck-event-typestring
required
Enum:*accounting.customer.createdaccounting.customer.updatedaccounting.customer.deleted

The type of event that was triggered

x-apideck-idempotency-keystring
required

An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.

Request body schema

application/json
payloadobject

Responses

200Return a 200 status to indicate that the data was received successfully.
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Example Event

Payload
{
  "payload": {
    "event_type": "accounting.invoice_item.updated",
    "unified_api": "accounting",
    "service_id": "xero",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/accounting/invoice_items/123456ASDF",
    "entity_type": "invoice_item",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Invoice Item Deleted
Webhook

Event broadcast when an invoice has been item deleted.

Header parameters

x-apideck-event-typestring
required
Enum:*accounting.customer.createdaccounting.customer.updatedaccounting.customer.deleted

The type of event that was triggered

x-apideck-idempotency-keystring
required

An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.

Request body schema

application/json
payloadobject

Responses

200Return a 200 status to indicate that the data was received successfully.
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Example Event

Payload
{
  "payload": {
    "event_type": "accounting.invoice_item.deleted",
    "unified_api": "accounting",
    "service_id": "xero",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/accounting/invoice_items/123456ASDF",
    "entity_type": "invoice_item",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Ledger Account Created
Webhook

Event broadcast when a ledger has been account created.

Header parameters

x-apideck-event-typestring
required
Enum:*accounting.customer.createdaccounting.customer.updatedaccounting.customer.deleted

The type of event that was triggered

x-apideck-idempotency-keystring
required

An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.

Request body schema

application/json
payloadobject

Responses

200Return a 200 status to indicate that the data was received successfully.
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Example Event

Payload
{
  "payload": {
    "event_type": "accounting.ledger_account.created",
    "unified_api": "accounting",
    "service_id": "xero",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/accounting/ledger_accounts/123456ASDF",
    "entity_type": "ledger_account",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Ledger Account Updated
Webhook

Event broadcast when a ledger has been account updated.

Header parameters

x-apideck-event-typestring
required
Enum:*accounting.customer.createdaccounting.customer.updatedaccounting.customer.deleted

The type of event that was triggered

x-apideck-idempotency-keystring
required

An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.

Request body schema

application/json
payloadobject

Responses

200Return a 200 status to indicate that the data was received successfully.
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Example Event

Payload
{
  "payload": {
    "event_type": "accounting.ledger_account.updated",
    "unified_api": "accounting",
    "service_id": "xero",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/accounting/ledger_accounts/123456ASDF",
    "entity_type": "ledger_account",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Ledger Account Deleted
Webhook

Event broadcast when a ledger has been account deleted.

Header parameters

x-apideck-event-typestring
required
Enum:*accounting.customer.createdaccounting.customer.updatedaccounting.customer.deleted

The type of event that was triggered

x-apideck-idempotency-keystring
required

An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.

Request body schema

application/json
payloadobject

Responses

200Return a 200 status to indicate that the data was received successfully.
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Example Event

Payload
{
  "payload": {
    "event_type": "accounting.ledger_account.deleted",
    "unified_api": "accounting",
    "service_id": "xero",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/accounting/ledger_accounts/123456ASDF",
    "entity_type": "ledger_account",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Tax Rate Created
Webhook

Event broadcast when a tax has been rate created.

Header parameters

x-apideck-event-typestring
required
Enum:*accounting.customer.createdaccounting.customer.updatedaccounting.customer.deleted

The type of event that was triggered

x-apideck-idempotency-keystring
required

An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.

Request body schema

application/json
payloadobject

Responses

200Return a 200 status to indicate that the data was received successfully.
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Example Event

Payload
{
  "payload": {
    "event_type": "accounting.tax_rate.created",
    "unified_api": "accounting",
    "service_id": "xero",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/accounting/tax_rates/123456ASDF",
    "entity_type": "tax_rate",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Tax Rate Updated
Webhook

Event broadcast when a tax has been rate updated.

Header parameters

x-apideck-event-typestring
required
Enum:*accounting.customer.createdaccounting.customer.updatedaccounting.customer.deleted

The type of event that was triggered

x-apideck-idempotency-keystring
required

An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.

Request body schema

application/json
payloadobject

Responses

200Return a 200 status to indicate that the data was received successfully.
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Example Event

Payload
{
  "payload": {
    "event_type": "accounting.tax_rate.updated",
    "unified_api": "accounting",
    "service_id": "xero",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/accounting/tax_rates/123456ASDF",
    "entity_type": "tax_rate",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Tax Rate Deleted
Webhook

Event broadcast when a tax has been rate deleted.

Header parameters

x-apideck-event-typestring
required
Enum:*accounting.customer.createdaccounting.customer.updatedaccounting.customer.deleted

The type of event that was triggered

x-apideck-idempotency-keystring
required

An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.

Request body schema

application/json
payloadobject

Responses

200Return a 200 status to indicate that the data was received successfully.
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Example Event

Payload
{
  "payload": {
    "event_type": "accounting.tax_rate.deleted",
    "unified_api": "accounting",
    "service_id": "xero",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/accounting/tax_rates/123456ASDF",
    "entity_type": "tax_rate",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Purchase Order Created
Webhook

Event broadcast when a purchase has been order created.

Header parameters

x-apideck-event-typestring
required
Enum:*accounting.customer.createdaccounting.customer.updatedaccounting.customer.deleted

The type of event that was triggered

x-apideck-idempotency-keystring
required

An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.

Request body schema

application/json
payloadobject

Responses

200Return a 200 status to indicate that the data was received successfully.
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Example Event

Payload
{
  "payload": {
    "event_type": "accounting.purchase_order.created",
    "unified_api": "accounting",
    "service_id": "xero",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/accounting/purchase_orders/123456ASDF",
    "entity_type": "purchase_order",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Purchase order Deleted
Webhook

Event broadcast when a purchase order has been deleted.

Header parameters

x-apideck-event-typestring
required
Enum:*accounting.customer.createdaccounting.customer.updatedaccounting.customer.deleted

The type of event that was triggered

x-apideck-idempotency-keystring
required

An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.

Request body schema

application/json
payloadobject

Responses

200Return a 200 status to indicate that the data was received successfully.
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Example Event

Payload
{
  "payload": {
    "event_type": "accounting.purchase-order.deleted",
    "unified_api": "accounting",
    "service_id": "xero",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/accounting/purchase-orders/123456ASDF",
    "entity_type": "purchase-order",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Purchase order Updated
Webhook

Event broadcast when a purchase order has been updated.

Header parameters

x-apideck-event-typestring
required
Enum:*accounting.customer.createdaccounting.customer.updatedaccounting.customer.deleted

The type of event that was triggered

x-apideck-idempotency-keystring
required

An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.

Request body schema

application/json
payloadobject

Responses

200Return a 200 status to indicate that the data was received successfully.
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
QuickBooks
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Example Event

Payload
{
  "payload": {
    "event_type": "accounting.purchase-order.updated",
    "unified_api": "accounting",
    "service_id": "xero",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/accounting/purchase-orders/123456ASDF",
    "entity_type": "purchase-order",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Expense Updated
Webhook

Event broadcast when an expense has been updated.

Header parameters

x-apideck-idempotency-keystring
required

An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.

Request body schema

application/json
event_idstring

Unique reference to this request event

unified_apistring
Enum:accountingatscalendarcrm

Name of Apideck Unified API

service_idstring

Service provider identifier

consumer_idstring

Unique consumer identifier. You can freely choose a consumer ID yourself. Most of the time, this is an ID of your internal data model that represents a user or account in your system (for example account:12345). If the consumer doesn't exist yet, Vault will upsert a consumer based on your ID.

entity_idstring

The service provider's ID of the entity that triggered this event

entity_typestring

The type entity that triggered this event

entity_urlstring

The url to retrieve entity detail.

execution_attemptnumber

The current count this request event has been attempted

occurred_atstring

ISO Datetime for when the original event occurred

event_typestring
Enum:*accounting.customer.createdaccounting.customer.updatedaccounting.customer.deleted

Responses

200Return a 200 status to indicate that the data was received successfully

Mapping coverage per connector

QuickBooks
native event
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Example Event

Payload
{
  "payload": {
    "event_type": "accounting.expense.updated",
    "unified_api": "accounting",
    "service_id": "xero",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/accounting/expenses/123456ASDF",
    "entity_type": "expense",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Expense Deleted
Webhook

Event broadcast when an expense has been deleted.

Header parameters

x-apideck-idempotency-keystring
required

An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.

Request body schema

application/json
event_idstring

Unique reference to this request event

unified_apistring
Enum:accountingatscalendarcrm

Name of Apideck Unified API

service_idstring

Service provider identifier

consumer_idstring

Unique consumer identifier. You can freely choose a consumer ID yourself. Most of the time, this is an ID of your internal data model that represents a user or account in your system (for example account:12345). If the consumer doesn't exist yet, Vault will upsert a consumer based on your ID.

entity_idstring

The service provider's ID of the entity that triggered this event

entity_typestring

The type entity that triggered this event

entity_urlstring

The url to retrieve entity detail.

execution_attemptnumber

The current count this request event has been attempted

occurred_atstring

ISO Datetime for when the original event occurred

event_typestring
Enum:*accounting.customer.createdaccounting.customer.updatedaccounting.customer.deleted

Responses

200Return a 200 status to indicate that the data was received successfully

Mapping coverage per connector

QuickBooks
native event
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Example Event

Payload
{
  "payload": {
    "event_type": "accounting.expense.deleted",
    "unified_api": "accounting",
    "service_id": "xero",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/accounting/expenses/123456ASDF",
    "entity_type": "expense",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Expense Created
Webhook

Event broadcast when an expense has been created.

Header parameters

x-apideck-idempotency-keystring
required

An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.

Request body schema

application/json
event_idstring

Unique reference to this request event

unified_apistring
Enum:accountingatscalendarcrm

Name of Apideck Unified API

service_idstring

Service provider identifier

consumer_idstring

Unique consumer identifier. You can freely choose a consumer ID yourself. Most of the time, this is an ID of your internal data model that represents a user or account in your system (for example account:12345). If the consumer doesn't exist yet, Vault will upsert a consumer based on your ID.

entity_idstring

The service provider's ID of the entity that triggered this event

entity_typestring

The type entity that triggered this event

entity_urlstring

The url to retrieve entity detail.

execution_attemptnumber

The current count this request event has been attempted

occurred_atstring

ISO Datetime for when the original event occurred

event_typestring
Enum:*accounting.customer.createdaccounting.customer.updatedaccounting.customer.deleted

Responses

200Return a 200 status to indicate that the data was received successfully

Mapping coverage per connector

QuickBooks
native event
banqUP
Request
Clear Books
Request
Exact Online
Request
Exact Online NL
Request
Exact Online UK
Request
FreeAgent
Request
FreshBooks
Request
Kashflow
Request
Microsoft Dynamics 365 Business Central
Request
MRI Software
Request
MYOB
Request
NetSuite
Request
Procountor
Request
Sage Business Cloud Accounting
Request
Sage Intacct
Request
Visma Netvisor
Request
Xero
Request
Zoho Books
Request

Example Event

Payload
{
  "payload": {
    "event_type": "accounting.expense.created",
    "unified_api": "accounting",
    "service_id": "xero",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/accounting/expenses/123456ASDF",
    "entity_type": "expense",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}