A Sales Receipt represents a point-of-sale transaction where payment is received at the time of sale, with no accounts-receivable leg: payment is captured at sale and the receipt closes immediately.
The Sales Receipts model
Unique identifier representing the sales receipt
Reference number for the sales receipt.
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 Sales Receipts
List Sales Receipts
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
Mapping coverage per connector
Request example
Response example
Create Sales Receipt
Create Sales Receipt
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
Reference number for the sales receipt.
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
Subtotal amount, normally before tax.
The total amount of the transaction or record
Total tax amount applied to this transaction.
The date of the sales receipt transaction - YYYY-MM-DDThh:mm:ss.sTZD
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.
Line items for itemized sales receipts. Used when the sales receipt includes product/service details with quantities and pricing.
Applicable tax id/code override if tax is not supplied on a line item basis.
Discount percentage applied to this sales receipt.
Discount amount applied to this sales receipt.
Optional note to be associated with the sales receipt.
Customer memo
Optional reference message for the sales receipt.
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 Sales Receipt
Get Sales Receipt
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
Mapping coverage per connector
Request example
Response example
Update Sales Receipt
Update Sales Receipt
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
Request body schema
Reference number for the sales receipt.
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
Subtotal amount, normally before tax.
The total amount of the transaction or record
Total tax amount applied to this transaction.
The date of the sales receipt transaction - YYYY-MM-DDThh:mm:ss.sTZD
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.
Line items for itemized sales receipts. Used when the sales receipt includes product/service details with quantities and pricing.
Applicable tax id/code override if tax is not supplied on a line item basis.
Discount percentage applied to this sales receipt.
Discount amount applied to this sales receipt.
Optional note to be associated with the sales receipt.
Customer memo
Optional reference message for the sales receipt.
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 Sales Receipt
Delete Sales Receipt
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
Responses
Mapping coverage per connector
Request example
Response example