Accounting API

Ledger Accounts

Tax Rates

Company Info

Invoices

Customers

Bills

Suppliers

Invoice Items

Payments

Credit Notes

Journal Entries

Subsidiaries

BalanceSheet

ProfitAndLoss

Purchase Orders

Locations

Departments

Attachments

Tracking Categories

Bill Payments

Expenses

Aged Creditors

Aged Debtors

Bank Feed Accounts

Bank Feed Statements

Quotes

Bank Accounts

Projects

Refunds

Companies

Employees

Expense Categories

Expense Reports

Banqup is the digital link between business owners and their accountant. With Banqup you can create and send outgoing invoices, get paid and maintain a complete overview.

banqUP

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

Accounting by Row

Balance

Account Name

Account Number

Account Type

Bank Code

The name of the bank or financial institution

Bank Name

BIC/SWIFT Code

Branch Identifier

Bank State Branch number (Australia/New Zealand)

BSB Number

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

Country Code

Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

Currency

IBAN

Routing Number

Name of the contact person at the address

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

Address field that holds a sublocality, such as a county

Line 1 of the address e.g. number, street, suite, apt #, etc.

Notes

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

Row version

Salutation of the contact person at the address

The address string. Some APIs don't provide structured address data.

edge-case

The channel through which the transaction is processed.

Channel

The company ID the transaction belongs to

CompanyId

The date and time when the object was created.

Created at (timestamp)

Created by

UNKNOWN_CURRENCY

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

Currency Exchange Rate

medium

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

Company Name

Display ID

Display Name

Email

The ID of the customer this entity is linked to.

Customer ID

The name of the customer. Deprecated, use display_name instead.

Name

LinkedCustomer

Customer memo

Department ID

Deposit

Discount Amount

Discount percentage applied to this invoice.

Discount Percent

Display id

The third-party API ID of original entity

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

Due date

Invoice date

Invoice Sent

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

Code

Account ID

Nominal Code

Parent ID

Invoice Line Item

Location ID

Invoice number

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

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

Payment method

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.

Purchase Order number

Optional reference identifier for the transaction.

Reference

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

Source document URL

Status

Sub-total amount

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

Tax Code

Tax inclusive

Template

Terms

Payment Terms ID

Total amount

Total tax amount applied to this invoice.

Total tax amount

Linked tracking categories

The unique identifier for the tracking category.

Tracking Category ID

Tracking Category Name

Invoice type

The date and time when the object was last updated.

Updated at (timestamp)

Updated by

Company name

Customer Category

First name

Is this an individual or business customer

Is individual

Last name

Middle name

The parent customer this entity is linked to.

The parent ID of the customer this entity is linked to.

LinkedParentCustomer

Is project

Suffix

Tax number

Tax rate code

The ID of the object.

Rate

Whether the entity is subject to taxation

Taxable

Job title

high

filter

x-apideck-app-id

Metadata to attach to the attachment file (JSON string)

x-apideck-metadata

sort

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

x-apideck-company-id

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

x-apideck-consumer-id

The content-type of the file being uploaded

content-type

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

cursor

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

fields

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

limit

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

pass_through

Include raw response. Mostly used for debugging purposes

The reference id of the object to retrieve.

reference_id

reference_type

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

x-apideck-service-id

Account Code

Account Id

The available balance (considering pending transactions and overdraft)

Available Balance

Current Balance

Description or notes about the bank account

Description

Overdraft Limit

Represents a company/tenant/organization accessible through the current connection. Used for multi-company connectors where a single OAuth connection provides access to multiple companies.

Unique identifier for the company in the downstream system. Use this value in the x-apideck-company-id header to scope requests to this company.

banqUP – Gotchas