We launched the Accounting Sample!Manage invoices, payments, expenses, and more across multiple connectors.

Search docs

Accounting API Reference

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

8.85.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

We also provide a Mock API that can be used for testing purposes: https://mock-api.apideck.com

GraphQL

Use the GraphQL playground to test out the GraphQL API.

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 use API you have to sign up and get your own API key. Unify API accounts have sandbox mode and live mode API keys. To change modes just use the appropriate key to get a live or test object. You can find your API keys on the unify settings of your Apideck app. Your Apideck application_id can also be found 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-apideck-api-key>
  • Application id header: x-apideck-app-id: <your-apideck-app-id>

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 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 no be able to make further requests until this limit resets at the end of the month, or talk to us about upgrading your subscription to continue immediately.

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.

Idempotence (upcoming)

To prevent the creation of duplicate resources, every POST method (such as one that creates a consumer record) must specify a unique value for the X-Unique-Transaction-ID header name. Uniquely identifying each unique POST request ensures that the API processes a given request once and only once.

Uniquely identifying new resource-creation POSTs is especially important when the outcome of a response is ambiguous because of a transient service interruption, such as a server-side timeout or network disruption. If a service interruption occurs, then the client application can safely retry the uniquely identified request without creating duplicate operations. (API endpoints that guarantee that every uniquely identified request is processed only once no matter how many times that uniquely identifiable request is made are described as idempotent.)

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.

Bills

The Bills model

idstring
downstream_idstring or null

The third-party API ID of original entity

supplierobject or null

The supplier this entity is linked 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

Bills example
{}

List Bills

get/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

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 records to return

Responses

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

Mapping coverage per connector

QuickBooks
Sage Intacct
Xero
Exact Online
Request
MYOB
Request
NetSuite
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",
      "supplier": {
        "id": "12345",
        "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",
          "row_version": "1-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,
          "location_id": "1234",
          "department_id": "1234",
          "item": {
            "id": "12344",
            "code": "120-C",
            "name": "Model Y"
          },
          "ledger_account": {
            "id": "123456",
            "name": "Bank account",
            "nominal_code": "N091",
            "code": "453"
          },
          "tax_rate": {
            "id": "123456",
            "code": "N-T",
            "name": "GST on Purchases"
          },
          "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"
      },
      "bill_number": "10001",
      "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 Bill

post/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

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
supplierobject or null

The supplier this entity is linked 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 by the supplier - 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 invoice 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
bill_numberstring or null
row_versionstring or null

Responses

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

Mapping coverage per connector

QuickBooks
Sage Intacct
Xero
Exact Online
Request
MYOB
Request
NetSuite
Request

Request example

{
  "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",
      "row_version": "1-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,
      "location_id": "1234",
      "department_id": "1234",
      "item": {
        "id": "12344"
      },
      "ledger_account": {
        "id": "123456",
        "nominal_code": "N091",
        "code": "453"
      },
      "tax_rate": {
        "id": "123456"
      },
      "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"
  },
  "bill_number": "10001",
  "row_version": "1-12345"
}

Response example

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

Get Bill

get/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

Include raw response. Mostly used for debugging purposes

Responses

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

Mapping coverage per connector

QuickBooks
Sage Intacct
Xero
Exact Online
Request
MYOB
Request
NetSuite
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",
    "supplier": {
      "id": "12345",
      "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",
        "row_version": "1-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,
        "location_id": "1234",
        "department_id": "1234",
        "item": {
          "id": "12344",
          "code": "120-C",
          "name": "Model Y"
        },
        "ledger_account": {
          "id": "123456",
          "name": "Bank account",
          "nominal_code": "N091",
          "code": "453"
        },
        "tax_rate": {
          "id": "123456",
          "code": "N-T",
          "name": "GST on Purchases"
        },
        "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"
    },
    "bill_number": "10001",
    "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 Bill

patch/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

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
supplierobject or null

The supplier this entity is linked 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 by the supplier - 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 invoice 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
bill_numberstring or null
row_versionstring or null

Responses

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

Mapping coverage per connector

QuickBooks
Sage Intacct
Xero
Exact Online
Request
MYOB
Request
NetSuite
Request

