Bill Credit Notes
Bill Credit Notes endpoints for the Accounting API Unified API
A Bill Credit Note represents a supplier-issued (accounts payable) credit, including line items, amounts, and the linked supplier.
The Bill Credit Notes model
Unique identifier representing the entity
Bill credit note number.
The supplier this entity is linked to.
List Bill Credit Notes
List Bill 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.
The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.
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
Request example
Response example
Create Bill Credit Note
Create Bill 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.
The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.
Query parameters
Include raw response. Mostly used for debugging purposes
Request body schema
Bill credit note 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
Sub-total amount, normally before tax.
Amount of transaction
Total tax amount applied to this bill credit note.
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 bill credit notes
Optional reference message ie: Debit remittance detail.
Date bill credit note issued - YYYY:MM::DDThh:mm:ss.sTZD
Date bill credit note paid - YYYY:MM::DDThh:mm:ss.sTZD
The type of credit note. A bill credit note is always an accounts payable (supplier-side) credit.
Optional note to be associated with the bill credit note.
Optional terms to be associated with the bill 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
Request example
Response example
Get Bill Credit Note
Get Bill 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.
The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.
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
Request example
Response example
Update Bill Credit Note
Update Bill 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
Bill credit note 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
Sub-total amount, normally before tax.
Amount of transaction
Total tax amount applied to this bill credit note.
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 bill credit notes
Optional reference message ie: Debit remittance detail.
Date bill credit note issued - YYYY:MM::DDThh:mm:ss.sTZD
Date bill credit note paid - YYYY:MM::DDThh:mm:ss.sTZD
The type of credit note. A bill credit note is always an accounts payable (supplier-side) credit.
Optional note to be associated with the bill credit note.
Optional terms to be associated with the bill 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
Request example
Response example
Delete Bill Credit Note
Delete Bill 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
Request example
Response example