POST /rest/v1.0/requisitions/{requisition_id}/single_pdf_compilers
Merges one or more PDFs of a requisition into a single PDF. There are two ways to use this endpoint. First to generate a cover sheet for the requisition.
If you would like to receive a polling URL that will follow the job provide the polling option in the query params polling=true. If you would like the file emailed to you omit the polling param in the query params.
You can use the following request payload as an example
{
"files":[
{"type": "cover_sheet", "id": ""}
]
}
If you would like to include some attachments, you can use the following request payload as an example
{
"files": [
{
"id": "",
"type": "cover_sheet"
},
{
"id": 1234,
"url": "http://example.com/file_1.pdf",
"type": "prostore_file"
}
]
}
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
requisition_id |
Integer | Yes |
Requisition (Subcontractor Invoice) ID |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Procore-Company-Id |
Integer | Yes |
Unique company identifier associated with the Procore User Account. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
polling |
Boolean | No |
Determines if the PDF is emailed or a job URL is returned |
project_id |
Integer | Yes |
Unique identifier for the project. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
files[] |
Array | Yes | |
files[].id |
Integer | Yes |
Unique identifier for the file. |
files[].url |
String | No |
Url of the file |
files[].type |
String | Yes |
Type of file |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.