Request example

{
  "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",
      "row_version": "1-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,
      "location_id": "1234",
      "department_id": "1234",
      "item": {
        "id": "12344"
      },
      "ledger_account": {
        "id": "123456",
        "nominal_code": "N091",
        "code": "453"
      },
      "tax_rate": {
        "id": "123456"
      },
      "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"
  },
  "bill_number": "10001",
  "row_version": "1-12345"
}

Response example

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

Delete Bill

delete/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

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

QuickBooks
Sage Intacct
Xero
Exact Online
Request
MYOB
Request
NetSuite
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
company_namestring or null
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/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

Include raw response. Mostly used for debugging purposes

Responses

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

Mapping coverage per connector

MYOB
QuickBooks
Xero
Exact Online
Request
NetSuite
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.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": "123456",
      "code": "N-T",
      "name": "GST on Purchases"
    },
    "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",
        "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"
      }
    ],
    "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

Unique identifier representing the entity

numberstring or null

Credit note number.

customerobject or null

The customer this entity is linked 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

Credit Notes example
{}

List Credit Notes

get/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

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 records to return

Responses

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

Mapping coverage per connector

QuickBooks
Sage Intacct
Xero
Exact Online
Request
MYOB
Request
NetSuite
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"
      },
      "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,
          "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"
          },
          "ledger_account": {
            "id": "123456",
            "name": "Bank account",
            "nominal_code": "N091",
            "code": "453"
          },
          "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
        }
      ],
      "note": "Some notes about this credit note",
      "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/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

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.

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 payment

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.

row_versionstring or null

Responses

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

Mapping coverage per connector

QuickBooks
Sage Intacct
Xero
Exact Online
Request
MYOB
Request
NetSuite
Request

Request example

{
  "number": "OIT00546",
  "customer": {
    "id": "12345",
    "display_name": "Windsurf Shop",
    "name": "Windsurf Shop"
  },
  "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": [
    {
      "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,
      "location_id": "1234",
      "department_id": "1234",
      "item": {
        "id": "12344"
      },
      "tax_rate": {
        "id": "123456"
      },
      "ledger_account": {
        "id": "123456",
        "nominal_code": "N091",
        "code": "453"
      },
      "row_version": "1-12345"
    }
  ],
  "allocations": [
    {
      "id": "123456",
      "type": "invoice",
      "amount": 49.99
    }
  ],
  "note": "Some notes about this credit note",
  "row_version": "1-12345"
}

Response example

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

Get Credit Note

get/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

Include raw response. Mostly used for debugging purposes

Responses

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

Mapping coverage per connector

QuickBooks
Sage Intacct
Xero
Exact Online
Request
MYOB
Request
NetSuite
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"
    },
    "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,
        "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"
        },
        "ledger_account": {
          "id": "123456",
          "name": "Bank account",
          "nominal_code": "N091",
          "code": "453"
        },
        "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
      }
    ],
    "note": "Some notes about this credit note",
    "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/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

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.

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 payment

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.

row_versionstring or null

Responses

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

Mapping coverage per connector

QuickBooks
Sage Intacct
Xero
Exact Online
Request
MYOB
Request
NetSuite
Request

Request example

{
  "number": "OIT00546",
  "customer": {
    "id": "12345",
    "display_name": "Windsurf Shop",
    "name": "Windsurf Shop"
  },
  "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": [
    {
      "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,
      "location_id": "1234",
      "department_id": "1234",
      "item": {
        "id": "12344"
      },
      "tax_rate": {
        "id": "123456"
      },
      "ledger_account": {
        "id": "123456",
        "nominal_code": "N091",
        "code": "453"
      },
      "row_version": "1-12345"
    }
  ],
  "allocations": [
    {
      "id": "123456",
      "type": "invoice",
      "amount": 49.99
    }
  ],
  "note": "Some notes about this credit note",
  "row_version": "1-12345"
}

Response example

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

Delete Credit Note

delete/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

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

QuickBooks
Sage Intacct
Xero
Exact Online
Request
MYOB
Request
NetSuite
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
display_idstring or null

Display ID

