List Performance Obligation Products

GET /accounting/performance-obligations/{id}/products

Group: Accounting › Performance Obligations · Operation ID: listPerformanceObligationProducts

Returns the products mapped to the given performance obligation, one entry per product and entity book. The same product appears once for each entity book it is mapped in.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "v1" yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
id path string yes The unique identifier for the performance obligation whose products to return.
cursor query string no The cursor from the previous response's pagination.nextCursor. Omit for the first page.
pageSize query number no The number of mappings per page. Defaults to 50. A value above 200 is treated as 200, not rejected.

Response

200 Success

Under data (listPerformanceObligationProductsOutput):

Field Type Required Description
items array of object yes The obligation's product mappings on this page, newest first. An empty array when the obligation maps no products.
items[].id string no The unique identifier for this product mapping.
items[].productId string no The mapped product. See id on GET accounting/products/:id.
items[].productCode string no The code of that product.
items[].productName string no The name of that product.
items[].entityBookId string no The entity book this mapping applies in. A product mapped in several entity books has one entry per book. There is no endpoint for it.
items[].entityName string no The name of the legal entity of that entity book.
items[].bookName string no The name of the accounting book of that entity book.
items[].effectiveStartDate string (date) yes The first date this mapping applies. Format YYYY-MM-DD.
items[].effectiveEndDate string (date) no The last date this mapping applies. Format YYYY-MM-DD. Absent when the mapping is open-ended.
items[].lastModifiedDate string (date-time) yes The date and time this mapping last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
pagination object yes The pagination cursor for this page.
pagination.nextCursor string no The cursor for the next page. Pass it as the cursor query parameter. Absent on the last page.
pagination.hasMore boolean yes True when more mappings remain beyond this page.

Errors

Code Status
NOT_FOUND 400

Statuses