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.
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 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 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.
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 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.
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.
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 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.
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.
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
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
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.
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 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.
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.
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 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.
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 job title of the person.
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
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 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.
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 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.
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.
Date invoice was issued - YYYY-MM-DD.
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 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.
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
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.
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.
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
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.
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 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.
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.
Responses
Mapping coverage per connector