display_namestring or null

Display Name

company_namestring or null
titlestring or null
first_namestring or null
Customers example
{}

List Customers

get/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

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 records to return

filterobjectfilter[company_name]=SpaceX

Apply filters

Responses

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

Mapping coverage per connector

MYOB
QuickBooks
Sage Intacct
Xero
Exact Online
Request
NetSuite
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",
      "display_id": "EMP00101",
      "display_name": "Windsurf Shop",
      "company_name": "SpaceX",
      "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",
          "row_version": "1-12345"
        }
      ],
      "notes": "Some notes about this customer",
      "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"
        }
      ],
      "tax_rate": {
        "id": "123456",
        "code": "N-T",
        "name": "GST on Purchases"
      },
      "tax_number": "US123945459",
      "currency": "USD",
      "bank_accounts": [
        {
          "iban": "CH2989144532982975332",
          "bic": "AUDSCHGGXXX",
          "bsb_number": "062-001",
          "branch_identifier": "001",
          "bank_code": "BNH",
          "account_number": "123465",
          "account_name": "SPACEX LLC",
          "account_type": "credit_card",
          "currency": "USD"
        }
      ],
      "status": "active",
      "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 Customer

post/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

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
titlestring or null
first_namestring or null
middle_namestring or null
last_namestring or null
suffixstring or null
individualboolean or null

Is this an individual or business customer

addressesobjects
notesstring or null

Some notes about this customer

phone_numbersobjects
emailsobjects
websitesobjects
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.

bank_accountsobjects
statusstring or null
Enum:activeinactivearchivedgdpr-erasure-request

Customer status

row_versionstring or null

Responses

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

Mapping coverage per connector

MYOB
QuickBooks
Sage Intacct
Xero
Exact Online
Request
NetSuite
Request

Request example

{
  "display_id": "EMP00101",
  "display_name": "Windsurf Shop",
  "company_name": "SpaceX",
  "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",
      "row_version": "1-12345"
    }
  ],
  "notes": "Some notes about this customer",
  "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"
    }
  ],
  "tax_rate": {
    "id": "123456"
  },
  "tax_number": "US123945459",
  "currency": "USD",
  "bank_accounts": [
    {
      "iban": "CH2989144532982975332",
      "bic": "AUDSCHGGXXX",
      "bsb_number": "062-001",
      "branch_identifier": "001",
      "bank_code": "BNH",
      "account_number": "123465",
      "account_name": "SPACEX LLC",
      "account_type": "credit_card",
      "currency": "USD"
    }
  ],
  "status": "active",
  "row_version": "1-12345"
}

Response example

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

Get Customer

get/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

Include raw response. Mostly used for debugging purposes

Responses

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

Mapping coverage per connector

MYOB
QuickBooks
Sage Intacct
Xero
Exact Online
Request
NetSuite
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",
    "display_id": "EMP00101",
    "display_name": "Windsurf Shop",
    "company_name": "SpaceX",
    "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",
        "row_version": "1-12345"
      }
    ],
    "notes": "Some notes about this customer",
    "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"
      }
    ],
    "tax_rate": {
      "id": "123456",
      "code": "N-T",
      "name": "GST on Purchases"
    },
    "tax_number": "US123945459",
    "currency": "USD",
    "bank_accounts": [
      {
        "iban": "CH2989144532982975332",
        "bic": "AUDSCHGGXXX",
        "bsb_number": "062-001",
        "branch_identifier": "001",
        "bank_code": "BNH",
        "account_number": "123465",
        "account_name": "SPACEX LLC",
        "account_type": "credit_card",
        "currency": "USD"
      }
    ],
    "status": "active",
    "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 Customer

patch/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

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
titlestring or null
first_namestring or null
middle_namestring or null
last_namestring or null
suffixstring or null
individualboolean or null

Is this an individual or business customer

addressesobjects
notesstring or null

Some notes about this customer

phone_numbersobjects
emailsobjects
websitesobjects
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.

bank_accountsobjects
statusstring or null
Enum:activeinactivearchivedgdpr-erasure-request

Customer status

row_versionstring or null

Responses

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

Mapping coverage per connector

