POST /rest/v1.1/requisitions

Create a new Requisition (Subcontractor Invoices) for the specified Commitment

Servers

https://api.procore.com

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

Name	Type	Required	Description
`invite_id`	Integer	No	Unique identifier for the invite to associate with the requisition.
`view`	String	No	Specifies which view (which attributes) of the resource is going to be present in the response. Possible values: `"extended"` `"action_policy"` `"items"` `"default"`

invite_id

Integer

Unique identifier for the invite to associate with the requisition.

view

String

Specifies which view (which attributes) of the resource is going to be present in the response.

Possible values:

"extended"
"action_policy"
"items"
"default"

Request body fields

Name	Type	Required	Description
`project_id`	Integer	Yes	Project ID
`requisition`	Object	No	Requisition (Subcontractor Invoice)
`requisition.prostore_file_ids[]`	Array	No	An array of Prostore File IDs. The Prostore Files will be associated with the Requisition (Subcontractor Invoice) as attachments.
`requisition.requisition_start`	String	No	Requisition (Subcontractor Invoice) start date
`requisition.final`	Boolean	No	true or false value indicating whether or not this is the final invoice
`requisition.payment_date`	String	No	Date requisition was paid
`requisition.items[]`	Array	No
`requisition.items[].work_completed_retainage_released_this_period`	String	No	The amount of work completed retainage released this period
`requisition.items[].work_completed_this_period`	String	No	The amount of work completed this period
`requisition.items[].materials_presently_stored`	String	No	The amount of materials presently stored. Only considered when neither new_materials nor stored_materials are in the input. Ingored for unit based line items.
`requisition.items[].work_completed_this_period_quantity`	String	No	Work completed this period quantity (unit accounting contract only)
`requisition.items[].materials_stored_retainage_currently_retained`	String	No	Materials stored retainage amount currently retained (Admin user, amount accounting only, materials_presently_stored should be non-zero to hold a retainage. Ignored unless "Materials presently stored" is manually managed in your configuration.)
`requisition.items[].work_completed_retainage_retained_this_period`	String	No	Work completed retainage amount retained this period (admin user only, work_completed_this_period should be non-zero to hold a retainage)
`requisition.items[].status`	String	No	Approval status of the invoice line item Possible values: `"approved"` `"rejected"` `"no_action"`
`requisition.items[].new_materials_quantity`	String	No	Quantity of new materials added. Only applicable to unit based line items.
`requisition.items[].line_item_id`	Integer	No	The line item id of a contract line item
`requisition.items[].new_materials`	String	No	New materials amount, ignored for unit base line items.
`requisition.items[].work_completed_retainage_percent_this_period`	String	No	Work completed percentage for this period (this field is only persisted if work_completed_this_period is zero or nil)
`requisition.items[].subcontractor_claimed_amount`	String	No	The total amount the subcontractor original claimed for this line
`requisition.items[].comment`	String	No	Comment about the invoice line item
`requisition.items[].stored_materials_quantity`	Number	No
`requisition.items[].detail_line_item_id`	Integer	No	Contract Detail Item ID
`requisition.items[].materials_stored_retainage_percent_this_period`	String	No	Materials retainage percentage for this period (This field is only persisted if materials_presently_stored is zero or nil. Ignored unless "Materials presently stored" is manually managed in your configuration.)
`requisition.items[].materials_presently_stored_from_previous_progress`	String	No	The amount of materials presently stored from the previous progress
`requisition.items[].stored_materials`	String	No	Previously stored materials amount, ignored for unit base line items.
`requisition.items[].item_type`	String	Yes	The type of the item your are updating. Required if you are updating a line item. Possible values: `"change_order_item"` `"contract_item"` `"contract_detail_item"`
`requisition.status`	String	No	Status; admin can set any status, standard and billing recipient can set to under_review (submit) or draft (save) Possible values: `"approved"` `"under_review"` `"pending_owner_approval"` `"revise_and_resubmit"` `"draft"` `"approved_as_noted"`
`requisition.period_id`	Integer	No	Period ID
`requisition.origin_data`	String	No	Requisition (Subcontractor Invoice) third party data
`requisition.custom_field_%{custom_field_definition_id}`		No	Value of the custom field. The data type of the value passed in corresponds with the data_type of the Custom Field Definition. For a lov_entry data_type the value passed in should be the ID of one of the Custom Field Definition's LOV Entries. For a lov_entries data_type the value passed in should be an array of IDs of the Custom Field Definition's LOV Entries.
`requisition.invoice_number`	String	No	Invoice number
`requisition.origin_id`	String	No	Requisition (Subcontractor Invoice) third party ID
`requisition.requisition_end`	String	No	Requisition (Subcontractor Invoice) end date
`requisition.billing_date`	String	No	Billing date
`requisition.submitted_at`	String	No	Date requisition was submitted
`commitment_id`	Integer	Yes	Commitment ID

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.