Skip to content

initial-cloneddocs #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

initial-cloneddocs #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0706b97
ProjectRef update for VendorCredit and Journal Entry
smohan-intuit Apr 16, 2025
ee99d54
ProjectRef update for VendorCredit and Journal Entry
smohan-intuit Apr 16, 2025
f2e04e7
ProjectRef update for VendorCredit and Journal Entry
smohan-intuit Apr 16, 2025
7e044a0
Update project.md with externalReferences for custom field support
sethu-intuitdev May 6, 2025
4eb2f79
Update project.md externalReferences description about CF.
sethu-intuitdev May 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 64 additions & 21 deletions docs/schema-entities/project.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down Expand Up @@ -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

```
Expand Down Expand Up @@ -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,
Expand All @@ -972,6 +990,7 @@ mutation ProjectManagementCreateProject($name: String!,
completionRate: $completionRate,
emailAddress: $emailAddress,
addresses: $addresses,
externalReferences: $externalReferences
}
)
{
Expand Down Expand Up @@ -1002,9 +1021,14 @@ mutation ProjectManagementCreateProject($name: String!,
streetAddressLine3
state,
postalCode
}
}
}
externalReferences {
externalReferenceId,
externalKey,
externalBlob
}
}
}
}
}
```
Expand Down Expand Up @@ -1051,7 +1075,15 @@ Sample Variables:
"Common_Ordinal": "PRIMARY"
}
}
]
],
"externalReferences": {
"externalKey": "CUSTOM_FIELDS",
"externalBlob": {
"QBO": {
"udcf_1000000008": "testing"
}
}
},
}

```
Expand Down Expand Up @@ -1096,6 +1128,17 @@ Sample response:
"state": "California",
"postalCode": "94114"
}
],
"externalReferences": [
{
"externalReferenceId": "456282863",
"externalKey": "CUSTOM_FIELDS",
"externalBlob": {
"QBO": {
"udcf_1000000008": "testing"
}
}
}
]
}
}
Expand Down
10 changes: 7 additions & 3 deletions docs/use-cases/project.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):

```
{
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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": [
Expand Down