MYOB
QuickBooks
Sage Intacct
Xero
Exact Online
Request
NetSuite
Request

Request example

{
  "display_id": "EMP00101",
  "display_name": "Windsurf Shop",
  "company_name": "SpaceX",
  "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",
      "row_version": "1-12345"
    }
  ],
  "notes": "Some notes about this customer",
  "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"
    }
  ],
  "tax_rate": {
    "id": "123456"
  },
  "tax_number": "US123945459",
  "currency": "USD",
  "bank_accounts": [
    {
      "iban": "CH2989144532982975332",
      "bic": "AUDSCHGGXXX",
      "bsb_number": "062-001",
      "branch_identifier": "001",
      "bank_code": "BNH",
      "account_number": "123465",
      "account_name": "SPACEX LLC",
      "account_type": "credit_card",
      "currency": "USD"
    }
  ],
  "status": "active",
  "row_version": "1-12345"
}

Response example

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

Delete Customer

delete/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

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

MYOB
Sage Intacct
Xero
Exact Online
Request
NetSuite
Request
QuickBooks
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
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.

invoice_datestring or null

Date invoice was issued - YYYY-MM-DD.

Invoices example
{}

List Invoices

get/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

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 records to return

sortobjectsort[by]=updated_at

Apply sorting

Responses

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

Mapping coverage per connector

MYOB
QuickBooks
Sage Intacct
Xero
Exact Online
Request
NetSuite
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"
      },
      "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,
      "total": 27500,
      "balance": 27500,
      "deposit": 0,
      "customer_memo": "Thank you for your business and have a great day!",
      "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,
          "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"
          },
          "ledger_account": {
            "id": "123456",
            "name": "Bank account",
            "nominal_code": "N091",
            "code": "453"
          },
          "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",
        "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",
        "row_version": "1-12345"
      },
      "template_id": "123456",
      "source_document_url": "https://www.invoicesolution.com/invoice/123456",
      "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/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

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.

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.

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

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.

row_versionstring or null

Responses

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

Mapping coverage per connector

MYOB
QuickBooks
Sage Intacct
Xero
Exact Online
Request
NetSuite
Request

Request example

{
  "type": "service",
  "number": "OIT00546",
  "customer": {
    "id": "12345",
    "display_name": "Windsurf Shop",
    "name": "Windsurf Shop"
  },
  "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,
  "total": 27500,
  "balance": 27500,
  "deposit": 0,
  "customer_memo": "Thank you for your business and have a great day!",
  "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": "sales_item",
      "tax_amount": 27500,
      "total_amount": 27500,
      "quantity": 1,
      "unit_price": 27500.5,
      "unit_of_measure": "pc.",
      "discount_percentage": 0.01,
      "location_id": "1234",
      "department_id": "1234",
      "item": {
        "id": "12344"
      },
      "tax_rate": {
        "id": "123456"
      },
      "ledger_account": {
        "id": "123456",
        "nominal_code": "N091",
        "code": "453"
      },
      "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",
    "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",
    "row_version": "1-12345"
  },
  "template_id": "123456",
  "source_document_url": "https://www.invoicesolution.com/invoice/123456",
  "row_version": "1-12345"
}

Response example

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

Get Invoice

get/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

Include raw response. Mostly used for debugging purposes

Responses

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

Mapping coverage per connector

MYOB
QuickBooks
Sage Intacct
Xero
Exact Online
Request
NetSuite
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"
    },
    "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,
    "total": 27500,
    "balance": 27500,
    "deposit": 0,
    "customer_memo": "Thank you for your business and have a great day!",
    "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,
        "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"
        },
        "ledger_account": {
          "id": "123456",
          "name": "Bank account",
          "nominal_code": "N091",
          "code": "453"
        },
        "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",
      "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",
      "row_version": "1-12345"
    },
    "template_id": "123456",
    "source_document_url": "https://www.invoicesolution.com/invoice/123456",
    "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/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

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.

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.

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

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.

row_versionstring or null

Responses

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

Mapping coverage per connector

MYOB
QuickBooks
Xero
Exact Online
Request
NetSuite
Request
Sage Intacct
Request

