A Goods Receipt records that goods ordered on a purchase order physically arrived, with the received quantity per line linked back to the purchase order line. It sits between the purchase order and the bill in the purchase-to-pay flow and is the document three-way matching is performed against. Scope is receipts created against purchase orders; returns and non-purchase inbound movements are out of scope. Read-only in the initial release.
The Goods Receipts model
A unique identifier for an object.
The third-party API ID of original entity
Id to be displayed.
Human-readable document number of the goods receipt as shown in the accounting system.
Supplier-side reference recorded on the receipt, typically the supplier's delivery note or packing slip number.
ID of the purchase order this receipt was created against. Populated when every line of the receipt belongs to the same purchase order, or when the accounting system itself records a single originating purchase order on the receipt (see the connector gotchas); otherwise null, and the per-line line_items[].purchase_order carries the link.
List Goods Receipts
List Goods 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
Get Goods Receipt
Get Goods 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