diff --git a/docs/schema-entities/project.md b/docs/schema-entities/project.md index a9e726d..9eaa292 100644 --- a/docs/schema-entities/project.md +++ b/docs/schema-entities/project.md @@ -44,23 +44,25 @@ Developer docs for reference: https://developer.intuit.com/app/developer/qbo/doc ### Project Fields -| Field Name | Type | Required | Description | -|-------------------|--------------------------------------------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------| -| name | String! | Yes | The name of the project. | -| description | String | No | The description of the project. | -| type | String | No (Optional) | The type of the project that user can define to differentiate between different types of projects and filter on them. | -| status | ProjectManagement_Status | No | The status of the project indicating the current state of the project. Default status is "OTHER" | -| priority | Int | No (Optional) | The priority of the project in the range of 0-9 where 0 is the lowest and 9 is the highest priority and filter on them. | -| customer | ProjectManagement_CustomerInput | Yes | The customer for whom the project is created. | -| account | ProjectManagement_CompanyInput | Yes | The company for whom the project is created. | -| dueDate | DateTime | No | The due date of the project. | -| startDate | DateTime | No | The start date of the project. | -| completedDate | DateTime | No | The completed date of the project. | -| completedBy | ProjectManagement_UserInput | No | The user completed the project. | -| completionRate | Decimal | No | The rate of completion of project. | -| pinned | Boolean | No | Pinned is used to tell if a project should be shown at the top of the projects list above those that are not pinned. | -| emailAddress | [Qb_EmailAddressInput] | No | The email address of the project. | -| addresses | [Qb_PostalAddressInput] | No | The addresses of the project. | +| Field Name | Type | Required | Description | +|-------------------|--------------------------------------------|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| name | String! | Yes | The name of the project. | +| description | String | No | The description of the project. | +| type | String | No (Optional) | The type of the project that user can define to differentiate between different types of projects and filter on them. | +| status | ProjectManagement_Status | No | The status of the project indicating the current state of the project. Default status is "OTHER" | +| priority | Int | No (Optional) | The priority of the project in the range of 0-9 where 0 is the lowest and 9 is the highest priority and filter on them. | +| customer | ProjectManagement_CustomerInput | Yes | The customer for whom the project is created. | +| account | ProjectManagement_CompanyInput | Yes | The company for whom the project is created. | +| dueDate | DateTime | No | The due date of the project. | +| startDate | DateTime | No | The start date of the project. | +| completedDate | DateTime | No | The completed date of the project. | +| completedBy | ProjectManagement_UserInput | No | The user completed the project. | +| completionRate | Decimal | No | The rate of completion of project. | +| pinned | Boolean | No | Pinned is used to tell if a project should be shown at the top of the projects list above those that are not pinned. | +| emailAddress | [Qb_EmailAddressInput] | No | The email address of the project. | +| addresses | [Qb_PostalAddressInput] | No | The addresses of the project. | +| externalReferences | ProjectManagement_ExternalReferenceInput | No | The external reference associated with a project the user wants to navigate to or take an action on. Learn more about custom field [here](https://intuitdeveloper.github.io/intuit-api/docs/schema-entities/customfield/) | + ### ProjectManagement_Status ``` @@ -233,6 +235,21 @@ input Qb_PostalAddressInput { ``` + +### ProjectManagement_ExternalReferenceInput + +``` +input ProjectManagement_ExternalReferenceInput { + """ Identifies the external reference """ + externalReferenceId: ID + """ A constant key the external reference can be identified with. For custom field values externalKey = CUSTOM_FIELDS """ + externalKey: String + """ Any additional information related to the external reference. Will contain the custom field values in json format if externalKey = CUSTOM_FIELDS """ + externalBlob: JSON +} + +``` + ### Common_ContactVariationInput ``` @@ -957,7 +974,8 @@ mutation ProjectManagementCreateProject($name: String!, $pinned: Boolean, $completionRate: Decimal, $emailAddress: [Qb_EmailAddressInput], - $addresses: [Qb_PostalAddressInput] + $addresses: [Qb_PostalAddressInput], + $externalReferences: [ProjectManagement_ExternalReferenceInput] ) { projectManagementCreateProject(input:{ name: $name, @@ -972,6 +990,7 @@ mutation ProjectManagementCreateProject($name: String!, completionRate: $completionRate, emailAddress: $emailAddress, addresses: $addresses, + externalReferences: $externalReferences } ) { @@ -1002,9 +1021,14 @@ mutation ProjectManagementCreateProject($name: String!, streetAddressLine3 state, postalCode - } - } } + externalReferences { + externalReferenceId, + externalKey, + externalBlob + } + } + } } } ``` @@ -1051,7 +1075,15 @@ Sample Variables: "Common_Ordinal": "PRIMARY" } } - ] + ], + "externalReferences": { + "externalKey": "CUSTOM_FIELDS", + "externalBlob": { + "QBO": { + "udcf_1000000008": "testing" + } + } + }, } ``` @@ -1096,6 +1128,17 @@ Sample response: "state": "California", "postalCode": "94114" } + ], + "externalReferences": [ + { + "externalReferenceId": "456282863", + "externalKey": "CUSTOM_FIELDS", + "externalBlob": { + "QBO": { + "udcf_1000000008": "testing" + } + } + } ] } } diff --git a/docs/use-cases/project.md b/docs/use-cases/project.md index e41a510..06cfe5e 100644 --- a/docs/use-cases/project.md +++ b/docs/use-cases/project.md @@ -94,8 +94,9 @@ Refer to the [V3 developer docs](https://developer.intuit.com/app/developer/qbo/ ![](/intuit-api/assets/images/ProjectRef.png) +##### Sample request/response payloads: -Sample Invoice creation using "ProjectRef" (from minorVersion=69): +###### 1. Invoice creation using "ProjectRef" (from minorVersion=69): ``` { @@ -236,7 +237,9 @@ Response: "time": "2024-06-26T09:20:16.310-07:00" } ``` -Sample Vendor Credit creation with "ProjectRef" at line level: + +###### 2. Sample Vendor Credit creation with "ProjectRef" at line level: + ``` { "TotalAmt": 90.0, @@ -344,7 +347,8 @@ Response: } ``` -Sample Journal Entry creation with ProjectRef at line Level: +###### 3. Sample Journal Entry creation with ProjectRef at line Level: + ``` { "Line": [