Request example

{
  "type": "service",
  "number": "OIT00546",
  "customer": {
    "id": "12345",
    "display_name": "Windsurf Shop",
    "name": "Windsurf Shop"
  },
  "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,
  "total": 27500,
  "balance": 27500,
  "deposit": 0,
  "customer_memo": "Thank you for your business and have a great day!",
  "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": "sales_item",
      "tax_amount": 27500,
      "total_amount": 27500,
      "quantity": 1,
      "unit_price": 27500.5,
      "unit_of_measure": "pc.",
      "discount_percentage": 0.01,
      "location_id": "1234",
      "department_id": "1234",
      "item": {
        "id": "12344"
      },
      "tax_rate": {
        "id": "123456"
      },
      "ledger_account": {
        "id": "123456",
        "nominal_code": "N091",
        "code": "453"
      },
      "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",
    "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",
    "row_version": "1-12345"
  },
  "template_id": "123456",
  "source_document_url": "https://www.invoicesolution.com/invoice/123456",
  "row_version": "1-12345"
}

Response example

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

Delete Invoice

delete/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

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

MYOB
QuickBooks
Sage Intacct
Xero
Exact Online
Request
NetSuite
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/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

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 records to return

filterobjectfilter[name]=Widgets Large

Apply filters

Responses

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

Mapping coverage per connector

MYOB
QuickBooks
Sage Intacct
Xero
Exact Online
Request
NetSuite
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,
      "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"
        }
      },
      "purchase_details": {
        "unit_price": 27500.5,
        "unit_of_measure": "pc.",
        "tax_inclusive": true,
        "tax_rate": {
          "id": "123456",
          "code": "N-T",
          "name": "GST on Purchases"
        }
      },
      "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"
      },
      "active": true,
      "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/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

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

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
activeboolean or null
row_versionstring or null

Responses

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

Mapping coverage per connector

MYOB
QuickBooks
Sage Intacct
Xero
Exact Online
Request
NetSuite
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,
  "inventory_date": "2020-10-30",
  "type": "inventory",
  "sales_details": {
    "unit_price": 27500.5,
    "unit_of_measure": "pc.",
    "tax_inclusive": true,
    "tax_rate": {
      "id": "123456"
    }
  },
  "purchase_details": {
    "unit_price": 27500.5,
    "unit_of_measure": "pc.",
    "tax_inclusive": true,
    "tax_rate": {
      "id": "123456"
    }
  },
  "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"
  },
  "active": true,
  "row_version": "1-12345"
}

Response example

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

Get Invoice Item

get/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

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

MYOB
QuickBooks
Sage Intacct
Xero
Exact Online
Request
NetSuite
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,
    "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"
      }
    },
    "purchase_details": {
      "unit_price": 27500.5,
      "unit_of_measure": "pc.",
      "tax_inclusive": true,
      "tax_rate": {
        "id": "123456",
        "code": "N-T",
        "name": "GST on Purchases"
      }
    },
    "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"
    },
    "active": true,
    "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/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

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

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
activeboolean or null
row_versionstring or null

Responses

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

Mapping coverage per connector

MYOB
QuickBooks
Sage Intacct
Xero
Exact Online
Request
NetSuite
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,
  "inventory_date": "2020-10-30",
  "type": "inventory",
  "sales_details": {
    "unit_price": 27500.5,
    "unit_of_measure": "pc.",
    "tax_inclusive": true,
    "tax_rate": {
      "id": "123456"
    }
  },
  "purchase_details": {
    "unit_price": 27500.5,
    "unit_of_measure": "pc.",
    "tax_inclusive": true,
    "tax_rate": {
      "id": "123456"
    }
  },
  "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"
  },
  "active": true,
  "row_version": "1-12345"
}

Response example

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

Delete Invoice Item

delete/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

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

MYOB
Sage Intacct
Xero
Exact Online
Request
NetSuite
Request
QuickBooks
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
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/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

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 records to return

Responses

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

Mapping coverage per connector

