Bills
The Bills model
A unique identifier for an object.
The third-party API ID of original entity
Reference to supplier bill number
The supplier this entity is linked to.
The company or subsidiary id the transaction belongs to
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
List Bills
List Bills
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of results to return. Minimum 1, Maximum 200, Default 20
Apply filters
Apply sorting
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Create Bill
Create Bill
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
Reference to supplier bill number
The supplier this entity is linked to.
The company or subsidiary id the transaction belongs to
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
Currency Exchange Rate at the time entity was recorded/generated.
Amounts are including tax
Date bill was issued - YYYY-MM-DD.
The due date is the date on which a payment is scheduled to be received - YYYY-MM-DD.
The paid date is the date on which a payment was sent to the supplier - YYYY-MM-DD.
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.
Optional bill reference.
Terms of payment.
Balance of bill due.
Amount of deposit made to this bill.
Sub-total amount, normally before tax.
Total tax amount applied to this bill.
Total amount of bill, including tax.
Applicable tax id/code override if tax is not supplied on a line item basis.
Invoice status
Payment method used for the transaction, such as cash, credit card, bank transfer, or check
The channel through which the transaction is processed.
language code according to ISO 639-1. For the United States - EN
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.
Discount percentage applied to this transaction.
A list of linked tracking categories.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Accounting period
Responses
Mapping coverage per connector
Request example
Response example
Get Bill
Get Bill
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Update Bill
Update Bill
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
Reference to supplier bill number
The supplier this entity is linked to.
The company or subsidiary id the transaction belongs to
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
Currency Exchange Rate at the time entity was recorded/generated.
Amounts are including tax
Date bill was issued - YYYY-MM-DD.
The due date is the date on which a payment is scheduled to be received - YYYY-MM-DD.
The paid date is the date on which a payment was sent to the supplier - YYYY-MM-DD.
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.
Optional bill reference.
Terms of payment.
Balance of bill due.
Amount of deposit made to this bill.
Sub-total amount, normally before tax.
Total tax amount applied to this bill.
Total amount of bill, including tax.
Applicable tax id/code override if tax is not supplied on a line item basis.
Invoice status
Payment method used for the transaction, such as cash, credit card, bank transfer, or check
The channel through which the transaction is processed.
language code according to ISO 639-1. For the United States - EN
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.
Discount percentage applied to this transaction.
A list of linked tracking categories.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Accounting period
Responses
Mapping coverage per connector
Request example
Response example
Delete Bill
Delete Bill
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example
Company Info
The Company Info model
A unique identifier for an object.
The name of the company.
Based on the status some functionality is enabled or disabled.
The legal name of the company
country code according to ISO 3166-1 alpha-2.
Get company info
Get company info
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Credit Notes
The Credit Notes model
Unique identifier representing the entity
Credit note number.
The customer this entity is linked to.
The company or subsidiary id the transaction belongs to
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
Currency Exchange Rate at the time entity was recorded/generated.
List Credit Notes
List Credit Notes
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of results to return. Minimum 1, Maximum 200, Default 20
Apply filters
Apply sorting
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Create Credit Note
Create Credit Note
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
Credit note number.
The customer this entity is linked to.
The company or subsidiary id the transaction belongs to
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
Currency Exchange Rate at the time entity was recorded/generated.
Amounts are including tax
Sub-total amount, normally before tax.
Amount of transaction
Total tax amount applied to this invoice.
Applicable tax id/code override if tax is not supplied on a line item basis.
The balance reflecting any payments made against the transaction.
Indicates the total credit amount still available to apply towards the payment.
Status of credit notes
Optional reference message ie: Debit remittance detail.
Date credit note issued - YYYY:MM::DDThh:mm:ss.sTZD
Date credit note paid - YYYY:MM::DDThh:mm:ss.sTZD
Type of payment
Optional note to be associated with the credit note.
Optional terms to be associated with the credit note.
A list of linked tracking categories.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Mapping coverage per connector
Request example
Response example
Get Credit Note
Get Credit Note
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Update Credit Note
Update Credit Note
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
Credit note number.
The customer this entity is linked to.
The company or subsidiary id the transaction belongs to
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
Currency Exchange Rate at the time entity was recorded/generated.
Amounts are including tax
Sub-total amount, normally before tax.
Amount of transaction
Total tax amount applied to this invoice.
Applicable tax id/code override if tax is not supplied on a line item basis.
The balance reflecting any payments made against the transaction.
Indicates the total credit amount still available to apply towards the payment.
Status of credit notes
Optional reference message ie: Debit remittance detail.
Date credit note issued - YYYY:MM::DDThh:mm:ss.sTZD
Date credit note paid - YYYY:MM::DDThh:mm:ss.sTZD
Type of payment
Optional note to be associated with the credit note.
Optional terms to be associated with the credit note.
A list of linked tracking categories.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Mapping coverage per connector
Request example
Response example
Delete Credit Note
Delete Credit Note
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example
Customers
The Customers model
A unique identifier for an object.
The third-party API ID of original entity
Display ID
Display name
The name of the company.
The company or subsidiary id the transaction belongs to
List Customers
List Customers
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of results to return. Minimum 1, Maximum 200, Default 20
Apply filters
Apply sorting
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Create Customer
Create Customer
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
Display ID
Display name
The name of the company.
The company or subsidiary id the transaction belongs to
The job title of the person.
The first name of the person.
Middle name of the person.
The last name of the person.
Is this an individual or business customer
If true, indicates this is a Project.
Some notes about this customer
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
The parent customer this entity is linked to.
Customer status
Payment method used for the transaction, such as cash, credit card, bank transfer, or check
The channel through which the transaction is processed.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Mapping coverage per connector
Request example
Response example
Get Customer
Get Customer
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Update Customer
Update Customer
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
Display ID
Display name
The name of the company.
The company or subsidiary id the transaction belongs to
The job title of the person.
The first name of the person.
Middle name of the person.
The last name of the person.
Is this an individual or business customer
If true, indicates this is a Project.
Some notes about this customer
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
The parent customer this entity is linked to.
Customer status
Payment method used for the transaction, such as cash, credit card, bank transfer, or check
The channel through which the transaction is processed.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Mapping coverage per connector
Request example
Response example
Delete Customer
Delete Customer
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example
Invoices
The Invoices model
A unique identifier for an object.
The third-party API ID of original entity
Invoice type
Invoice number.
The customer this entity is linked to.
The company or subsidiary id the transaction belongs to
List Invoices
List Invoices
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of results to return. Minimum 1, Maximum 200, Default 20
Apply filters
Apply sorting
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Create Invoice
Create Invoice
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
Invoice type
Invoice number.
The customer this entity is linked to.
The company or subsidiary id the transaction belongs to
Date invoice was issued - YYYY-MM-DD.
The invoice due date is the date on which a payment or invoice is scheduled to be received by the seller - YYYY-MM-DD.
Terms of payment.
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.
Optional invoice reference.
Invoice status
Invoice sent to contact/customer.
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
Currency Exchange Rate at the time entity was recorded/generated.
Amounts are including tax
Sub-total amount, normally before tax.
Total tax amount applied to this invoice.
Applicable tax id/code override if tax is not supplied on a line item basis.
Discount percentage applied to this invoice.
Discount amount applied to this invoice.
Total amount of invoice, including tax.
Balance of invoice due.
Amount of deposit made to this invoice.
Customer memo
A list of linked tracking categories.
Optional invoice template
URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero.
Payment method used for the transaction, such as cash, credit card, bank transfer, or check
The channel through which the transaction is processed.
language code according to ISO 639-1. For the United States - EN
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.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Mapping coverage per connector
Request example
Response example
Get Invoice
Get Invoice
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Update Invoice
Update Invoice
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
Invoice type
Invoice number.
The customer this entity is linked to.
The company or subsidiary id the transaction belongs to
Date invoice was issued - YYYY-MM-DD.
The invoice due date is the date on which a payment or invoice is scheduled to be received by the seller - YYYY-MM-DD.
Terms of payment.
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.
Optional invoice reference.
Invoice status
Invoice sent to contact/customer.
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
Currency Exchange Rate at the time entity was recorded/generated.
Amounts are including tax
Sub-total amount, normally before tax.
Total tax amount applied to this invoice.
Applicable tax id/code override if tax is not supplied on a line item basis.
Discount percentage applied to this invoice.
Discount amount applied to this invoice.
Total amount of invoice, including tax.
Balance of invoice due.
Amount of deposit made to this invoice.
Customer memo
A list of linked tracking categories.
Optional invoice template
URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero.
Payment method used for the transaction, such as cash, credit card, bank transfer, or check
The channel through which the transaction is processed.
language code according to ISO 639-1. For the United States - EN
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.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Mapping coverage per connector
Request example
Response example
Delete Invoice
Delete Invoice
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example
Invoice Items
Invoice items are stored from invoice lines to be used later on when creating new invoices.
The Invoice Items model
The ID of the item.
Item name
A short description of the item
User defined item code
Item will be available on sales transactions
Item is available for purchase transactions
List Invoice Items
List Invoice Items
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of results to return. Minimum 1, Maximum 200, Default 20
Apply filters
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Create Invoice Item
Create Invoice Item
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
Item name
A short description of the item
User defined item code
Item will be available on sales transactions
Item is available for purchase transactions
Item is inventoried
If true, transactions for this item are taxable
The date of opening balance if inventory item is tracked - YYYY-MM-DD.
Item type
A list of linked tracking categories.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Mapping coverage per connector
Request example
Response example
Get Invoice Item
Get Invoice Item
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Apply filters
Responses
Mapping coverage per connector
Request example
Response example
Update Invoice Item
Update Invoice Item
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
Item name
A short description of the item
User defined item code
Item will be available on sales transactions
Item is available for purchase transactions
Item is inventoried
If true, transactions for this item are taxable
The date of opening balance if inventory item is tracked - YYYY-MM-DD.
Item type
A list of linked tracking categories.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Mapping coverage per connector
Request example
Response example
Delete Invoice Item
Delete Invoice Item
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example
Ledger Accounts
The Ledger Accounts model
A unique identifier for an object.
The human readable display ID used when displaying the account
The nominal code of the ledger account.
The code assigned to the account.
The classification of account.
The type of account.
List Ledger Accounts
List Ledger Accounts
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of results to return. Minimum 1, Maximum 200, Default 20
Apply filters
Apply sorting
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Create Ledger Account
Create Ledger Account
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
The human readable display ID used when displaying the account
The nominal code of the ledger account.
The code assigned to the account.
The classification of account.
The type of account.
The sub type of account.
The name of the account.
The fully qualified name of the account.
The description of the account.
The opening balance of the account.
The current balance of the account.
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
The tax type of the account.
Whether the account is active or not.
The status of the account.
Whether the account is a header or not.
Whether the account is a sub account or not.
Reconciliation Date means the last calendar day of each Reconciliation Period.
The subsidiaries the account belongs to.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Mapping coverage per connector
Request example
Response example
Get Ledger Account
Get Ledger Account
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Update Ledger Account
Update Ledger Account
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
The human readable display ID used when displaying the account
The nominal code of the ledger account.
The code assigned to the account.
The classification of account.
The type of account.
The sub type of account.
The name of the account.
The fully qualified name of the account.
The description of the account.
The opening balance of the account.
The current balance of the account.
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
The tax type of the account.
Whether the account is active or not.
The status of the account.
Whether the account is a header or not.
Whether the account is a sub account or not.
Reconciliation Date means the last calendar day of each Reconciliation Period.
The subsidiaries the account belongs to.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Mapping coverage per connector
Request example
Response example
Delete Ledger Account
Delete Ledger Account
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example
Payments
The Payments model
A unique identifier for an object.
The third-party API ID of original entity
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
Currency Exchange Rate at the time entity was recorded/generated.
The total amount of the transaction
Optional transaction reference message ie: Debit remittance detail.
List Payments
List Payments
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of results to return. Minimum 1, Maximum 200, Default 20
Apply filters
Apply sorting
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Create Payment
Create Payment
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
Currency Exchange Rate at the time entity was recorded/generated.
The total amount of the transaction
Optional transaction reference message ie: Debit remittance detail.
Payment method used for the transaction, such as cash, credit card, bank transfer, or check
Optional reference message returned by payment method on processing
A unique identifier for an object.
Type of accounts receivable account.
Unique identifier for the account to allocate payment to.
The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD
The customer this entity is linked to.
The supplier this entity is linked to.
The company or subsidiary id the transaction belongs to
Indicates if the transaction has been reconciled.
Status of payment
Type of payment
Note associated with the transaction
Number associated with the transaction
A list of linked tracking categories.
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.
Id to be displayed.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Mapping coverage per connector
Request example
Response example
Get Payment
Get Payment
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Update Payment
Update Payment
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
Currency Exchange Rate at the time entity was recorded/generated.
The total amount of the transaction
Optional transaction reference message ie: Debit remittance detail.
Payment method used for the transaction, such as cash, credit card, bank transfer, or check
Optional reference message returned by payment method on processing
A unique identifier for an object.
Type of accounts receivable account.
Unique identifier for the account to allocate payment to.
The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD
The customer this entity is linked to.
The supplier this entity is linked to.
The company or subsidiary id the transaction belongs to
Indicates if the transaction has been reconciled.
Status of payment
Type of payment
Note associated with the transaction
Number associated with the transaction
A list of linked tracking categories.
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.
Id to be displayed.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Mapping coverage per connector
Request example
Response example
Delete Payment
Delete Payment
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example
Suppliers
The Suppliers model
A unique identifier for an object.
The third-party API ID of original entity
Display ID
Display name
The name of the company.
The company or subsidiary id the transaction belongs to
List Suppliers
List Suppliers
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of results to return. Minimum 1, Maximum 200, Default 20
Apply filters
Apply sorting
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Create Supplier
Create Supplier
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
Display ID
Display name
The name of the company.
The company or subsidiary id the transaction belongs to
The job title of the person.
The first name of the person.
Middle name of the person.
The last name of the person.
Is this an individual or business supplier
Some notes about this supplier
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
Supplier status
Payment method used for the transaction, such as cash, credit card, bank transfer, or check
The channel through which the transaction is processed.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
The subsidiary the supplier belongs to.
Responses
Mapping coverage per connector
Request example
Response example
Get Supplier
Get Supplier
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Update Supplier
Update Supplier
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
Display ID
Display name
The name of the company.
The company or subsidiary id the transaction belongs to
The job title of the person.
The first name of the person.
Middle name of the person.
The last name of the person.
Is this an individual or business supplier
Some notes about this supplier
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
Supplier status
Payment method used for the transaction, such as cash, credit card, bank transfer, or check
The channel through which the transaction is processed.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
The subsidiary the supplier belongs to.
Responses
Mapping coverage per connector
Request example
Response example
Delete Supplier
Delete Supplier
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example
Tax Rates
The Tax Rates model
ID assigned to identify this tax rate.
Name assigned to identify this tax rate.
Tax code assigned to identify this tax rate.
Description of tax rate
Effective tax rate
Not compounded sum of the components of a tax rate
List Tax Rates
List Tax Rates. Note: Not all connectors return the actual rate/percentage value. In this case, only the tax code or reference is returned. Connectors Affected: Quickbooks
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of results to return. Minimum 1, Maximum 200, Default 20
Apply filters
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Create Tax Rate
Create Tax Rate
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
ID assigned to identify this tax rate.
Name assigned to identify this tax rate.
Tax code assigned to identify this tax rate.
Description of tax rate
Effective tax rate
Not compounded sum of the components of a tax rate
Unique identifier for the account for tax collected.
Unique identifier for the account for tax remitted.
Tax type used to indicate the source of tax collected or paid
Report Tax type to aggregate tax collected or paid for reporting purposes
ID of the original tax rate from which the new tax rate is derived. Helps to understand the relationship between corresponding tax rate entities.
Tax rate status
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
The subsidiaries this belongs to.
Responses
Mapping coverage per connector
Request example
Response example
Get Tax Rate
Get Tax Rate. Note: Not all connectors return the actual rate/percentage value. In this case, only the tax code or reference is returned. Support will soon be added to return the actual rate/percentage by doing additional calls in the background to provide the full view of a given tax rate. Connectors Affected: Quickbooks
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Update Tax Rate
Update Tax Rate
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
ID assigned to identify this tax rate.
Name assigned to identify this tax rate.
Tax code assigned to identify this tax rate.
Description of tax rate
Effective tax rate
Not compounded sum of the components of a tax rate
Unique identifier for the account for tax collected.
Unique identifier for the account for tax remitted.
Tax type used to indicate the source of tax collected or paid
Report Tax type to aggregate tax collected or paid for reporting purposes
ID of the original tax rate from which the new tax rate is derived. Helps to understand the relationship between corresponding tax rate entities.
Tax rate status
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
The subsidiaries this belongs to.
Responses
Mapping coverage per connector
Request example
Response example
Delete Tax Rate
Delete Tax Rate
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example
Balance Sheet
The Balance Sheet model
Get BalanceSheet
Get BalanceSheet
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
Apply filters
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example
Profit and Loss
The Profit and Loss model
A unique identifier for an object.
The name of the report
The start date of the report
The start date of the report
Customer id
Get Profit and Loss
Get Profit and Loss
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Apply filters
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Journal Entries
The Journal Entries model
A unique identifier for an object.
Journal entry title
Currency Exchange Rate at the time entity was recorded/generated.
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
The company or subsidiary id the transaction belongs to
Requires a minimum of 2 line items that sum to 0
List Journal Entries
List Journal Entries
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of results to return. Minimum 1, Maximum 200, Default 20
Apply filters
Apply sorting
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Create Journal Entry
Create Journal Entry
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
Journal entry title
Currency Exchange Rate at the time entity was recorded/generated.
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
The company or subsidiary id the transaction belongs to
Requires a minimum of 2 line items that sum to 0
Reference for the journal entry.
This is the date on which the journal entry was added. This can be different from the creation date and can also be backdated.
Journal symbol of the entry. For example IND for indirect costs
The specific category of tax associated with a transaction like sales or purchase
Applicable tax id/code override if tax is not supplied on a line item basis.
Journal entry number.
A list of linked tracking categories.
Accounting period
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Mapping coverage per connector
Request example
Response example
Get Journal Entry
Get Journal Entry
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Update Journal Entry
Update Journal Entry
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
Journal entry title
Currency Exchange Rate at the time entity was recorded/generated.
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
The company or subsidiary id the transaction belongs to
Requires a minimum of 2 line items that sum to 0
Reference for the journal entry.
This is the date on which the journal entry was added. This can be different from the creation date and can also be backdated.
Journal symbol of the entry. For example IND for indirect costs
The specific category of tax associated with a transaction like sales or purchase
Applicable tax id/code override if tax is not supplied on a line item basis.
Journal entry number.
A list of linked tracking categories.
Accounting period
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Mapping coverage per connector
Request example
Response example
Delete Journal Entry
Delete Journal Entry
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example
Purchase Orders
The Purchase Orders model
A unique identifier for an object.
The third-party API ID of original entity
A PO Number uniquely identifies a purchase order and is generally defined by the buyer.
Optional purchase order reference.
The supplier this entity is linked to.
The company or subsidiary id the transaction belongs to
List Purchase Orders
List Purchase Orders
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
Number of results to return. Minimum 1, Maximum 200, Default 20
Apply filters
Apply sorting
Responses
Mapping coverage per connector
Request example
Response example
Create Purchase Order
Create Purchase Order
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
A PO Number uniquely identifies a purchase order and is generally defined by the buyer.
Optional purchase order reference.
The supplier this entity is linked to.
The company or subsidiary id the transaction belongs to
Date purchase order was issued - YYYY-MM-DD.
The date on which the purchase order is to be delivered - YYYY-MM-DD.
The date on which the order is expected to arrive - YYYY-MM-DD.
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
Currency Exchange Rate at the time entity was recorded/generated.
Sub-total amount, normally before tax.
Total tax amount applied to this invoice.
Total amount of invoice, including tax.
Amounts are including tax
Optional purchase order template
Discount percentage applied to this transaction.
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.
The due date is the date on which a payment is scheduled to be received - YYYY-MM-DD.
Payment method used for the transaction, such as cash, credit card, bank transfer, or check
Applicable tax id/code override if tax is not supplied on a line item basis.
The channel through which the transaction is processed.
Message for the supplier. This text appears on the Purchase Order.
A list of linked tracking categories.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Mapping coverage per connector
Request example
Response example
Get Purchase Order
Get Purchase Order
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example
Update Purchase Order
Update Purchase Order
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
A PO Number uniquely identifies a purchase order and is generally defined by the buyer.
Optional purchase order reference.
The supplier this entity is linked to.
The company or subsidiary id the transaction belongs to
Date purchase order was issued - YYYY-MM-DD.
The date on which the purchase order is to be delivered - YYYY-MM-DD.
The date on which the order is expected to arrive - YYYY-MM-DD.
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
Currency Exchange Rate at the time entity was recorded/generated.
Sub-total amount, normally before tax.
Total tax amount applied to this invoice.
Total amount of invoice, including tax.
Amounts are including tax
Optional purchase order template
Discount percentage applied to this transaction.
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.
The due date is the date on which a payment is scheduled to be received - YYYY-MM-DD.
Payment method used for the transaction, such as cash, credit card, bank transfer, or check
Applicable tax id/code override if tax is not supplied on a line item basis.
The channel through which the transaction is processed.
Message for the supplier. This text appears on the Purchase Order.
A list of linked tracking categories.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Mapping coverage per connector
Request example
Response example
Delete Purchase Order
Delete Purchase Order
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example
Subsidiaries
The Subsidiaries model
A unique identifier for an object.
A unique identifier for an object.
The name of the company.
Based on the status some functionality is enabled or disabled.
When custom mappings are configured on the resource, the result is included here.
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.
List Subsidiaries
List Subsidiaries
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of results to return. Minimum 1, Maximum 200, Default 20
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Create Subsidiary
Create Subsidiary
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
A unique identifier for an object.
The name of the company.
Based on the status some functionality is enabled or disabled.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Mapping coverage per connector
Request example
Response example
Get Subsidiary
Get Subsidiary
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Update Subsidiary
Update Subsidiary
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
A unique identifier for an object.
The name of the company.
Based on the status some functionality is enabled or disabled.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Mapping coverage per connector
Request example
Response example
Delete Subsidiary
Delete Subsidiary
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example
Locations
The Locations model
A unique identifier for an object.
A unique identifier for an object.
The name of the company.
The display name of the location.
Based on the status some functionality is enabled or disabled.
List Locations
List Locations
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of results to return. Minimum 1, Maximum 200, Default 20
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Apply filters
Responses
Mapping coverage per connector
Request example
Response example
Create Location
Create Location
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
A unique identifier for an object.
The name of the company.
The display name of the location.
Based on the status some functionality is enabled or disabled.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Request example
Response example
Get Location
Get Location
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Update Location
Update Location
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
A unique identifier for an object.
The name of the company.
The display name of the location.
Based on the status some functionality is enabled or disabled.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Request example
Response example
Delete Location
Delete Location
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Responses
Request example
Response example
Departments
The Departments model
A unique identifier for an object.
A unique identifier for an object.
The name of the department.
Based on the status some functionality is enabled or disabled.
When custom mappings are configured on the resource, the result is included here.
List Departments
List Departments
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of results to return. Minimum 1, Maximum 200, Default 20
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Apply filters
Responses
Mapping coverage per connector
Request example
Response example
Create Department
Create Department
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
A unique identifier for an object.
The name of the department.
Based on the status some functionality is enabled or disabled.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Request example
Response example
Get Department
Get Department
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Update Department
Update Department
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
A unique identifier for an object.
The name of the department.
Based on the status some functionality is enabled or disabled.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Request example
Response example
Delete Department
Delete Department
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Responses
Request example
Response example
Attachments
The Attachments model
A unique identifier for an object.
The display id of the file
The name of the file
The MIME type of the file.
The size of the file in bytes
List Attachments
List Attachments
Path parameters
The reference type of the document.
The reference id of the object to retrieve.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of results to return. Minimum 1, Maximum 200, Default 20
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Upload attachmentNo SDK Support
Upload attachment
Path parameters
The reference type of the document.
The reference id of the object to retrieve.
Header parameters
Metadata to attach to the attachment file
ID of the consumer which you want to get or push data from
The ID of your Unify application
The content-type of the file being uploaded
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
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Response example
Get Attachment
Get Attachment
Path parameters
The reference type of the document.
The reference id of the object to retrieve.
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Delete Attachment
Delete Attachment
Path parameters
The reference type of the document.
The reference id of the object to retrieve.
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example
Download Attachment
Download Attachment
Path parameters
The reference type of the document.
The reference id of the object to retrieve.
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Tracking Categories
The Tracking Categories model
A unique identifier for an object.
A unique identifier for an object.
The name of the tracking category.
The code of the tracking category.
Based on the status some functionality is enabled or disabled.
When custom mappings are configured on the resource, the result is included here.
List Tracking Categories
List Tracking Categories
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of results to return. Minimum 1, Maximum 200, Default 20
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Create Tracking Category
Create Tracking Category
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
A unique identifier for an object.
The name of the tracking category.
The code of the tracking category.
Based on the status some functionality is enabled or disabled.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
The subsidiaries the account belongs to.
Responses
Mapping coverage per connector
Request example
Response example
Get Tracking Category
Get Tracking Category
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Update Tracking Category
Update Tracking Category
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
A unique identifier for an object.
The name of the tracking category.
The code of the tracking category.
Based on the status some functionality is enabled or disabled.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
The subsidiaries the account belongs to.
Responses
Mapping coverage per connector
Request example
Response example
Delete Tracking Category
Delete Tracking Category
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example
Bill Payments
The Bill Payments model
A unique identifier for an object.
The third-party API ID of original entity
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
Currency Exchange Rate at the time entity was recorded/generated.
The total amount of the transaction
Optional transaction reference message ie: Debit remittance detail.
List Bill Payments
List Bill Payments
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of results to return. Minimum 1, Maximum 200, Default 20
Apply filters
Apply sorting
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Create Bill Payment
Create Bill Payment
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
Currency Exchange Rate at the time entity was recorded/generated.
The total amount of the transaction
Optional transaction reference message ie: Debit remittance detail.
Payment method used for the transaction, such as cash, credit card, bank transfer, or check
Optional reference message returned by payment method on processing
A unique identifier for an object.
The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD
The supplier this entity is linked to.
The company or subsidiary id the transaction belongs to
Indicates if the transaction has been reconciled.
Status of payment
Type of payment
Note associated with the transaction
Number associated with the transaction
A list of linked tracking categories.
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.
Id to be displayed.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Mapping coverage per connector
Request example
Response example
Get Bill Payment
Get Bill Payment
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Mapping coverage per connector
Request example
Response example
Update Bill Payment
Update Bill Payment
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
Currency Exchange Rate at the time entity was recorded/generated.
The total amount of the transaction
Optional transaction reference message ie: Debit remittance detail.
Payment method used for the transaction, such as cash, credit card, bank transfer, or check
Optional reference message returned by payment method on processing
A unique identifier for an object.
The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD
The supplier this entity is linked to.
The company or subsidiary id the transaction belongs to
Indicates if the transaction has been reconciled.
Status of payment
Type of payment
Note associated with the transaction
Number associated with the transaction
A list of linked tracking categories.
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.
Id to be displayed.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Mapping coverage per connector
Request example
Response example
Delete Bill Payment
Delete Bill Payment
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example
Expenses
The Expenses model
A unique identifier for an object.
Number.
The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD
The unique identifier for the ledger account that this expense should be credited to.
The ID of the customer this entity is linked to. Used for expenses that should be marked as billable to customers.
The ID of the supplier this entity is linked to.
List Expenses
List Expenses
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of results to return. Minimum 1, Maximum 200, Default 20
Responses
Mapping coverage per connector
Request example
Response example
Create Expense
Create Expense
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
Number.
The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD
The unique identifier for the ledger account that this expense should be credited to.
The ID of the customer this entity is linked to. Used for expenses that should be marked as billable to customers.
The ID of the supplier this entity is linked to.
The company or subsidiary id the transaction belongs to
The ID of the department this expense is linked to.
The type of payment for the expense.
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
Currency Exchange Rate at the time entity was recorded/generated.
The type of expense.
The memo of the expense.
The total amount of the expense line item.
Expense line items linked to this expense.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Mapping coverage per connector
Request example
Response example
Get Expense
Get Expense
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example
Update Expense
Update Expense
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Request body schema
Number.
The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD
The unique identifier for the ledger account that this expense should be credited to.
The ID of the customer this entity is linked to. Used for expenses that should be marked as billable to customers.
The ID of the supplier this entity is linked to.
The company or subsidiary id the transaction belongs to
The ID of the department this expense is linked to.
The type of payment for the expense.
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
Currency Exchange Rate at the time entity was recorded/generated.
The type of expense.
The memo of the expense.
The total amount of the expense line item.
Expense line items linked to this expense.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Mapping coverage per connector
Request example
Response example
Delete Expense
Delete Expense
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example
Aged Creditors
The Aged Creditors model
The exact date and time the report was generated.
The cutoff date for transactions included in the report.
Number of aging periods shown in the report.
Length of each aging period in days.
Get Aged CreditorsUpcoming
Get Aged Creditors
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Apply filters
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Request example
Response example
Aged Debtors
The Aged Debtors model
The exact date and time the report was generated.
The cutoff date for transactions included in the report.
Number of aging periods shown in the report.
Length of each aging period in days.
Get Aged DebtorsUpcoming
Get Aged Debtors
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
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
Include raw response. Mostly used for debugging purposes
Apply filters
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: fields=name,email,addresses.city
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Responses
Request example
Response example
Customer CreatedWebhook
Event broadcast when a customer has been created.
Header parameters
The type of event that was triggered
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Mapping coverage per connector
Example Event
Customer UpdatedWebhook
Event broadcast when a customer has been updated.
Header parameters
The type of event that was triggered
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Mapping coverage per connector
Example Event
Customer DeletedWebhook
Event broadcast when a customer has been deleted.
Header parameters
The type of event that was triggered
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Mapping coverage per connector
Example Event
Invoice CreatedWebhook
Event broadcast when an invoice has been created.
Header parameters
The type of event that was triggered
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Mapping coverage per connector
Example Event
Invoice UpdatedWebhook
Event broadcast when an invoice has been updated.
Header parameters
The type of event that was triggered
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Mapping coverage per connector
Example Event
Invoice DeletedWebhook
Event broadcast when an invoice has been deleted.
Header parameters
The type of event that was triggered
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Mapping coverage per connector
Example Event
Invoice Item CreatedWebhook
Event broadcast when an invoice has been item created.
Header parameters
The type of event that was triggered
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Example Event
Invoice Item UpdatedWebhook
Event broadcast when an invoice has been item updated.
Header parameters
The type of event that was triggered
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Example Event
Invoice Item DeletedWebhook
Event broadcast when an invoice has been item deleted.
Header parameters
The type of event that was triggered
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Example Event
Ledger Account CreatedWebhook
Event broadcast when a ledger has been account created.
Header parameters
The type of event that was triggered
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Example Event
Ledger Account UpdatedWebhook
Event broadcast when a ledger has been account updated.
Header parameters
The type of event that was triggered
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Example Event
Ledger Account DeletedWebhook
Event broadcast when a ledger has been account deleted.
Header parameters
The type of event that was triggered
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Example Event
Tax Rate CreatedWebhook
Event broadcast when a tax has been rate created.
Header parameters
The type of event that was triggered
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Example Event
Tax Rate UpdatedWebhook
Event broadcast when a tax has been rate updated.
Header parameters
The type of event that was triggered
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Example Event
Tax Rate DeletedWebhook
Event broadcast when a tax has been rate deleted.
Header parameters
The type of event that was triggered
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Example Event
Purchase Order CreatedWebhook
Event broadcast when a purchase has been order created.
Header parameters
The type of event that was triggered
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Example Event
Purchase order DeletedWebhook
Event broadcast when a purchase order has been deleted.
Header parameters
The type of event that was triggered
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Example Event
Purchase order UpdatedWebhook
Event broadcast when a purchase order has been updated.
Header parameters
The type of event that was triggered
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Example Event
Expense UpdatedWebhook
Event broadcast when an expense has been updated.
Header parameters
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Unique reference to this request event
Name of Apideck Unified API
Service provider identifier
Unique consumer identifier. You can freely choose a consumer ID yourself. Most of the time, this is an ID of your internal data model that represents a user or account in your system (for example account:12345). If the consumer doesn't exist yet, Vault will upsert a consumer based on your ID.
The service provider's ID of the entity that triggered this event
The type entity that triggered this event
The url to retrieve entity detail.
The current count this request event has been attempted
ISO Datetime for when the original event occurred
Responses
Mapping coverage per connector
Example Event
Expense DeletedWebhook
Event broadcast when an expense has been deleted.
Header parameters
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Unique reference to this request event
Name of Apideck Unified API
Service provider identifier
Unique consumer identifier. You can freely choose a consumer ID yourself. Most of the time, this is an ID of your internal data model that represents a user or account in your system (for example account:12345). If the consumer doesn't exist yet, Vault will upsert a consumer based on your ID.
The service provider's ID of the entity that triggered this event
The type entity that triggered this event
The url to retrieve entity detail.
The current count this request event has been attempted
ISO Datetime for when the original event occurred
Responses
Mapping coverage per connector
Example Event
Expense CreatedWebhook
Event broadcast when an expense has been created.
Header parameters
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Unique reference to this request event
Name of Apideck Unified API
Service provider identifier
Unique consumer identifier. You can freely choose a consumer ID yourself. Most of the time, this is an ID of your internal data model that represents a user or account in your system (for example account:12345). If the consumer doesn't exist yet, Vault will upsert a consumer based on your ID.
The service provider's ID of the entity that triggered this event
The type entity that triggered this event
The url to retrieve entity detail.
The current count this request event has been attempted
ISO Datetime for when the original event occurred
Responses
Mapping coverage per connector
Example Event