MYOB
QuickBooks
Sage Intacct
Xero
Exact Online
Request
NetSuite
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"
      },
      "level": 1,
      "active": true,
      "status": "active",
      "header": true,
      "bank_account": {
        "iban": "CH2989144532982975332",
        "bic": "AUDSCHGGXXX",
        "bsb_number": "062-001",
        "branch_identifier": "001",
        "bank_code": "BNH",
        "account_number": "123465",
        "account_name": "SPACEX LLC",
        "account_type": "credit_card",
        "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",
      "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/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

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.

row_versionstring or null
property name*any

Responses

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

Mapping coverage per connector

MYOB
QuickBooks
Sage Intacct
Xero
Exact Online
Request
NetSuite
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"
  },
  "level": 1,
  "active": true,
  "status": "active",
  "header": true,
  "bank_account": {
    "iban": "CH2989144532982975332",
    "bic": "AUDSCHGGXXX",
    "bsb_number": "062-001",
    "branch_identifier": "001",
    "bank_code": "BNH",
    "account_number": "123465",
    "account_name": "SPACEX LLC",
    "account_type": "credit_card",
    "currency": "USD"
  },
  "parent_account": {
    "id": "12345",
    "name": "Bank Accounts",
    "display_id": "1-1100"
  },
  "sub_account": false,
  "last_reconciliation_date": "2020-09-30",
  "row_version": "1-12345"
}

Response example

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

Get Ledger Account

get/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

Include raw response. Mostly used for debugging purposes

Responses

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

Mapping coverage per connector

MYOB
QuickBooks
Sage Intacct
Xero
Exact Online
Request
NetSuite
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"
    },
    "level": 1,
    "active": true,
    "status": "active",
    "header": true,
    "bank_account": {
      "iban": "CH2989144532982975332",
      "bic": "AUDSCHGGXXX",
      "bsb_number": "062-001",
      "branch_identifier": "001",
      "bank_code": "BNH",
      "account_number": "123465",
      "account_name": "SPACEX LLC",
      "account_type": "credit_card",
      "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",
    "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/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

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.

row_versionstring or null
property name*any

Responses

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

Mapping coverage per connector

MYOB
QuickBooks
Sage Intacct
Xero
Exact Online
Request
NetSuite
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"
  },
  "level": 1,
  "active": true,
  "status": "active",
  "header": true,
  "bank_account": {
    "iban": "CH2989144532982975332",
    "bic": "AUDSCHGGXXX",
    "bsb_number": "062-001",
    "branch_identifier": "001",
    "bank_code": "BNH",
    "account_number": "123465",
    "account_name": "SPACEX LLC",
    "account_type": "credit_card",
    "currency": "USD"
  },
  "parent_account": {
    "id": "12345",
    "name": "Bank Accounts",
    "display_id": "1-1100"
  },
  "sub_account": false,
  "last_reconciliation_date": "2020-09-30",
  "row_version": "1-12345"
}

Response example

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

Delete Ledger Account

delete/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

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
Exact Online
Request
NetSuite
Request
QuickBooks
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

Unique identifier representing the entity

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
required

Amount of payment

referencestring or null

Optional payment reference message ie: Debit remittance detail.

Payments example
{}

List Payments

get/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

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 records to return

Responses

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

Mapping coverage per connector

MYOB
QuickBooks
Sage Intacct
Xero
Exact Online
Request
NetSuite
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": "123456",
      "downstream_id": "12345",
      "currency": "USD",
      "currency_rate": 0.69,
      "total_amount": 49.99,
      "reference": "123456",
      "payment_method": "Credit Card",
      "payment_method_reference": "123456",
      "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"
      },
      "supplier": {
        "id": "12345",
        "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",
          "row_version": "1-12345"
        }
      },
      "reconciled": true,
      "status": "authorised",
      "type": "accounts_receivable",
      "allocations": [
        {
          "id": "123456",
          "type": "invoice",
          "code": "N091",
          "amount": 49.99
        }
      ],
      "note": "Some notes about this payment",
      "row_version": "1-12345",
      "display_id": "123456",
      "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/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

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
required

Amount of payment

referencestring or null

Optional payment reference message ie: Debit remittance detail.

payment_methodstring or null

Payment method

payment_method_referencestring or null

Opti