{"openapi":"3.1.0","info":{"title":"CarbonCrop API","description":"\nDocumentation for the CarbonCrop API. For personal use, you can [click here to retrieve a temporary auth token](/users/me/token). For longer lived tokens or programmatic access, please contact us.\n\n[Responsible Disclosure](https://app.carboncrop.com/security.txt)\n","contact":{"name":"CarbonCrop","url":"https://carboncrop.com/","email":"hello@carboncrop.com"},"version":"0.1.0"},"paths":{"/api/v1/available_imagery":{"post":{"summary":"Available Imagery","description":"Find imagery layers available for a region of interest.\n\nThe polygons or multipolygons in the feature collection define the region to\nsearch. Provider searches run independently, so successful layers are returned\neven if some providers fail. A non-empty `errors` list means the response is\npartial and may not contain all available imagery.","operationId":"post-available_imagery","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sources_to_check","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/SourceName"}},{"type":"null"}],"description":"Imagery providers to search. If omitted, searches all providers available to the caller.","title":"Sources To Check"},"description":"Imagery providers to search. If omitted, searches all providers available to the caller."},{"name":"full_coverage","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"When true, return only imagery confirmed to cover the entire region of interest.","default":false,"title":"Full Coverage"},"description":"When true, return only imagery confirmed to cover the entire region of interest."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeatureCollection_IdTypes_Union_Polygon__MultiPolygon___FeaturePropertyType__CollectionMetadataType_"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailableImageryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/ccu":{"post":{"summary":"Post Ccu Data","description":"Ingest a CCU record.\n\nThe record captures the CCU's originating Carbon Tracking Region, when its\ncarbon was sequestered, when the unit was created, and the registry or\nmarketplace currently responsible for trading it.","operationId":"post-ccu","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CcuTrace"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/ccu/{ccu_id}":{"get":{"summary":"Ccu Trace Details","description":"Return traceability information for a CCU.\n\nUse this endpoint to identify the Carbon Tracking Region and approximate\nlocation from which the CCU originated, along with its issuance,\nsequestration, and current registry details. Returns a 400 response if the\nCCU does not exist.","operationId":"get-ccu","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ccu_id","in":"path","required":true,"schema":{"type":"integer","title":"Ccu Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CcuTrace"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/ccu_forecast":{"get":{"summary":"Get Ccu Forecast Endpoint","description":"Get CCU forecast prices.","operationId":"get-ccu_forecast","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarbonPrices"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/cloudconvert/{job_id}":{"get":{"summary":"Get","operationId":"get-cloudconvert","security":[{"HTTPBearer":[]}],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RawLocalPdfJobResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/cloudconvert/{job_id}/file":{"get":{"summary":"Get","operationId":"get-cloudconvert-file","security":[{"HTTPBearer":[]}],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/companies":{"get":{"summary":"List Companies Endpoint","description":"Returns a list of all companies","operationId":"get-companies","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CompanyResponse"},"type":"array","title":"Response Get-Companies"}}}}},"security":[{"HTTPBearer":[]}]},"post":{"summary":"Create Company Endpoint","description":"Creates a new company.\n\nNote that this requires CompanyProperties to be passed in.","operationId":"post-companies","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCompanyPost"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/companies/{company_id}":{"get":{"summary":"Get Company Endpoint","description":"Get information about a company","operationId":"get-company","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CompanyResponse"},{"type":"null"}],"title":"Response Get-Company"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/companies/{company_id}/access":{"get":{"summary":"Get Company Access","description":"Get the features that the user has access to for a given company.","operationId":"get-company-access","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAccessResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/companies/{company_id}/custom_species":{"put":{"summary":"Create Or Update Custom Species","description":"Replace a company's custom-species configuration.\n\nThe configuration supplies species choices and polygon defaults, and may supply\ncarbon-stock curves used in financial forecasts.","operationId":"put-company-custom_species","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomSpeciesData"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"summary":"Get Company Custom Species","description":"Return a company's complete custom-species configuration, if one exists.","operationId":"get-company-custom_species","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CustomSpeciesData"},{"type":"null"}],"title":"Response Get-Company-Custom Species"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Delete Company Custom Species","description":"Delete a company's custom-species configuration.","operationId":"delete-company-custom_species","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/companies/{company_id}/customers/boundaries":{"get":{"summary":"Get Company Sites Overview","description":"Get company sites boundaries","operationId":"get-company-customers-boundaries","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeatureCollection_IdTypes_GeometryTypes_BoundaryOverviewProperties_NoneType_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/companies/{company_id}/kickstarter":{"post":{"summary":"Create Kickstarter","description":"Create a site with the company assigned the Kickstarter overview tag.\n\nKickstarter sites support screening and portfolio analysis, such as examining\nlocation, Land Use Capability, and Highly Erodible Land across many sites,\nwithout granting the company full site-management access.","operationId":"post-company-kickstarter","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomerPost"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomerResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/companies/{company_id}/layers":{"get":{"summary":"List Company Layers Endpoint","description":"List the latest version of each GIS layer owned by a company.","operationId":"get-company-layers","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyLayerListModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Create Company Layer Endpoint","description":"Create a GIS layer shared across a company's maps.","operationId":"post-company-layers","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Layer_Annotated_Union_CustomLayerProperties__CustomRasterCommonLayerProperties___FieldInfo_annotation_NoneType__required_True__discriminator__type____IdTypes_GeometryTypes_PropertyTypes_"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LayerModel_Annotated_Union_CustomLayerProperties__CustomRasterCommonLayerProperties___FieldInfo_annotation_NoneType__required_True__discriminator__type____"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/companies/{company_id}/layers/{layer_id}":{"get":{"summary":"Get Company Layer Endpoint","description":"Return a company-owned GIS layer.","operationId":"get-company-layer","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"layer_id","in":"path","required":true,"schema":{"type":"integer","title":"Layer Id"}},{"name":"version_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The version to retrieve; defaults to the current version.","title":"Version Id"},"description":"The version to retrieve; defaults to the current version."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Layer_Annotated_Union_CustomLayerProperties__CustomRasterCommonLayerProperties___FieldInfo_annotation_NoneType__required_True__discriminator__type____IdTypes_GeometryTypes_PropertyTypes_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"summary":"Replace Company Layer Endpoint","description":"Replace a company-owned GIS layer by creating a new current version.\n\nEarlier versions remain available in the layer's version history.","operationId":"put-company-layer","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"layer_id","in":"path","required":true,"schema":{"type":"integer","title":"Layer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Layer_Annotated_Union_CustomLayerProperties__CustomRasterCommonLayerProperties___FieldInfo_annotation_NoneType__required_True__discriminator__type____IdTypes_GeometryTypes_PropertyTypes_"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LayerModel_Annotated_Union_CustomLayerProperties__CustomRasterCommonLayerProperties___FieldInfo_annotation_NoneType__required_True__discriminator__type____"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Delete Company Layer Endpoint","description":"Remove a GIS layer from the company's maps.","operationId":"delete-company-layer","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"layer_id","in":"path","required":true,"schema":{"type":"integer","title":"Layer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string"},"title":"Response Delete-Company-Layer"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/companies/{company_id}/layers/{layer_id}/versions":{"get":{"summary":"List Company Layer Versions Endpoint","description":"List the stored versions of a company-owned GIS layer.\n\nResults are ordered by version ID.","operationId":"get-company-layer-versions","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"layer_id","in":"path","required":true,"schema":{"type":"integer","title":"Layer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyLayerVersionListModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/companies/{company_id}/properties":{"get":{"summary":"Get Company Properties Endpoint","description":"Properties that describe a company in the platform.","operationId":"get-company-properties","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CompanyProperties"},{"type":"null"}],"title":"Response Get-Company-Properties"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"summary":"Update Company Properties Endpoint","description":"Replace the properties that describe a company in the platform.","operationId":"put-company-properties","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyProperties"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/companies/{company_id}/properties/participant_specific_table.xls":{"put":{"summary":"Upload Participant Specific Tables","description":"Get information about a company","operationId":"put-company-properties-participant_specific_table-xls","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_put-company-properties-participant_specific_table-xls"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParticipantSpecificTable"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/companies/{company_id}/tasks":{"get":{"summary":"Get Site Tasks By Company Id","description":"Get task list of a company","operationId":"get-company-tasks","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/AnyTask"}},{"type":"null"}],"title":"Response Get-Company-Tasks"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/companies/{company_id}/users":{"get":{"summary":"Get Company All Users","description":"Get all associated users of  a company","operationId":"get-company-users","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/CompanyUserResponse"}},{"type":"null"}],"title":"Response Get-Company-Users"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/companies/{company_id}/users/invitation":{"post":{"summary":"Invite User For Company","description":"Invite an user to a customer by email and tags.","operationId":"post-company-users-invitation","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InviteCompanyUserPost"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyUserResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/companies/{company_id}/users/{user_id}":{"get":{"summary":"Get Relationship Between Company And User","description":"Returns a list of tags that represent the relation between the specified company and user","operationId":"get-company-user","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"user_id","in":"path","required":true,"schema":{"type":"integer","title":"User Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CompanyUserTags"},"title":"Response Get-Company-User"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/companies/{company_id}/users/{user_id}/tags/all":{"delete":{"summary":"Remove Relationship Between Company And User","description":"Removes the relationship between the specified company and user","operationId":"delete-company-user-tags-all","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"user_id","in":"path","required":true,"schema":{"type":"integer","title":"User Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/companies/{company_id}/users/{user_id}/{tagname}":{"post":{"summary":"Create User Company Association","description":"Creates a relationship between a company and a user","operationId":"post-company-user","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"user_id","in":"path","required":true,"schema":{"type":"integer","title":"User Id"}},{"name":"tagname","in":"path","required":true,"schema":{"$ref":"#/components/schemas/CompanyUserTags"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Delete User Company Association","description":"Removes the relationship between a company and user (eg a person is no longer employed at that company)","operationId":"delete-company-user","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"user_id","in":"path","required":true,"schema":{"type":"integer","title":"User Id"}},{"name":"tagname","in":"path","required":true,"schema":{"$ref":"#/components/schemas/CompanyUserTags"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/companies/{company_id}/voluntary_carbon_projects":{"get":{"summary":"List Voluntary Carbon Projects Endpoint","description":"List voluntary carbon projects owned by a company.\n\nResults are ordered by most recently updated first.","operationId":"get-company-voluntary_carbon_projects","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoluntaryCarbonProjectListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Create Voluntary Carbon Project Endpoint","description":"Create a voluntary carbon project for a company.","operationId":"post-company-voluntary_carbon_projects","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoluntaryCarbonProjectSaveRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoluntaryCarbonProject"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/companies/{company_id}/voluntary_carbon_projects/{voluntary_carbon_project_id}":{"get":{"summary":"Get Voluntary Carbon Project Endpoint","description":"Return a voluntary carbon project.","operationId":"get-company-voluntary_carbon_project","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"voluntary_carbon_project_id","in":"path","required":true,"schema":{"type":"integer","title":"Voluntary Carbon Project Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoluntaryCarbonProject"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"summary":"Update Voluntary Carbon Project Endpoint","description":"Update a voluntary carbon project's properties and slot rows.\n\nProperties and the slots map are full replacements: slot types omitted from\nthe request body are removed. An empty slots map clears all slots.","operationId":"put-company-voluntary_carbon_project","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"voluntary_carbon_project_id","in":"path","required":true,"schema":{"type":"integer","title":"Voluntary Carbon Project Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoluntaryCarbonProjectSaveRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoluntaryCarbonProject"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Delete Voluntary Carbon Project Endpoint","description":"Remove a voluntary carbon project from a company.","operationId":"delete-company-voluntary_carbon_project","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"voluntary_carbon_project_id","in":"path","required":true,"schema":{"type":"integer","title":"Voluntary Carbon Project Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string"},"title":"Response Delete-Company-Voluntary Carbon Project"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/companies/{company_id}/voluntary_carbon_projects/{voluntary_carbon_project_id}/slots":{"get":{"summary":"List Voluntary Carbon Project Slots Endpoint","description":"List slot rows for a voluntary carbon project.\n\nEach row includes type, status, and a content_preview derived from the slot's\nnested content field for list screens. Full content is available from the\nper-slot GET endpoint. Results are ordered by slot type.","operationId":"get-company-voluntary_carbon_project-slots","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"voluntary_carbon_project_id","in":"path","required":true,"schema":{"type":"integer","title":"Voluntary Carbon Project Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoluntaryCarbonProjectSlotListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/companies/{company_id}/voluntary_carbon_projects/{voluntary_carbon_project_id}/slots/{slot_type}":{"get":{"summary":"Get Voluntary Carbon Project Slot Endpoint","description":"Return one slot's content for a voluntary carbon project.","operationId":"get-company-voluntary_carbon_project-slot","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"voluntary_carbon_project_id","in":"path","required":true,"schema":{"type":"integer","title":"Voluntary Carbon Project Id"}},{"name":"slot_type","in":"path","required":true,"schema":{"type":"string","title":"Slot Type"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoluntaryCarbonProjectSlotDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/copilot/chats":{"post":{"summary":"Create Chat","description":"Start a new conversation.","operationId":"post-copilot-chats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatRequest"}}},"required":true},"responses":{"200":{"description":"CoPilot turn as EventSourceResponse (OpenAI ChatCompletionChunk format or [DONE] sentinel on success).","content":{"text/event-stream":{"itemSchema":{"type":"object","properties":{"data":{"type":"string"},"event":{"type":"string"},"id":{"type":"string"},"retry":{"type":"integer","minimum":0}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/copilot/chats/{conversation_id}":{"post":{"summary":"Continue Chat","description":"Continue an existing conversation.","operationId":"post-copilot-chat","security":[{"HTTPBearer":[]}],"parameters":[{"name":"conversation_id","in":"path","required":true,"schema":{"type":"integer","title":"Conversation Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatRequest"}}}},"responses":{"200":{"description":"CoPilot turn as EventSourceResponse (OpenAI ChatCompletionChunk format or [DONE] sentinel on success).","content":{"text/event-stream":{"itemSchema":{"type":"object","properties":{"data":{"type":"string"},"event":{"type":"string"},"id":{"type":"string"},"retry":{"type":"integer","minimum":0}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/ctr":{"post":{"summary":"Post Ctr Data","description":"Soft deleted targe CTR in DB, and insert a new CTR feature data.","operationId":"post-ctr","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Feature_IdTypes_Union_Polygon__MultiPolygon__Dict_str__Any__"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/ctr/shapefile":{"get":{"summary":"Download Ctr Shapefile","description":"Download shapefile for all CTR(s).\n\nThis doesn't do any parsing or validation of the shapefile, the CRS is EPSG:4326.","operationId":"get-ctr-shapefile","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/ctr/{ctr_id}":{"get":{"summary":"Get Ctr Data","description":"Query CTR GeoJSON feature data by CTR ID.\n\nIf the CTR does not exist, it returns a 400 error","operationId":"get-ctr","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ctr_id","in":"path","required":true,"schema":{"type":"integer","title":"Ctr Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CtrTraceResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers":{"get":{"summary":"Get All Customers Ids","operationId":"get-customers","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CustomerId"},"type":"array","title":"Response Get-Customers"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/customers/overview":{"get":{"summary":"Get Location Of All Customers","description":"Get location FeatureCollection data of all customers (excluding test sites).","operationId":"get-customers-overview","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeatureCollection_NoneType_Point_SitePointProperty_NoneType_"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/customers/{customer_id}/access":{"get":{"summary":"Get Customer Access","description":"Get the features that the user has access to for a given customer.","operationId":"get-customer-access","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAccessResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/altcert/evaluate":{"post":{"summary":"Trigger Alt Cert Run","description":"Trigger project Alt-Cert evaluation.","operationId":"post-customer-altcert-evaluate","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFlowRunResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/balance_forward":{"get":{"summary":"Get Balance Carried Forward","description":"Get all invoice data for given customer ID.","operationId":"get-customer-balance_forward","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BalanceForwardResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/billing_address":{"get":{"summary":"Get Hubspot Customer Billing Address","description":"Return hubspot deal information for a given customer.","operationId":"get-customer-billing_address","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressAnswer"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/boundary":{"get":{"summary":"Get Customer Boundary","description":"Return the project boundary as a GeoJSON FeatureCollection.\n\nWhen *inverted* is true, returns the area outside the boundary\n(useful for exclusion zones).","operationId":"get-customer-boundary","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"inverted","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Inverted"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeatureCollection_IdTypes_Union_Polygon__MultiPolygon__Union_SiteBoundaryFeatureProperties__NoneType__NoneType_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/caas/yields":{"get":{"summary":"Get Yields For Project By Caa","description":"Get financial forecasts for the area of a project.","operationId":"get-customer-caas-yields","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"segments_version_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Segments Version Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/YieldsForCAA"},"title":"Response Get-Customer-Caas-Yields"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/carbon_stock_pipeline/ets/evaluate":{"post":{"summary":"Evaluate Ets","operationId":"post-customer-carbon_stock_pipeline-ets-evaluate","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"overwrite_segments","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Overwrite Segments"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CreateFlowRunResponse"},{"type":"null"}],"title":"Response Post-Customer-Carbon Stock Pipeline-Ets-Evaluate"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/carbon_stock_pipeline/run_flow":{"post":{"summary":"Trigger Flow","operationId":"post-customer-carbon_stock_pipeline-run_flow","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"flow_name","in":"query","required":false,"schema":{"type":"string","description":"The name of the Prefect flow to trigger (e.g. ETS-flow). Will be set as tag.","default":"Flow","title":"Flow Name"},"description":"The name of the Prefect flow to trigger (e.g. ETS-flow). Will be set as tag."}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Optional parameters specific to the submitted flow.","title":"Flow Parameters"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CreateFlowRunResponse"},{"type":"null"}],"title":"Response Post-Customer-Carbon Stock Pipeline-Run Flow"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/carbon_stock_pipeline/unity_flow":{"post":{"summary":"Post Trigger Unity Flow","description":"Trigger project unity flow evaluation.","operationId":"post-customer-carbon_stock_pipeline-unity_flow","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"overwrite_segments","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Overwrite Segments"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFlowRunResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/companies":{"get":{"summary":"Query Customer Company Associations","description":"Return every company-site relationship tag for the site.","operationId":"get-customer-companies","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CustomerCompanyAssociationsResponse"},{"type":"null"}],"title":"Response Get-Customer-Companies"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/companies/{company_id}/relationship_data":{"get":{"summary":"Get","description":"Get the relationship data (e.g. tags) for a company-customer pair.","operationId":"get-customer-company-relationship_data","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CompanyCustomerRelationshipData"},{"type":"null"}],"title":"Response Get-Customer-Company-Relationship Data"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"summary":"Put","description":"Set (upsert) the relationship data (e.g. tags) for a company-customer pair.","operationId":"put-customer-company-relationship_data","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCustomerRelationshipData"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCustomerRelationshipData"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/companies/{customer_company_tag}":{"get":{"summary":"Get","description":"Return the company assigned the requested tag, or null if none is assigned.","operationId":"get-customer-company","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"customer_company_tag","in":"path","required":true,"schema":{"$ref":"#/components/schemas/CompanyCustomerTags"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CompanyPropertiesResponse"},{"type":"null"}],"title":"Response Get-Customer-Company"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Post","description":"Assign the requested relationship tag to a company.\n\nThis replaces any company currently assigned the same tag. Other relationship\ntags for the site are unchanged.","operationId":"post-customer-company","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"customer_company_tag","in":"path","required":true,"schema":{"$ref":"#/components/schemas/CompanyCustomerTags"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeCarbonManagerRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Delete","description":"Remove the requested relationship tag from its assigned company.\n\nOther relationship tags for the site are unchanged.","operationId":"delete-customer-company","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"customer_company_tag","in":"path","required":true,"schema":{"$ref":"#/components/schemas/CompanyCustomerTags"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/companies/{customer_company_tag}/custom_species":{"get":{"summary":"Get Custom Species By Customer Id","description":"Return the custom-species configuration inherited by a site.\n\nThe company is selected through its specified relationship tag with the site. The\nresponse includes the carbon-stock curves.","operationId":"get-customer-company-custom_species","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"customer_company_tag","in":"path","required":true,"schema":{"$ref":"#/components/schemas/CompanyCustomerTags"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CustomSpeciesData"},{"type":"null"}],"title":"Response Get-Customer-Company-Custom Species"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/companies/{customer_company_tag}/custom_species/summary":{"get":{"summary":"Get Customer Carbon Manager Custom Species Summary","description":"Return custom species without their carbon-stock values.\n\nThe company is selected through its specified relationship tag with the site. An\nempty list is returned when that relationship or its custom-species configuration\ndoes not exist.","operationId":"get-customer-company-custom_species-summary","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"customer_company_tag","in":"path","required":true,"schema":{"$ref":"#/components/schemas/CompanyCustomerTags"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CustomSpeciesSummaryList"},{"type":"null"}],"title":"Response Get-Customer-Company-Custom Species-Summary"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/credit_notes":{"get":{"summary":"Get Customer Credit Notes","description":"Get all invoice data for given customer ID.","operationId":"get-customer-credit_notes","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/QueryCreditNoteResponse"},"title":"Response Get-Customer-Credit Notes"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Create Customer Credit Note","description":"Create a new credit note for the customer.","operationId":"post-customer-credit_notes","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreditNoteRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/economics/by_feature":{"post":{"summary":"Get Economics For Block","description":"Get financial forecasts for a block.","operationId":"post-customer-economics-by_feature","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"total_area","in":"query","required":false,"schema":{"type":"number","default":0.0,"title":"Total Area"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Feature_IdTypes_Union_Polygon__MultiPolygon__CommonGeoJsonProperties_"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockEconomics"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/economics/update":{"post":{"summary":"Update Economics","description":"Triggers a force refresh of the cached economics data for a customer.","operationId":"post-customer-economics-update","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/ets_land_district":{"get":{"summary":"Get Ets Land District","description":"Query ETS land districts for the all segments of specific customer.","operationId":"get-customer-ets_land_district","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"anyOf":[{"enum":["AUCKLAND"],"const":"AUCKLAND","type":"string"},{"enum":["WAIKATO/TAUPO"],"const":"WAIKATO/TAUPO","type":"string"},{"enum":["BAY OF PLENTY"],"const":"BAY OF PLENTY","type":"string"},{"enum":["GISBORNE"],"const":"GISBORNE","type":"string"},{"enum":["HAWKES BAY/SOUTHERN NORTH ISLAND"],"const":"HAWKES BAY/SOUTHERN NORTH ISLAND","type":"string"},{"enum":["NELSON/MARLBOROUGH"],"const":"NELSON/MARLBOROUGH","type":"string"},{"enum":["CANTERBURY/WEST COAST"],"const":"CANTERBURY/WEST COAST","type":"string"},{"enum":["OTAGO"],"const":"OTAGO","type":"string"},{"enum":["SOUTHLAND"],"const":"SOUTHLAND","type":"string"}]},"title":"Response Get-Customer-Ets Land District"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/flow_run/{flow_run_id}":{"get":{"summary":"Query Flow Run State","description":"Query flow running state from Prefect.","operationId":"get-customer-flow_run","security":[{"HTTPBearer":[]}],"parameters":[{"name":"flow_run_id","in":"path","required":true,"schema":{"type":"string","title":"Flow Run Id"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowRunStatus"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/gdrive":{"get":{"summary":"Get Customer Root Folder","operationId":"get-customer-gdrive","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Get-Customer-Gdrive"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/gdrive/{internal_path}":{"post":{"summary":"Upload File To Google Drive","description":"Upload a file to the project's Google Drive folder.\n\nThe *internal_path* specifies the folder structure within the\nproject's drive. Intended for use by account managers uploading\nproject documentation.","operationId":"post-customer-gdrive","security":[{"HTTPBearer":[]}],"parameters":[{"name":"internal_path","in":"path","required":true,"schema":{"type":"string","title":"Internal Path"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_post-customer-gdrive"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/invoices":{"post":{"summary":"Add Service Fee Invoice Data","description":"Insert invoice data into Database.","operationId":"post-customer-invoices","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicePostRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceDataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"summary":"Get Service Fee Invoice Data","description":"Get all invoice data for given customer ID.","operationId":"get-customer-invoices","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceDataResponse"},"title":"Response Get-Customer-Invoices"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/invoices/{invoice_id}.pdf":{"get":{"summary":"Get Invoice Pdf","description":"Get existing invoice PDF file from Google Drive otherwise capture a new PDF.","operationId":"get-customer-invoice-pdf","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"invoice_id","in":"path","required":true,"schema":{"type":"integer","title":"Invoice Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/invoices/{invoice_id}":{"delete":{"summary":"Delete Customer Invoice","description":"Delete draft invoice.","operationId":"delete-customer-invoice","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"invoice_id","in":"path","required":true,"schema":{"type":"integer","title":"Invoice Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/invoices/{invoice_id}/file_id":{"get":{"summary":"Get Invoice Pdf In Google Drive","description":"Get existing invoice PDF file ID from Google Drive.","operationId":"get-customer-invoice-file_id","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"invoice_id","in":"path","required":true,"schema":{"type":"integer","title":"Invoice Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceGoogleDriveFileIdResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/invoices/{invoice_id}/nzetr_balance":{"put":{"summary":"Update Nzetr Balance","description":"Update NZETR balance for draft & sent invoice.","operationId":"put-customer-invoice-nzetr_balance","security":[{"HTTPBearer":[]}],"parameters":[{"name":"invoice_id","in":"path","required":true,"schema":{"type":"integer","title":"Invoice Id"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnitBalance"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceDataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/invoices/{invoice_id}/payments":{"get":{"summary":"Get Invoice Payments","description":"Get all payments for given invoice ID.","operationId":"get-customer-invoice-payments","security":[{"HTTPBearer":[]}],"parameters":[{"name":"invoice_id","in":"path","required":true,"schema":{"type":"integer","title":"Invoice Id"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PaymentResponseData"},"title":"Response Get-Customer-Invoice-Payments"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/invoices/{invoice_id}/payments/{payment_id}/status":{"put":{"summary":"Set Payment Status","description":"Update payment status.","operationId":"put-customer-invoice-payment-status","security":[{"HTTPBearer":[]}],"parameters":[{"name":"invoice_id","in":"path","required":true,"schema":{"type":"integer","title":"Invoice Id"}},{"name":"payment_id","in":"path","required":true,"schema":{"type":"integer","title":"Payment Id"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentStatusUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentResponseData"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/invoices/{invoice_id}/properties":{"put":{"summary":"Recalculate Service Fee Invoice","description":"Recalculate and update invoice data.","operationId":"put-customer-invoice-properties","security":[{"HTTPBearer":[]}],"parameters":[{"name":"invoice_id","in":"path","required":true,"schema":{"type":"integer","title":"Invoice Id"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceUpdateInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceDataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/invoices/{invoice_id}/properties/nzus_issued":{"put":{"summary":"Recalculate Service Fee Invoice","description":"Recalculate invoice data.","operationId":"put-customer-invoice-properties-nzus_issued","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"invoice_id","in":"path","required":true,"schema":{"type":"integer","title":"Invoice Id"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceUpdateInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceDataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/invoices/{invoice_id}/send":{"post":{"summary":"Send Invoice","description":"Send invoice to a given email address","operationId":"post-customer-invoice-send","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"invoice_id","in":"path","required":true,"schema":{"type":"integer","title":"Invoice Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendInvoiceRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/invoices/{invoice_id}/status":{"put":{"summary":"Set Service Fee Invoice Status","description":"Update invoice status.","operationId":"put-customer-invoice-status","security":[{"HTTPBearer":[]}],"parameters":[{"name":"invoice_id","in":"path","required":true,"schema":{"type":"integer","title":"Invoice Id"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceStatusUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceDataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/kickstarter/activation":{"post":{"summary":"Activate Kickstarter","description":"Make the Kickstarter company the site's carbon manager.\n\nThis replaces any existing carbon manager, then removes the company's\nKickstarter relationship tag. Other company-site relationship tags are unchanged.","operationId":"post-customer-kickstarter-activation","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/kml_file":{"get":{"summary":"Generate Customer Kml File","description":"Return the project's segments as a downloadable KML file.\n\nThe KML file can be opened in Google Earth to visualise\nsegment boundaries.","operationId":"get-customer-kml_file","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/layers":{"post":{"summary":"Create Layer","description":"Create a new layer in the project with the provided GeoJSON features.","operationId":"post-customer-layers","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Layer_AllLayerProperties_IdTypes_GeometryTypes_PropertyTypes_"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LayerModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"summary":"Get All Project Layers","description":"Return a summary of all layers in the project (IDs, versions, properties).\n\nSupports conditional requests via ETag to avoid transferring\nunchanged data.","operationId":"get-customer-layers","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"if-none-match","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"If-None-Match"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LayerListModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/layers/comments":{"post":{"summary":"Update Layer","description":"Create or update the comment points layer for a project.\n\nIf a comment points layer already exists, its features are\nreplaced. Otherwise a new layer is created.","operationId":"post-customer-layers-comments","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Layer_CommentPointsLayerProperties_IdTypes_Point_CommentPointProperties_"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LayerModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"summary":"Get Layer","description":"Query specified layer data for specified project, with specified version ID or latest version.","operationId":"get-customer-layers-comments","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"version_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"}},{"name":"if-none-match","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"If-None-Match"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Layer_AllLayerProperties_IdTypes_GeometryTypes_PropertyTypes_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/layers/{layer_id}":{"post":{"summary":"Update Layer","description":"Replace the features in an existing layer, creating a new version.","operationId":"post-customer-layer","security":[{"HTTPBearer":[]}],"parameters":[{"name":"layer_id","in":"path","required":true,"schema":{"type":"integer","title":"Layer Id"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Layer_AllLayerProperties_IdTypes_GeometryTypes_PropertyTypes_"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LayerModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"summary":"Get Layer","description":"Query specified layer data for specified project, with specified version ID or latest version.","operationId":"get-customer-layer","security":[{"HTTPBearer":[]}],"parameters":[{"name":"layer_id","in":"path","required":true,"schema":{"type":"integer","title":"Layer Id"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"version_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"}},{"name":"if-none-match","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"If-None-Match"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Layer_AllLayerProperties_IdTypes_GeometryTypes_PropertyTypes_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Delete Layer","description":"Permanently delete a layer and all of its versions from the project.","operationId":"delete-customer-layer","security":[{"HTTPBearer":[]}],"parameters":[{"name":"layer_id","in":"path","required":true,"schema":{"type":"integer","title":"Layer Id"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string"},"title":"Response Delete-Customer-Layer"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/layers/{layer_id}/versions":{"get":{"summary":"Get All Versions","description":"Return all versions of a layer, including properties and timestamps.","operationId":"get-customer-layer-versions","security":[{"HTTPBearer":[]}],"parameters":[{"name":"layer_id","in":"path","required":true,"schema":{"type":"integer","title":"Layer Id"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionListModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/linz_titles":{"get":{"summary":"Query Linz Titles","description":"This API endpoint is different to the \"normal\" titles endpoint, in that\nit looks up this properties titles from the master NZ titles list, instead\nof from the boundaries layer. This provides the most up to date view, but,\nit may be different from when the site was created. E.g. owners could have\nchanged, or titles could be missing.","operationId":"get-customer-linz_titles","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TitlesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/linz_titles/features":{"get":{"summary":"Query Linz Title Features","description":"Get synced LINZ title features for the site's titles. The feature id and the\n`title_no` property are both the title No.","operationId":"get-customer-linz_titles-features","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeatureCollection_str_GeometryTypes_NzTitleProperties_NoneType_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/measures":{"get":{"summary":"Get Measures For Project","description":"Get measures for the area of a project.","operationId":"get-customer-measures","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"segments_version_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Segments Version Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DimsAndMeasures"},"title":"Response Get-Customer-Measures"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/measures/by-feature":{"get":{"summary":"Get Measures By Feature For Site","description":"Get measures for the area of a project by feature.","operationId":"get-customer-measures-by-feature","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"segments_version_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Segments Version Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SingleFeatureMeasures"},"title":"Response Get-Customer-Measures-By-Feature"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/measures/cached":{"get":{"summary":"Get Customer Measures Cached","description":"Return the cached dimensions and measures for a site.","operationId":"get-customer-measures-cached","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/SiteWithDimensions"},{"type":"null"}],"title":"Response Get-Customer-Measures-Cached"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/measures/for-features":{"post":{"summary":"Get Measures For Features Route","description":"Get measures for the area of a single feature.","operationId":"post-customer-measures-for-features","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeatureCollection_IdTypes_Union_Polygon__MultiPolygon__CommonGeoJsonProperties_Any_"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DimsAndMeasures"},"title":"Response Post-Customer-Measures-For-Features"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/parcelstatus":{"get":{"summary":"Get Parcel Status","description":"Return the title status of each parcel and list of projects sharing those parcels.\n\nUsed to detect when multiple CarbonCrop projects overlap the\nsame land titles, which can cause ETS registration issues.","operationId":"get-customer-parcelstatus","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParcelStatusResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/per_email":{"post":{"summary":"Send Per Email","description":"Send PER email to invite landholder for data input.","operationId":"post-customer-per_email","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerEmailPost"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/photos/requested_points":{"get":{"summary":"Get Project Photo Requested Points","description":"Return GeoJSON points marking locations where evidence photos are still needed.","operationId":"get-customer-photos-requested_points","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeatureCollection_IdTypes_Union_Point__MultiPoint__PhotoPointProperties_NoneType_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Post Project Photo Requested Points","description":"Set or update the list of locations requiring evidence photos.","operationId":"post-customer-photos-requested_points","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeatureCollection_IdTypes_Union_Point__MultiPoint__PhotoPointProperties_NoneType_"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeatureCollection_IdTypes_Union_Point__MultiPoint__PhotoPointProperties_NoneType_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/photos/taken":{"post":{"summary":"Upload Photo File","description":"Upload evidence photos to the project's Google Drive folder.\n\nUploaded files are renamed with a sequential point number and\nthe project ID. Returns the GeoJSON locations of uploaded photos.","operationId":"post-customer-photos-taken","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_post-customer-photos-taken"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeatureCollection_IdTypes_Union_Point__NoneType__PhotoTakenProperties_NoneType_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/photos/taken/{file_id}":{"get":{"summary":"Get Photos Thumbnail","description":"Return an evidence photo from Google Drive.\n\nIf *size* is ``thumbnail``, returns a thumbnail; otherwise\nreturns the original file.","operationId":"get-customer-photos-taken","security":[{"HTTPBearer":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","title":"File Id"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"size","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"","title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Delete Photo","description":"Delete an evidence photo from the project's Google Drive folder.","operationId":"delete-customer-photos-taken","security":[{"HTTPBearer":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","title":"File Id"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empty"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/photos/taken/{file_id}/archived":{"put":{"summary":"Put Photo Archived","operationId":"put-customer-photos-taken-archived","security":[{"HTTPBearer":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","title":"File Id"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhotoArchivedBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/photos/taken_points":{"get":{"summary":"Get Photos Taken Points","description":"Get project evidence photos taken points.","operationId":"get-customer-photos-taken_points","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeatureCollection_IdTypes_Union_Point__NoneType__PhotoTakenProperties_NoneType_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/properties":{"get":{"summary":"Get Customer Properties By Id","description":"Return stored properties for the customer (comments, report values, etc.).","operationId":"get-customer-properties","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CustomerProperties"},{"type":"null"}],"title":"Response Get-Customer-Properties"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Post Customer Properties","description":"Create or update customer properties and sync financial data to HubSpot.","operationId":"post-customer-properties","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerProperties"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerProperties"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/realtime/events":{"post":{"summary":"Post Realtime Event","operationId":"post-customer-realtime-events","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CursorPositionEvent"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CursorPositionEvent"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"summary":"Get Realtime Events","operationId":"get-customer-realtime-events","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"source_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"Source Id"}}],"responses":{"200":{"description":"Successful Response","content":{"text/event-stream":{"itemSchema":{"type":"object","properties":{"data":{"type":"string"},"event":{"type":"string"},"id":{"type":"string"},"retry":{"type":"integer","minimum":0}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/reports/{report}/generate-pdf":{"post":{"summary":"Generate Report","description":"Queue a report for PDF generation.\n\nThe report is rendered in the frontend, captured via Playwright,\nand saved to Google Drive. Returns immediately with a job ID.","operationId":"post-customer-report-generate-pdf","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"report","in":"path","required":true,"schema":{"type":"string","title":"Report"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportInfo"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncLocalPdfJobResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/segmentation/features/{feature_id}/properties/{top_level_property}":{"get":{"summary":"Get Segment Properties","description":"Returns the properties of a single feature in the project","operationId":"get-customer-segmentation-feature-property","security":[{"HTTPBearer":[]}],"parameters":[{"name":"feature_id","in":"path","required":true,"schema":{"type":"integer","title":"Feature Id"}},{"name":"top_level_property","in":"path","required":true,"schema":{"type":"string","title":"Top Level Property"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get-Customer-Segmentation-Feature-Property"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"summary":"Patch Segment Properties","description":"Updates the properties of a feature to match new values. This is useful for\ndoing a partial update of a project.\nReturns the featureID of the feature that replaces this one or raises a 400 error\nif the feature does not exist.","operationId":"patch-customer-segmentation-feature-property","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"feature_id","in":"path","required":true,"schema":{"type":"integer","title":"Feature Id"}},{"name":"top_level_property","in":"path","required":true,"schema":{"type":"string","title":"Top Level Property"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Patch-Customer-Segmentation-Feature-Property"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/segments":{"post":{"summary":"Insert Customer Segmentation","description":"Insert segmentation (feature) data into database with new URL.","operationId":"post-customer-segments","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"run_update_economics","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Run Update Economics"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerSegmentationPost"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentationPostResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"summary":"Get Customer Segmentation","description":"Query customer segments.","operationId":"get-customer-segments","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"version_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"}},{"name":"if-none-match","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"If-None-Match"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeatureCollection_IdTypes_GeometryTypes_CommonGeoJsonProperties_SegmentationMetadata_"}}}},"304":{"description":"Not Modified"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/segments/ets/registration":{"post":{"summary":"Upload Ets Registered Segments","description":"Update ETS registered polygons to segments layer.","operationId":"post-customer-segments-ets-registration","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerSegmentationPost"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/tasks":{"get":{"summary":"Get Tasks By Site Id","description":"Get all task for a site.","operationId":"get-customer-tasks","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/AnyTask"}},{"type":"null"}],"title":"Response Get-Customer-Tasks"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"summary":"Update Task Endpoint","description":"Update or create a task","operationId":"put-customer-tasks","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/Mer2022Task"},{"$ref":"#/components/schemas/Per2023Task"},{"$ref":"#/components/schemas/Per2024Task"},{"$ref":"#/components/schemas/EmissionsReturnTask"},{"$ref":"#/components/schemas/InvoiceTask"},{"$ref":"#/components/schemas/AssessEtsEligibilityTask"},{"$ref":"#/components/schemas/CreateEtsAccountTask"},{"$ref":"#/components/schemas/RegisterLandToEtsTask"},{"$ref":"#/components/schemas/EtsRegistrationTask"},{"$ref":"#/components/schemas/TransferNzusTask"},{"$ref":"#/components/schemas/TransferNzusTaskV2"},{"$ref":"#/components/schemas/TransferEtsParticipationTask"},{"$ref":"#/components/schemas/RemoveLandFromEtsTask"},{"$ref":"#/components/schemas/CompleteKycTask"},{"$ref":"#/components/schemas/CreateHoldingAccountTask"},{"$ref":"#/components/schemas/AppointRepresentativeTask"},{"$ref":"#/components/schemas/OpenTupuakePartyTask"},{"$ref":"#/components/schemas/CollectEvidenceTask"},{"$ref":"#/components/schemas/FinaliseMappingTask"},{"$ref":"#/components/schemas/ForestDetailsConfirmationTask"},{"$ref":"#/components/schemas/FillMpiApplicationTask"},{"$ref":"#/components/schemas/SignOffTask"},{"$ref":"#/components/schemas/CollectAdvancePaymentTask"},{"$ref":"#/components/schemas/SubmitApplicationTask"},{"$ref":"#/components/schemas/UploadEvidenceTask"},{"$ref":"#/components/schemas/UpdateCaaToSubmittedTask"},{"$ref":"#/components/schemas/MpiAssessmentTask"},{"$ref":"#/components/schemas/UploadRegisteredShapefileTask"},{"$ref":"#/components/schemas/PrepareForestryRightsTask"},{"$ref":"#/components/schemas/CompleteIpcFormTask"},{"$ref":"#/components/schemas/WriteMpiEvidenceReportTask"},{"$ref":"#/components/schemas/CollectPhotosUsingFieldscanTask"},{"$ref":"#/components/schemas/TreeWeedCalculatorTask"},{"$ref":"#/components/schemas/RmaComplianceTask"},{"$ref":"#/components/schemas/WriteElfReportTask"},{"$ref":"#/components/schemas/Pre2007DeforestationReportTask"},{"$ref":"#/components/schemas/LandUseChangeReportTask"},{"$ref":"#/components/schemas/WriteSpecificEventReportTask"},{"$ref":"#/components/schemas/CustomTask"},{"$ref":"#/components/schemas/LandTransitionTask"}],"title":"Task"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/tasks/forest_details/{task_uuid}/email":{"post":{"summary":"Invite To Synlait Forest Details Confirmation Task","description":"Send an email to the landholder for the confirmation of forest details.\n  - If the email/user is not yet the site user, create a user as site viewer\n  - Send an email to the target email for forest details confirmation\n  - Add sending email log to the task.","operationId":"post-customer-tasks-forest_detail-email","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"task_uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Task Uuid"}},{"name":"email","in":"query","required":true,"schema":{"type":"string","title":"Email"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/tasks/invoice":{"post":{"summary":"Create Invoice Task","description":"Create invoice task and associate with a blank invoice.","operationId":"post-customer-tasks-invoice","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/tasks/land_transition":{"post":{"summary":"Create Land Transition Task","description":"Create land transition task, and return the task ID.","operationId":"post-customer-tasks-land_transition","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Post-Customer-Tasks-Land Transition"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/tasks/land_transition/{task_uuid}":{"get":{"summary":"Get Land Transition Task","description":"Query land transition task with given customer ID and task ID.","operationId":"get-customer-tasks-land_transition","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"task_uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Task Uuid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AnyTask"},{"type":"null"}],"title":"Response Get-Customer-Tasks-Land Transition"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/tasks/land_transition/{task_uuid}/user_input":{"put":{"summary":"Put Land Transition User Input","description":"Update user input data for land transition task.","operationId":"put-customer-tasks-land_transition-user_input","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"task_uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Task Uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LandTransitionTaskUserInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/tasks/transfer_nzus":{"post":{"summary":"Create Transfer Nzu Task","description":"Create transfer NZUs task, and return the task ID.","operationId":"post-customer-tasks-transfer_nzus","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Post-Customer-Tasks-Transfer Nzus"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"summary":"Get Transfer Nzu Tasks","description":"Query transfer NZUs tasks.","operationId":"get-customer-tasks-transfer_nzus","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/AnyTask"}},{"type":"null"}],"title":"Response Get-Customer-Tasks-Transfer Nzus"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/tasks/transfer_nzus/{task_uuid}/completion":{"put":{"summary":"Complete Transfer Nzu","description":"Complete transfer NZUs task, send notification and update NZETR balance.","operationId":"put-customer-tasks-transfer_nzu-completion","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"task_uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Task Uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferNzusTaskEmailRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/tasks/transfer_nzus/{task_uuid}/request":{"put":{"summary":"Update Transfer Nzu Request","description":"Update request date for transfer NZUs task.","operationId":"put-customer-tasks-transfer_nzu-request","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"task_uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Task Uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferNzusRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/tasks/transfer_nzus/{task_uuid}/submission":{"put":{"summary":"Submit Transfer Nzu Task","description":"Submit request date for transfer NZUs task, set it ready for processing.","operationId":"put-customer-tasks-transfer_nzu-submission","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"task_uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Task Uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferNzusSubmission"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/tasks/transfer_nzus/{task_uuid}/transfer":{"put":{"summary":"Update Transfer Nzu Task","description":"Update request date for transfer NZUs task.","operationId":"put-customer-tasks-transfer_nzu-transfer","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"task_uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Task Uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferNzusProcessRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/tasks/{task_uuid}":{"delete":{"summary":"Delete Task Endpoint","description":"Soft-deletes a task","operationId":"delete-customer-task","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"task_uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Task Uuid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"summary":"Update Site Task","description":"Update a task by its UUID and customer ID, NOT including its sub-tasks.","operationId":"put-customer-task","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"task_uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Task Uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/Mer2022Task"},{"$ref":"#/components/schemas/Per2023Task"},{"$ref":"#/components/schemas/Per2024Task"},{"$ref":"#/components/schemas/EmissionsReturnTask"},{"$ref":"#/components/schemas/InvoiceTask"},{"$ref":"#/components/schemas/AssessEtsEligibilityTask"},{"$ref":"#/components/schemas/CreateEtsAccountTask"},{"$ref":"#/components/schemas/RegisterLandToEtsTask"},{"$ref":"#/components/schemas/EtsRegistrationTask"},{"$ref":"#/components/schemas/TransferNzusTask"},{"$ref":"#/components/schemas/TransferNzusTaskV2"},{"$ref":"#/components/schemas/TransferEtsParticipationTask"},{"$ref":"#/components/schemas/RemoveLandFromEtsTask"},{"$ref":"#/components/schemas/CompleteKycTask"},{"$ref":"#/components/schemas/CreateHoldingAccountTask"},{"$ref":"#/components/schemas/AppointRepresentativeTask"},{"$ref":"#/components/schemas/OpenTupuakePartyTask"},{"$ref":"#/components/schemas/CollectEvidenceTask"},{"$ref":"#/components/schemas/FinaliseMappingTask"},{"$ref":"#/components/schemas/ForestDetailsConfirmationTask"},{"$ref":"#/components/schemas/FillMpiApplicationTask"},{"$ref":"#/components/schemas/SignOffTask"},{"$ref":"#/components/schemas/CollectAdvancePaymentTask"},{"$ref":"#/components/schemas/SubmitApplicationTask"},{"$ref":"#/components/schemas/UploadEvidenceTask"},{"$ref":"#/components/schemas/UpdateCaaToSubmittedTask"},{"$ref":"#/components/schemas/MpiAssessmentTask"},{"$ref":"#/components/schemas/UploadRegisteredShapefileTask"},{"$ref":"#/components/schemas/PrepareForestryRightsTask"},{"$ref":"#/components/schemas/CompleteIpcFormTask"},{"$ref":"#/components/schemas/WriteMpiEvidenceReportTask"},{"$ref":"#/components/schemas/CollectPhotosUsingFieldscanTask"},{"$ref":"#/components/schemas/TreeWeedCalculatorTask"},{"$ref":"#/components/schemas/RmaComplianceTask"},{"$ref":"#/components/schemas/WriteElfReportTask"},{"$ref":"#/components/schemas/Pre2007DeforestationReportTask"},{"$ref":"#/components/schemas/LandUseChangeReportTask"},{"$ref":"#/components/schemas/WriteSpecificEventReportTask"},{"$ref":"#/components/schemas/CustomTask"},{"$ref":"#/components/schemas/LandTransitionTask"}],"title":"Task"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AnyTask"},{"type":"null"}],"title":"Response Put-Customer-Task"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"summary":"Get Task","description":"Get a task by its UUID and customer ID, NOT including its sub-tasks.","operationId":"get-customer-task","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"task_uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Task Uuid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AnyTask"},{"type":"null"}],"title":"Response Get-Customer-Task"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/tasks/{task_uuid}/all_tasks":{"get":{"summary":"Get a task including its sub-tasks","description":"Query a task by its UUID and customer ID, including its sub-tasks.","operationId":"get-customer-task-all_tasks","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"task_uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Task Uuid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnyTask"},"title":"Response Get-Customer-Task-All Tasks"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/tasks/{task_uuid}/sub_tasks":{"get":{"summary":"Get sub-tasks by parent task ID","description":"Query all sub tasks by parent task ID.","operationId":"get-customer-task-sub_tasks","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"task_uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Task Uuid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnyTask"},"title":"Response Get-Customer-Task-Sub Tasks"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/titles":{"post":{"summary":"Post Site Titles","operationId":"post-customer-titles","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"run_ai","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Run Ai"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"title":"Titles"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"summary":"Get Site Titles","operationId":"get-customer-titles","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TitlesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/token":{"get":{"summary":"Get Token For Site","operationId":"get-customer-token","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Get-Customer-Token"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/users":{"get":{"summary":"Get Users For Customer","operationId":"get-customer-users","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CustomerUsersResponse"},{"type":"null"}],"title":"Response Get-Customer-Users"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/users/invitation":{"post":{"summary":"Invite User For Customer","description":"Invite an user to a customer by email and tags.","operationId":"post-customer-users-invitation","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InviteSiteUserPost"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/users/{user_id}":{"delete":{"summary":"Remove User Site Access","description":"Remove user access from a site.","operationId":"delete-customer-user","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"user_id","in":"path","required":true,"schema":{"type":"integer","title":"User Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/customers/{customer_id}/users/{user_id}/tags/{tagname}":{"post":{"summary":"Post User For Customer","operationId":"post-customer-user-tag","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"user_id","in":"path","required":true,"schema":{"type":"integer","title":"User Id"}},{"name":"tagname","in":"path","required":true,"schema":{"$ref":"#/components/schemas/CustomerUserTags"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Delete User For Customer","operationId":"delete-customer-user-tag","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"user_id","in":"path","required":true,"schema":{"type":"integer","title":"User Id"}},{"name":"tagname","in":"path","required":true,"schema":{"$ref":"#/components/schemas/CustomerUserTags"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/flow_run/{flow_run_id}":{"get":{"summary":"Query Flow Run State","description":"Query flow running state from Prefect.","operationId":"get-flow_run","security":[{"HTTPBearer":[]}],"parameters":[{"name":"flow_run_id","in":"path","required":true,"schema":{"type":"string","title":"Flow Run Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowRunStatus"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/hubspot/deals/{customer_id}":{"get":{"summary":"Get Hubspot Deals","description":"Return hubspot deal information for a given customer.","operationId":"get-hubspot-deal","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"type":"array","items":{"type":"object"}},{"type":"null"}],"title":"Response Get-Hubspot-Deal"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/hubspot/deals/{customer_id}/properties":{"post":{"summary":"Update Project Properties In Hubspot","description":"Update properties in hubspot for a given deal.","operationId":"post-hubspot-deal-properties","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HubspotDealProperties"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/HubspotDealUpdateResponse"},{"type":"null"}],"title":"Response Post-Hubspot-Deal-Properties"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/nzu_forecast":{"get":{"summary":"Get Ccu Forecast Endpoint","description":"Get CCU forecast prices.","operationId":"get-nzu_forecast","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarbonPrices"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/redis/retrieve/{key}":{"get":{"summary":"Retrieve From Cache","description":"Retrieve a cached value by key. Returns 404 if the key does not exist.","operationId":"get-redis-retrieve","security":[{"HTTPBearer":[]}],"parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","title":"Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CacheRetrieveResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/redis/store":{"post":{"summary":"Store In Cache","description":"Store a value in the Redis cache with an optional TTL.","operationId":"post-redis-store","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RedisCacheEntry"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CacheResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/sites/{site_id}/users/{user_id}":{"delete":{"summary":"Remove User Site Access Deprecated","description":"Remove user access from a site.","operationId":"delete-site-user","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"integer","title":"Site Id"}},{"name":"user_id","in":"path","required":true,"schema":{"type":"integer","title":"User Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/users":{"post":{"summary":"Create User By Email","operationId":"post-users","security":[{"HTTPBearer":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPost"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"summary":"Query User","operationId":"get-users","security":[{"HTTPBearer":[]}],"parameters":[{"name":"email","in":"query","required":true,"schema":{"type":"string","title":"Email"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserInfoResponse"},"title":"Response Get-Users"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/users/me":{"get":{"summary":"Get Current User","operationId":"get-users-me","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/UserInfoResponse"},{"type":"null"}],"title":"Response Get-Users-Me"}}}}},"security":[{"HTTPBearer":[]}]},"post":{"summary":"Update Current User","operationId":"post-users-me","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPut"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/users/me/companies":{"get":{"summary":"Get Current User Companies","operationId":"get-users-me-companies","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/UsersCompanyListResponse"},{"type":"null"}],"title":"Response Get-Users-Me-Companies"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/users/me/customers":{"get":{"summary":"Get Current User Customers","operationId":"get-users-me-customers","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CustomersForUser"},"type":"array","title":"Response Get-Users-Me-Customers"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/users/me/token":{"get":{"summary":"Get Current User Token","operationId":"get-users-me-token","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResponse"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/users/{user_id}":{"get":{"summary":"Get User By Id","operationId":"get-user","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"integer","title":"User Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/UserInfoResponse"},{"type":"null"}],"title":"Response Get-User"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"summary":"Update User By Id","operationId":"put-user","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"integer","title":"User Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPut"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Delete User By Id","operationId":"delete-user","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"integer","title":"User Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/users/{user_id}/companies":{"get":{"summary":"Get User Companies","description":"Query user companies and tags for company management.","operationId":"get-user-companies","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"integer","title":"User Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/UsersCompanyListResponse"},{"type":"null"}],"title":"Response Get-User-Companies"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/users/{user_id}/customers":{"get":{"summary":"Get User Customers","operationId":"get-user-customers","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"integer","title":"User Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomersForUser"},"title":"Response Get-User-Customers"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/users/{user_id}/tags/{tagname}":{"post":{"summary":"Post User Tag","operationId":"post-user-tag","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"integer","title":"User Id"}},{"name":"tagname","in":"path","required":true,"schema":{"$ref":"#/components/schemas/UserTagEnum"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Del User Tag","operationId":"delete-user-tag","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"integer","title":"User Id"}},{"name":"tagname","in":"path","required":true,"schema":{"$ref":"#/components/schemas/UserTagEnum"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/voluntary_carbon_slot_catalog/{scheme_version}":{"get":{"summary":"Get Voluntary Carbon Slot Catalog Endpoint","description":"Return slot type definitions for a voluntary carbon scheme version.","operationId":"get-voluntary_carbon_slot_catalog","security":[{"HTTPBearer":[]}],"parameters":[{"name":"scheme_version","in":"path","required":true,"schema":{"type":"string","title":"Scheme Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoluntaryCarbonSlotCatalogResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/companies/{company_id}/customers":{"get":{"summary":"Get Customers Managed By Company V2","description":"Return sites the company manages or may access.\n\nThis includes prospective Kickstarter sites.","operationId":"get-company-customers-v2","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitesListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/customers":{"post":{"summary":"Create User Customer","operationId":"post-customers-v2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserCustomerPost"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomerResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v2/customers/{customer_id}/economics":{"get":{"summary":"Get Economics For Project","description":"Get financial forecasts for the area of a project.","operationId":"get-customer-economics-v2","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"segments_version_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Segments Version Id"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"anyOf":[{"enum":["draft"],"const":"draft","type":"string"},{"enum":["intended"],"const":"intended","type":"string"},{"enum":["prepared"],"const":"prepared","type":"string"},{"enum":["rejected"],"const":"rejected","type":"string"},{"enum":["registered"],"const":"registered","type":"string"},{"enum":["submitted"],"const":"submitted","type":"string"}]}},{"type":"null"}],"default":[],"title":"Status"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFinancePlanResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Post Update Customer Economics","description":"Update this customer's economics","operationId":"post-customer-economics-v2","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/customers/{customer_id}/shapefile":{"post":{"summary":"Converter Shapefile","description":"Converts from geojson into a shapefile. This doesn't do\nany parsing or validation of the shapefile other than convert it to\nEPSG:2193\n\nProjectID is only used for internal bookkeeping/filenaming/access control","operationId":"post-customer-shapefile-v2","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShapefileConversion"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/customers/{customer_id}/tasks/invoice":{"put":{"summary":"Create Invoice Task","description":"Create invoice task and associate with a blank invoice.","operationId":"put-customer-tasks-invoice-v2","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"parent_task_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","description":"The parent task to associate this invoice with","title":"Parent Task Id"},"description":"The parent task to associate this invoice with"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v3/customers/{customer_id}/tasks/invoices":{"put":{"summary":"Create invoice and invoice task for emissions return","description":"Create invoice and invoice task for emissions return.","operationId":"put-customer-tasks-invoices-v3","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","title":"Customer Id"}},{"name":"parent_task_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"The parent task to associate this invoice with","title":"Parent Task Id"},"description":"The parent task to associate this invoice with"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInvoiceCosts"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/version":{"get":{"summary":"Version","description":"Returns information about what version of the AI service this is","operationId":"get-version","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"HTTPBearer":[]}]}},"/":{"get":{"summary":"Api Info","description":"Service infomation for root URL.","operationId":"get-","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"HTTPBearer":[]}]}},"/docs":{"get":{"summary":"Redirect To Docs","operationId":"get-docs","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"HTTPBearer":[]}]}}},"components":{"schemas":{"AdditionalSpecies":{"properties":{"species":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Species"},"percentage":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Percentage"}},"type":"object","title":"AdditionalSpecies"},"AddressAnswer":{"properties":{"name":{"type":"string","title":"Name"},"address":{"$ref":"#/components/schemas/AddressText"}},"type":"object","required":["name","address"],"title":"AddressAnswer","description":"Defines Hubspot deal owner class"},"AddressText":{"properties":{"text":{"type":"string","title":"Text"}},"type":"object","required":["text"],"title":"AddressText","description":"Defines an address structure with text"},"Ai1990SegmentationLayerProperties":{"properties":{"version_created":{"anyOf":[{"$ref":"#/components/schemas/VersionData"},{"type":"null"}]},"data_type":{"anyOf":[{"type":"string","enum":["geojson"],"const":"geojson"},{"type":"null"}],"title":"Data Type","default":"geojson"},"type":{"type":"string","enum":["ai_1990_segmentation"],"const":"ai_1990_segmentation","title":"Type"},"model_id":{"type":"string","title":"Model Id"},"imagery_source":{"$ref":"#/components/schemas/ImageryLayer"}},"additionalProperties":false,"type":"object","required":["type","model_id","imagery_source"],"title":"Ai1990SegmentationLayerProperties","description":"The 1990 segmentation layer is a set of polygons that have been\ngenerated by the AI model for determining areas which were forested in 1990."},"AiSegmentationLayerPrefectLayerProperties":{"properties":{"version_created":{"anyOf":[{"$ref":"#/components/schemas/VersionData"},{"type":"null"}]},"data_type":{"anyOf":[{"type":"string","enum":["geojson"],"const":"geojson"},{"type":"null"}],"title":"Data Type","default":"geojson"},"type":{"type":"string","enum":["ai_segmentation-prefect"],"const":"ai_segmentation-prefect","title":"Type"},"model_id":{"type":"string","title":"Model Id"},"imagery_source":{"$ref":"#/components/schemas/ImageryLayer"}},"additionalProperties":false,"type":"object","required":["type","model_id","imagery_source"],"title":"AiSegmentationLayerPrefectLayerProperties","description":"The AI segmentation layer is a set of polygons that have been\ngenerated by the AI model for determining the land cover of the\narea."},"AiSegmentationLayerProperties":{"properties":{"version_created":{"anyOf":[{"$ref":"#/components/schemas/VersionData"},{"type":"null"}]},"data_type":{"anyOf":[{"type":"string","enum":["geojson"],"const":"geojson"},{"type":"null"}],"title":"Data Type","default":"geojson"},"type":{"type":"string","enum":["ai_segmentation"],"const":"ai_segmentation","title":"Type"},"model_id":{"type":"string","title":"Model Id"},"imagery_source":{"$ref":"#/components/schemas/ImageryLayer"}},"additionalProperties":false,"type":"object","required":["type","model_id","imagery_source"],"title":"AiSegmentationLayerProperties","description":"The AI segmentation layer is a set of polygons that have been\ngenerated by the AI model for determining the land cover of the\narea."},"AllLayerProperties":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/RequestedPhotoLayerProperties"},{"$ref":"#/components/schemas/SiteBoundaryLayerProperties"},{"$ref":"#/components/schemas/SegmentsLayerProperties"},{"$ref":"#/components/schemas/SegmentsPrefectLayerProperties"},{"$ref":"#/components/schemas/AiSegmentationLayerProperties"},{"$ref":"#/components/schemas/AiSegmentationLayerPrefectLayerProperties"},{"$ref":"#/components/schemas/Ai1990SegmentationLayerProperties"},{"$ref":"#/components/schemas/ForestLossSegmentationDetailedLayerProperties"},{"$ref":"#/components/schemas/ForestLossSegmentationLayerProperties"},{"$ref":"#/components/schemas/SourceDataLayerProperties"},{"$ref":"#/components/schemas/CustomLayerProperties"},{"$ref":"#/components/schemas/MpiShapefileLayerProperties"},{"$ref":"#/components/schemas/CustomRasterCommonLayerProperties"},{"$ref":"#/components/schemas/CarbonStockVisualLayerProperties"},{"$ref":"#/components/schemas/CarbonSequestrationVisualLayerProperties"},{"$ref":"#/components/schemas/CommentPointsLayerProperties"}],"discriminator":{"propertyName":"type","mapping":{"ai_1990_segmentation":"#/components/schemas/Ai1990SegmentationLayerProperties","ai_segmentation":"#/components/schemas/AiSegmentationLayerProperties","ai_segmentation-prefect":"#/components/schemas/AiSegmentationLayerPrefectLayerProperties","carbon_sequestration":"#/components/schemas/CarbonSequestrationVisualLayerProperties","carbon_stock":"#/components/schemas/CarbonStockVisualLayerProperties","comment_points":"#/components/schemas/CommentPointsLayerProperties","custom_layer":"#/components/schemas/CustomLayerProperties","custom_raster_layer":"#/components/schemas/CustomRasterCommonLayerProperties","forest_loss_segmentation":"#/components/schemas/ForestLossSegmentationLayerProperties","forest_loss_segmentation_detailed":"#/components/schemas/ForestLossSegmentationDetailedLayerProperties","mpi_registered_shapefiles":"#/components/schemas/MpiShapefileLayerProperties","mpi_rejected_shapefiles":"#/components/schemas/MpiShapefileLayerProperties","mpi_submitted_shapefiles":"#/components/schemas/MpiShapefileLayerProperties","requested_photo_points":"#/components/schemas/RequestedPhotoLayerProperties","segments":"#/components/schemas/SegmentsLayerProperties","segments-prefect":"#/components/schemas/SegmentsPrefectLayerProperties","site_boundary":"#/components/schemas/SiteBoundaryLayerProperties","source_data":"#/components/schemas/SourceDataLayerProperties"}}},{"$ref":"#/components/schemas/NoLayerProperties"},{"$ref":"#/components/schemas/NoRasterLayerProperties"}]},"AlternativeCertification":{"properties":{"metadata":{"$ref":"#/components/schemas/AlternativeCertificationMetadata"},"carbon_stock":{"additionalProperties":{"type":"number"},"type":"object","title":"Carbon Stock"},"native":{"anyOf":[{"$ref":"#/components/schemas/CarbonStockAndArea"},{"type":"null"}],"description":"Deprecated. This field has been split into native_sequestering and native_steady_state, please use these."},"native_sequestering":{"anyOf":[{"$ref":"#/components/schemas/CarbonStockAndArea"},{"type":"null"}],"description":"All native forest whom we attribute sequestration to under the CCU."},"native_steady_state":{"anyOf":[{"$ref":"#/components/schemas/CarbonStockAndArea"},{"type":"null"}],"description":"All native forest whom we believe to be in a steady state and thus do not attribute sequestration to under the CCU."},"exotic":{"anyOf":[{"$ref":"#/components/schemas/CarbonStockAndArea"},{"type":"null"}]},"geometry_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Geometry Hash"}},"type":"object","required":["metadata","carbon_stock"],"title":"AlternativeCertification"},"AlternativeCertificationMetadata":{"properties":{"version":{"type":"string","title":"Version"},"timestamp":{"type":"string","title":"Timestamp"},"hash_v1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hash V1"},"linz_imagery_survey_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Linz Imagery Survey Id","description":"LINZ imagery survey the numbers were computed with. A negative id means no survey could be matched to the basemap and the imagery year was estimated; such numbers must not be used for issuance."}},"type":"object","required":["version","timestamp"],"title":"AlternativeCertificationMetadata"},"AnyForestEvent":{"oneOf":[{"$ref":"#/components/schemas/PlantingEvent"},{"$ref":"#/components/schemas/ClearanceEvent"}],"discriminator":{"propertyName":"event_type","mapping":{"clearance":"#/components/schemas/ClearanceEvent","planting":"#/components/schemas/PlantingEvent"}}},"AnyTask":{"oneOf":[{"$ref":"#/components/schemas/Mer2022Task"},{"$ref":"#/components/schemas/Per2023Task"},{"$ref":"#/components/schemas/Per2024Task"},{"$ref":"#/components/schemas/EmissionsReturnTask"},{"$ref":"#/components/schemas/InvoiceTask"},{"$ref":"#/components/schemas/AssessEtsEligibilityTask"},{"$ref":"#/components/schemas/CreateEtsAccountTask"},{"$ref":"#/components/schemas/RegisterLandToEtsTask"},{"$ref":"#/components/schemas/EtsRegistrationTask"},{"$ref":"#/components/schemas/TransferNzusTask"},{"$ref":"#/components/schemas/TransferNzusTaskV2"},{"$ref":"#/components/schemas/TransferEtsParticipationTask"},{"$ref":"#/components/schemas/RemoveLandFromEtsTask"},{"$ref":"#/components/schemas/CompleteKycTask"},{"$ref":"#/components/schemas/CreateHoldingAccountTask"},{"$ref":"#/components/schemas/AppointRepresentativeTask"},{"$ref":"#/components/schemas/OpenTupuakePartyTask"},{"$ref":"#/components/schemas/CollectEvidenceTask"},{"$ref":"#/components/schemas/FinaliseMappingTask"},{"$ref":"#/components/schemas/ForestDetailsConfirmationTask"},{"$ref":"#/components/schemas/FillMpiApplicationTask"},{"$ref":"#/components/schemas/SignOffTask"},{"$ref":"#/components/schemas/CollectAdvancePaymentTask"},{"$ref":"#/components/schemas/SubmitApplicationTask"},{"$ref":"#/components/schemas/UploadEvidenceTask"},{"$ref":"#/components/schemas/UpdateCaaToSubmittedTask"},{"$ref":"#/components/schemas/MpiAssessmentTask"},{"$ref":"#/components/schemas/UploadRegisteredShapefileTask"},{"$ref":"#/components/schemas/PrepareForestryRightsTask"},{"$ref":"#/components/schemas/CompleteIpcFormTask"},{"$ref":"#/components/schemas/WriteMpiEvidenceReportTask"},{"$ref":"#/components/schemas/CollectPhotosUsingFieldscanTask"},{"$ref":"#/components/schemas/TreeWeedCalculatorTask"},{"$ref":"#/components/schemas/RmaComplianceTask"},{"$ref":"#/components/schemas/WriteElfReportTask"},{"$ref":"#/components/schemas/Pre2007DeforestationReportTask"},{"$ref":"#/components/schemas/LandUseChangeReportTask"},{"$ref":"#/components/schemas/WriteSpecificEventReportTask"},{"$ref":"#/components/schemas/CustomTask"},{"$ref":"#/components/schemas/LandTransitionTask"}],"discriminator":{"propertyName":"task_type","mapping":{"appoint_representative":"#/components/schemas/AppointRepresentativeTask","assess_ets_eligibility":"#/components/schemas/AssessEtsEligibilityTask","collect_advance_payment":"#/components/schemas/CollectAdvancePaymentTask","collect_evidence":"#/components/schemas/CollectEvidenceTask","collect_photos_using_fieldscan":"#/components/schemas/CollectPhotosUsingFieldscanTask","complete_ipc_form":"#/components/schemas/CompleteIpcFormTask","complete_kyc":"#/components/schemas/CompleteKycTask","create_ets_account":"#/components/schemas/CreateEtsAccountTask","create_holding_account":"#/components/schemas/CreateHoldingAccountTask","custom_task":"#/components/schemas/CustomTask","emissions_return":"#/components/schemas/EmissionsReturnTask","fill_mpi_application":"#/components/schemas/FillMpiApplicationTask","finalise_mapping":"#/components/schemas/FinaliseMappingTask","forest_details_confirmation":"#/components/schemas/ForestDetailsConfirmationTask","invoice":"#/components/schemas/InvoiceTask","land_transition":"#/components/schemas/LandTransitionTask","land_use_change_report":"#/components/schemas/LandUseChangeReportTask","mer.2022":"#/components/schemas/Mer2022Task","mpi_assessment":"#/components/schemas/MpiAssessmentTask","open_tupuake_party":"#/components/schemas/OpenTupuakePartyTask","per":"#/components/schemas/Per2023Task","per.2024":"#/components/schemas/Per2024Task","pre_2007_deforestation_report":"#/components/schemas/Pre2007DeforestationReportTask","prepare_forestry_rights":"#/components/schemas/PrepareForestryRightsTask","register_land_to_ets":"#/components/schemas/RegisterLandToEtsTask","register_land_to_ets_v2":"#/components/schemas/EtsRegistrationTask","remove_land_from_ets":"#/components/schemas/RemoveLandFromEtsTask","rma_compliance":"#/components/schemas/RmaComplianceTask","sign_off":"#/components/schemas/SignOffTask","submit_application":"#/components/schemas/SubmitApplicationTask","transfer_ets_participation":"#/components/schemas/TransferEtsParticipationTask","transfer_nzus":"#/components/schemas/TransferNzusTask","transfer_nzus_v2":"#/components/schemas/TransferNzusTaskV2","tree_weed_calculator":"#/components/schemas/TreeWeedCalculatorTask","update_caa_to_submitted":"#/components/schemas/UpdateCaaToSubmittedTask","upload_evidence":"#/components/schemas/UploadEvidenceTask","upload_registered_shapefile":"#/components/schemas/UploadRegisteredShapefileTask","write_elf_report":"#/components/schemas/WriteElfReportTask","write_mpi_evidence_report":"#/components/schemas/WriteMpiEvidenceReportTask","write_specific_event_report":"#/components/schemas/WriteSpecificEventReportTask"}}},"AppointRepresentativeProperties":{"properties":{"comments":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/Comment"},{"type":"string"}]},"type":"array"},{"type":"null"}],"title":"Comments"},"parent_task_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Parent Task Id"},"sub_task_index":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Sub Task Index"},"send_for_signature":{"anyOf":[{"$ref":"#/components/schemas/StepComplete"},{"type":"null"}]},"submit_signed":{"anyOf":[{"$ref":"#/components/schemas/StepComplete"},{"type":"null"}]}},"type":"object","title":"AppointRepresentativeProperties"},"AppointRepresentativeTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"task_type":{"type":"string","enum":["appoint_representative"],"const":"appoint_representative","title":"Task Type"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/AppointRepresentativeProperties"},{"type":"null"}]}},"type":"object","required":["uuid","customer_id","task_type","status"],"title":"AppointRepresentativeTask"},"AssessEtsEligibilityTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericNotesTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["assess_ets_eligibility"],"const":"assess_ets_eligibility","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"AssessEtsEligibilityTask"},"AsyncLocalPdfJobResponse":{"properties":{"data":{"$ref":"#/components/schemas/JobData"}},"type":"object","required":["data"],"title":"AsyncLocalPdfJobResponse"},"AuthFeature":{"type":"string","enum":["ccu:edit","ccu:shapefile:view","site:edit","site:view","photos_uploader","admin_all_companies","invoice:edit","task:view","task:edit","task:transfer_nzu","gdrive:edit","site:edit_properties","site:nzetr:view","redis:test","kickstarter:view","copilot:chat","users:edit","users:view","site:tasks:input_task:edit","site:tasks:input_task:input","site:tasks:input_task:view","company:layers:edit","company:layers:view","company:properties:edit","company:properties:view","company:sites:create","company:sites:view","company:site_relationship_data:view","company:site_relationship_data:edit","company:voluntary_carbon_projects:view","company:voluntary_carbon_projects:edit","company:tasks:view","company:users:edit","company:users:view"],"title":"AuthFeature"},"Author":{"properties":{"full_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Name"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"}},"type":"object","title":"Author"},"AvailableImageryResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/ImageryLayer"},"type":"array","title":"Layers","description":"Imagery layers found by the providers that completed successfully."},"errors":{"items":{"type":"string"},"type":"array","title":"Errors","description":"Provider failures encountered during the search. When non-empty, layers contains a partial result and may not include all available imagery."}},"type":"object","required":["layers","errors"],"title":"AvailableImageryResponse","description":"Results from searching multiple imagery providers for a region of interest."},"BalanceForwardResponse":{"properties":{"customer_id":{"type":"integer","title":"Customer Id"},"balance_forward":{"type":"string","title":"Balance Forward","examples":["1","0.0","NaN"]}},"type":"object","required":["customer_id","balance_forward"],"title":"BalanceForwardResponse","description":"Response data module for balance forward query."},"BallotStatusType":{"type":"string","enum":["intended","entered","approved"],"title":"BallotStatusType","description":"Types of ballot status."},"BaseModel":{"properties":{},"type":"object","title":"BaseModel"},"BlockEconomics":{"properties":{"area":{"type":"number","title":"Area"},"credit_sales":{"additionalProperties":{"type":"number"},"type":"object","title":"Credit Sales"},"yields":{"additionalProperties":{"type":"integer"},"type":"object","title":"Yields"},"start_year":{"type":"integer","title":"Start Year"},"mpi_fees":{"additionalProperties":{"type":"number"},"type":"object","title":"Mpi Fees"}},"type":"object","required":["area","credit_sales","yields","start_year","mpi_fees"],"title":"BlockEconomics","description":"The data given to the frontend containing the financial data\nfor a single feature/block"},"Body_post-customer-gdrive":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"}},"type":"object","required":["file"],"title":"Body_post-customer-gdrive"},"Body_post-customer-photos-taken":{"properties":{"img_files":{"items":{"type":"string","contentMediaType":"application/octet-stream"},"type":"array","title":"Img Files"}},"type":"object","required":["img_files"],"title":"Body_post-customer-photos-taken"},"Body_put-company-properties-participant_specific_table-xls":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"}},"type":"object","required":["file"],"title":"Body_put-company-properties-participant_specific_table-xls"},"BoundaryOverviewProperties":{"properties":{"customer_id":{"type":"integer","title":"Customer Id"},"company_customer_tag":{"$ref":"#/components/schemas/CompanyCustomerTags"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"}},"type":"object","required":["customer_id","company_customer_tag"],"title":"BoundaryOverviewProperties"},"CacheResponse":{"properties":{"status":{"type":"string","title":"Status"},"message":{"type":"string","title":"Message"}},"type":"object","required":["status","message"],"title":"CacheResponse"},"CacheRetrieveResponse":{"properties":{"key":{"type":"string","title":"Key"},"value":{"type":"string","title":"Value"}},"type":"object","required":["key","value"],"title":"CacheRetrieveResponse"},"CalculatedPayment":{"properties":{"balance_brought_forward":{"type":"string","title":"Balance Brought Forward","examples":["1","0.0","NaN"]},"total_payable":{"type":"string","title":"Total Payable","examples":["1","0.0","NaN"]},"total_paid_now_in_nzu":{"type":"string","title":"Total Paid Now In Nzu","examples":["1","0.0","NaN"]},"total_paid_now_in_nzd":{"type":"string","title":"Total Paid Now In Nzd","examples":["1","0.0","NaN"]},"balance_carried_forward":{"type":"string","title":"Balance Carried Forward","examples":["1","0.0","NaN"]}},"type":"object","required":["balance_brought_forward","total_payable","total_paid_now_in_nzu","total_paid_now_in_nzd","balance_carried_forward"],"title":"CalculatedPayment","description":"Calculation result for payment."},"CalculatedServiceFee":{"properties":{"gross_yield":{"type":"string","title":"Gross Yield","examples":["1","0.0","NaN"]},"costs_ex_tax":{"type":"string","title":"Costs Ex Tax","examples":["1","0.0","NaN"]},"gross_yield_net_costs":{"type":"string","title":"Gross Yield Net Costs","examples":["1","0.0","NaN"]},"service_fee_ex_tax":{"type":"string","title":"Service Fee Ex Tax","examples":["1","0.0","NaN"]},"min_service_fee_gap_ex_tax":{"anyOf":[{"type":"string","examples":["1","0.0","NaN"]},{"type":"null"}],"title":"Min Service Fee Gap Ex Tax"}},"type":"object","required":["gross_yield","costs_ex_tax","gross_yield_net_costs","service_fee_ex_tax"],"title":"CalculatedServiceFee","description":"Internal data during service fee calculation."},"CarbonCropShare":{"properties":{"calculated":{"type":"number","title":"Calculated"},"manual_override":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Manual Override"}},"type":"object","required":["calculated"],"title":"CarbonCropShare","description":"Data model representing what share carboncrop will get - both calculated and\noverridden values are available"},"CarbonManagementAgreement":{"properties":{"contract_length":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Contract Length"},"company_share_proportion":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Company Share Proportion"}},"type":"object","title":"CarbonManagementAgreement","description":"The carbon manager is the company that has the \"carbon manager\" tagged association with the site. This object defines the terms of that agreement."},"CarbonManagementAgreementWithStartYear":{"properties":{"contract_length":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Contract Length"},"company_share_proportion":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Company Share Proportion"},"contract_start_year":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contract Start Year"}},"type":"object","title":"CarbonManagementAgreementWithStartYear","description":"The carbon manager is the company that has the \"carbon manager\" tagged association with the site. This object defines the terms of that agreement."},"CarbonPriceConfig":{"properties":{"curves":{"additionalProperties":{"$ref":"#/components/schemas/CarbonPriceCurve"},"type":"object","title":"Curves","description":"Available custom carbon price curves."},"scheme_curves":{"additionalProperties":{"type":"string","format":"uuid"},"type":"object","title":"Scheme Curves","description":"Custom price curve assigned to each credit scheme."}},"type":"object","title":"CarbonPriceConfig","description":"Company carbon price curves and their credit scheme assignments."},"CarbonPriceCurve":{"properties":{"file_name":{"type":"string","title":"File Name","description":"Name of the uploaded file."},"uploaded_by":{"allOf":[{"$ref":"#/components/schemas/User"}],"description":"User who uploaded the estimates."},"date_uploaded":{"type":"string","format":"date-time","title":"Date Uploaded","description":"Date and time when the estimates were uploaded."},"enabled":{"type":"boolean","title":"Enabled","description":"Whether these estimates override the system default carbon prices."},"start_year":{"type":"integer","title":"Start Year","description":"First calendar year represented by values."},"values":{"items":{"type":"number"},"type":"array","title":"Values","description":"Annual price estimates, in NZD per carbon unit, for sequential years beginning with start_year."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"User-facing name for this carbon price curve."}},"type":"object","required":["file_name","uploaded_by","date_uploaded","enabled","start_year","values"],"title":"CarbonPriceCurve","description":"A named carbon price curve that can be assigned to credit schemes."},"CarbonPrices":{"properties":{"expected":{"additionalProperties":{"type":"number"},"type":"object","title":"Expected"},"conservative":{"additionalProperties":{"type":"number"},"type":"object","title":"Conservative"},"optimistic":{"additionalProperties":{"type":"number"},"type":"object","title":"Optimistic"}},"type":"object","required":["expected","conservative","optimistic"],"title":"CarbonPrices","description":"Predictions of the carbon price. This is the prediction for the carbon price at\nthe start of the relevant year."},"CarbonSequestrationVisualLayerProperties":{"properties":{"version_created":{"anyOf":[{"$ref":"#/components/schemas/VersionData"},{"type":"null"}]},"data_type":{"type":"string","enum":["raster"],"const":"raster","title":"Data Type"},"max_zoom":{"type":"integer","title":"Max Zoom"},"tile_url":{"type":"string","title":"Tile Url"},"type":{"type":"string","enum":["carbon_sequestration"],"const":"carbon_sequestration","title":"Type"},"units":{"type":"string","enum":["tCO2e/ha/y"],"const":"tCO2e/ha/y","title":"Units"},"code_version":{"type":"string","title":"Code Version"},"year_of_visual":{"type":"integer","title":"Year Of Visual"},"imagery_source":{"$ref":"#/components/schemas/ImageryLayer"},"data_range":{"$ref":"#/components/schemas/Range"},"species_dict":{"additionalProperties":{"type":"integer"},"type":"object","title":"Species Dict"}},"additionalProperties":false,"type":"object","required":["data_type","max_zoom","tile_url","type","units","code_version","year_of_visual","imagery_source","data_range","species_dict"],"title":"CarbonSequestrationVisualLayerProperties","description":"How fast is this forest absorbing carbon?\n\nThis layer is generated by CarbonCrop and is used for CCU's"},"CarbonStockAndArea":{"properties":{"carbon_stock":{"additionalProperties":{"type":"number"},"type":"object","title":"Carbon Stock"},"area_ha":{"type":"number","title":"Area Ha"}},"type":"object","required":["carbon_stock","area_ha"],"title":"CarbonStockAndArea"},"CarbonStockVisualLayerProperties":{"properties":{"version_created":{"anyOf":[{"$ref":"#/components/schemas/VersionData"},{"type":"null"}]},"data_type":{"type":"string","enum":["raster"],"const":"raster","title":"Data Type"},"max_zoom":{"type":"integer","title":"Max Zoom"},"tile_url":{"type":"string","title":"Tile Url"},"type":{"type":"string","enum":["carbon_stock"],"const":"carbon_stock","title":"Type"},"units":{"type":"string","enum":["tCO2e/ha"],"const":"tCO2e/ha","title":"Units"},"code_version":{"type":"string","title":"Code Version"},"year_of_visual":{"type":"integer","title":"Year Of Visual"},"imagery_source":{"$ref":"#/components/schemas/ImageryLayer"},"data_range":{"$ref":"#/components/schemas/Range"},"species_dict":{"additionalProperties":{"type":"integer"},"type":"object","title":"Species Dict"}},"additionalProperties":false,"type":"object","required":["data_type","max_zoom","tile_url","type","units","code_version","year_of_visual","imagery_source","data_range","species_dict"],"title":"CarbonStockVisualLayerProperties","description":"Represents the carbon stock stored in the forest.\n\nThis layer is generated by CarbonCrop, and is used for CCU's"},"Carbon_Scheme_Stage":{"type":"string","enum":["already_committed","actively_investigating","curious"],"title":"Carbon_Scheme_Stage"},"Cashflows":{"properties":{"total_sale_potential":{"additionalProperties":{"$ref":"#/components/schemas/CreditSalePotential"},"type":"object","title":"Total Sale Potential"}},"type":"object","required":["total_sale_potential"],"title":"Cashflows","description":"Prediction of sales for different categories of land"},"CcuLocation":{"properties":{"lat":{"type":"number","title":"Lat","description":"Latitude of the CTR centroid in decimal degrees."},"lon":{"type":"number","title":"Lon","description":"Longitude of the CTR centroid in decimal degrees."}},"type":"object","required":["lat","lon"],"title":"CcuLocation","description":"The centroid of a Carbon Tracking Region, expressed in WGS84 coordinates."},"CcuTrace":{"properties":{"token_type":{"type":"string","title":"Token Type","description":"Type of carbon unit. Eg Native CarbonCropUnit"},"issuer":{"type":"string","title":"Issuer","description":"Organisation that created the CCU."},"sequestration_year":{"type":"string","title":"Sequestration Year","description":"Four-digit year in which the carbon was sequestered, such as \"2022\"."},"sequestration_type":{"type":"string","title":"Sequestration Type","description":"Type of sequestration represented by the CCU. Eg NZNativeForest"},"location":{"allOf":[{"$ref":"#/components/schemas/CcuLocation"}],"description":"Centroid of the originating CTR."},"time_of_issue":{"type":"string","format":"date-time","title":"Time Of Issue","description":"Date and time when the CCU was created."},"registry":{"type":"string","title":"Registry","description":"Carbon registry or marketplace currently responsible for trading the CCU. This can change when the CCU is transferred."},"token_id":{"type":"integer","title":"Token Id","description":"Unique identifier of the CCU."},"polygon_id":{"type":"integer","title":"Polygon Id","description":"Unique registry identifier of the originating Carbon Tracking Region (CTR)."}},"type":"object","required":["token_type","issuer","sequestration_year","sequestration_type","location","time_of_issue","registry","token_id","polygon_id"],"title":"CcuTrace","description":"A CCU represents one tonne of carbon sequestered by native forest, based on\nsquare-metre-level estimates within a Carbon Tracking Region (CTR). CCUs are\nlinked to their originating CTR and are not fungible: equal quantities from\ndifferent CTRs are not necessarily interchangeable or equal in value. They\ncan be traded as voluntary carbon credits or used for insetting."},"ChangeCarbonManagerRequest":{"properties":{"company_id":{"type":"integer","title":"Company Id","description":"Unique identifier of the company to assign."}},"type":"object","required":["company_id"],"title":"ChangeCarbonManagerRequest","description":"Company to assign the relationship tag identified in the request path."},"ChatRequest":{"properties":{"user_input":{"type":"string","title":"User Input"},"customer_id":{"type":"integer","title":"Customer Id"}},"type":"object","required":["user_input","customer_id"],"title":"ChatRequest"},"CircleLayer":{"properties":{"type":{"type":"string","enum":["circle"],"const":"circle","title":"Type"},"filter":{"anyOf":[{"prefixItems":[{"type":"string","enum":["=="],"const":"=="},{"prefixItems":[{"type":"string","enum":["get"],"const":"get"},{"type":"string"}],"type":"array","maxItems":2,"minItems":2},{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"}]}],"type":"array","maxItems":3,"minItems":3},{"type":"null"}],"title":"Filter"},"paint":{"anyOf":[{"$ref":"#/components/schemas/CirclePaint"},{"type":"null"}]}},"type":"object","required":["type"],"title":"CircleLayer","description":"A circle style layer, used for point geometry."},"CirclePaint":{"properties":{"circle-color":{"type":"string","title":"Circle-Color"}},"type":"object","required":["circle-color"],"title":"CirclePaint","description":"Paint properties for a circle layer."},"ClearanceEvent":{"properties":{"event_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Event Id"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"event_type":{"type":"string","enum":["clearance"],"const":"clearance","title":"Event Type"},"clearance_method":{"anyOf":[{"type":"string","enum":["clearance_harvest"],"const":"clearance_harvest"},{"type":"string","enum":["adverse_event"],"const":"adverse_event"},{"type":"null"}],"title":"Clearance Method"}},"type":"object","required":["event_type"],"title":"ClearanceEvent"},"CollectAdvancePaymentTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["collect_advance_payment"],"const":"collect_advance_payment","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"CollectAdvancePaymentTask"},"CollectEvidenceTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["collect_evidence"],"const":"collect_evidence","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"CollectEvidenceTask"},"CollectPhotosUsingFieldscanTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["collect_photos_using_fieldscan"],"const":"collect_photos_using_fieldscan","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"CollectPhotosUsingFieldscanTask"},"Comment":{"properties":{"text":{"type":"string","title":"Text"},"author":{"$ref":"#/components/schemas/Author"},"timestamp":{"type":"string","title":"Timestamp"},"edit_timestamp":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Edit Timestamp"},"deleted":{"type":"boolean","title":"Deleted","default":false}},"type":"object","required":["text","author","timestamp"],"title":"Comment"},"CommentPointProperties":{"properties":{"comments":{"anyOf":[{"items":{"$ref":"#/components/schemas/Comment"},"type":"array"},{"type":"null"}],"title":"Comments"},"resolved":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Resolved"}},"type":"object","title":"CommentPointProperties","description":"Properties for a comment point, including user information and comment text."},"CommentPointsLayerProperties":{"properties":{"version_created":{"anyOf":[{"$ref":"#/components/schemas/VersionData"},{"type":"null"}]},"data_type":{"anyOf":[{"type":"string","enum":["geojson"],"const":"geojson"},{"type":"null"}],"title":"Data Type","default":"geojson"},"type":{"type":"string","enum":["comment_points"],"const":"comment_points","title":"Type"}},"additionalProperties":false,"type":"object","required":["type"],"title":"CommentPointsLayerProperties","description":"The comment points layer is used to store user comments on the map."},"CommonGeoJsonProperties":{"properties":{"model_s3_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model S3 Key"},"class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Class"},"class_labels":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Class Labels"},"credit_scheme":{"anyOf":[{"$ref":"#/components/schemas/CreditSchemeType"},{"type":"null"}],"description":"The credit scheme that this feature is registered under. If no value is provided, it should be interpreted as being the same value as \"ets\" "},"locked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Locked","description":"If the polygon attributes update is locked."},"status":{"anyOf":[{"type":"string","enum":["draft"],"const":"draft"},{"type":"string","enum":["intended"],"const":"intended"},{"type":"string","enum":["prepared"],"const":"prepared"},{"type":"string","enum":["rejected"],"const":"rejected"},{"type":"string","enum":["registered"],"const":"registered"},{"type":"string","enum":["submitted"],"const":"submitted"},{"type":"null"}],"title":"Status","description":"What is the registration lifecycle stage of this polygon."},"status_1990":{"anyOf":[{"$ref":"#/components/schemas/ForestStatus1990Type"},{"type":"null"}],"description":"Was this land forest on the 1st of January 1990."},"report_category":{"anyOf":[{"type":"string","enum":["existing_indigenous_ets_forest"],"const":"existing_indigenous_ets_forest"},{"type":"string","enum":["future_native_planting"],"const":"future_native_planting"},{"type":"string","enum":["existing_exotic_ets_forest"],"const":"existing_exotic_ets_forest"},{"type":"string","enum":["future_exotic_planting"],"const":"future_exotic_planting"},{"type":"string","enum":["potential_ets_forest"],"const":"potential_ets_forest"},{"type":"string","enum":["scattered_forest"],"const":"scattered_forest"},{"type":"string","enum":["native_carboncrop"],"const":"native_carboncrop"},{"type":"string","enum":["pre_1990_forest"],"const":"pre_1990_forest"},{"type":"string","enum":["other_vegetation"],"const":"other_vegetation"},{"type":"string","enum":["pasture"],"const":"pasture"},{"type":"string","enum":["unassessed_native_forest"],"const":"unassessed_native_forest"},{"type":"string","enum":["unassessed_exotic_forest"],"const":"unassessed_exotic_forest"},{"type":"string","enum":["unassessed_scrub"],"const":"unassessed_scrub"},{"type":"string","enum":["scrub"],"const":"scrub"},{"type":"string","enum":["excluded"],"const":"excluded"},{"type":"string","enum":["unassessed"],"const":"unassessed"},{"type":"null"}],"title":"Report Category","description":"High level description of this forest."},"report_category_source":{"anyOf":[{"type":"string","enum":["auto"],"const":"auto"},{"type":"string","enum":["manual"],"const":"manual"},{"type":"null"}],"title":"Report Category Source","description":"Indicates whether the report_category was derived automatically or set manually by the user."},"land_activity_type":{"anyOf":[{"type":"string","enum":["land_owner"],"const":"land_owner"},{"type":"string","enum":["holder_of_lease"],"const":"holder_of_lease"},{"type":"string","enum":["crown_conservation"],"const":"crown_conservation"},{"type":"null"}],"title":"Land Activity Type","description":"What is the rights between the person applying for the ETS registration and this unit of land.\nNote: you can only assign one value per carbon accounting area (CAA). If there are four polygons in one CAA, all four of the polygons must have the same type of ownership."},"lease_expiry_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lease Expiry Date","description":"ISO-8601 date for the expiry of a registered forestry right or lease over the land."},"lease_expires_next_harvest":{"anyOf":[{"type":"string","enum":["yes"],"const":"yes"},{"type":"string","enum":["no"],"const":"no"},{"type":"string","enum":["not_applicable"],"const":"not_applicable"},{"type":"null"}],"title":"Lease Expires Next Harvest","description":"This field shows if a registered forestry right or lease expires at the next harvest."},"is_grant_fund_recieved":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Grant Fund Recieved","description":"Whether the grant funding has been received."},"grant_fund_expiry_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grant Fund Expiry Date","description":"ISO-8601 date that a grant provided by the government expires. The date can be in the past or future."},"is_excluded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Excluded"},"alternative_certification":{"anyOf":[{"$ref":"#/components/schemas/AlternativeCertification"},{"type":"null"}]},"financial_start_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Financial Start Year"},"ets_caa_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Ets Caa Number"},"descriptor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Descriptor"},"emissions_returns":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/PendingCAAReturn"},{"$ref":"#/components/schemas/FiledCAAReturn"}]},"type":"array"},{"type":"null"}],"title":"Emissions Returns"},"forest_events":{"anyOf":[{"items":{"$ref":"#/components/schemas/AnyForestEvent"},"type":"array"},{"type":"null"}],"title":"Forest Events"},"comments":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/Comment"},{"type":"string"}]},"type":"array"},{"type":"null"}],"title":"Comments"},"is_ets_registered":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Ets Registered"},"mature_height_meters":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Mature Height Meters"},"mature_canopy_cover_proportion":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Mature Canopy Cover Proportion"},"mpi_report":{"anyOf":[{"$ref":"#/components/schemas/MpiReportProperties"},{"type":"null"}]},"width_override":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Width Override","description":"Typically the width of the polygon is automatically calculated, but this can be overridden because width is not a mathematical property of a polygon"},"ets_registration":{"anyOf":[{"$ref":"#/components/schemas/EtsRegistrationDetails"},{"type":"null"}]},"ets_luc_class_restrictions":{"anyOf":[{"$ref":"#/components/schemas/LandUseCapabilityClassRestrictions"},{"type":"null"}]},"ineligible_reasons":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"},{"type":"null"}],"title":"Ineligible Reasons"},"id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Id"},"canopy_cover":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Canopy Cover","description":"The canopy cover of the forest at maturity. This is a number between 0 and 1"},"recently_cleared":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Recently Cleared","deprecated":true},"recently_planted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Recently Planted","deprecated":true},"species":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Species","deprecated":true},"establishment_method":{"anyOf":[{"$ref":"#/components/schemas/EstablishmentMethod"},{"type":"null"}],"description":"The method used to establish the forest","deprecated":true},"stem_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Stem Count","description":"The number of stems that were planted. THis is only required for some species","deprecated":true},"ets_species":{"anyOf":[{"type":"string","enum":["douglas_fir"],"const":"douglas_fir"},{"type":"string","enum":["exotic_hardwood"],"const":"exotic_hardwood"},{"type":"string","enum":["exotic_softwood"],"const":"exotic_softwood"},{"type":"string","enum":["indigenous"],"const":"indigenous"},{"type":"string","enum":["pinus_radiata"],"const":"pinus_radiata"},{"type":"string","enum":["radiata"],"const":"radiata"},{"type":"null"}],"title":"Ets Species","description":"Species according to MPI's ETS species list","deprecated":true},"planting_status":{"anyOf":[{"type":"string","enum":["draft","confirmed","planted"]},{"type":"null"}],"title":"Planting Status","description":"What is the lifecycle stage of future planting.","deprecated":true},"established_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Established Date","description":"ISO-8601 date of when the trees were established","deprecated":true},"species_percentage":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Species Percentage","deprecated":true},"additional_species":{"anyOf":[{"items":{"$ref":"#/components/schemas/AdditionalSpecies"},"type":"array"},{"type":"null"}],"title":"Additional Species","deprecated":true},"plants_per_hectare":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Plants Per Hectare","deprecated":true},"plants_spacing_width":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Plants Spacing Width","deprecated":true},"plants_spacing_length":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Plants Spacing Length","deprecated":true},"establishment_cost_per_hectare":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Establishment Cost Per Hectare","deprecated":true},"previous_stem_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Previous Stem Count","deprecated":true},"previous_deforestation_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous Deforestation Date","deprecated":true},"previous_established_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous Established Date","deprecated":true},"previous_ets_species":{"anyOf":[{"type":"string","enum":["douglas_fir"],"const":"douglas_fir"},{"type":"string","enum":["exotic_hardwood"],"const":"exotic_hardwood"},{"type":"string","enum":["exotic_softwood"],"const":"exotic_softwood"},{"type":"string","enum":["indigenous"],"const":"indigenous"},{"type":"string","enum":["pinus_radiata"],"const":"pinus_radiata"},{"type":"string","enum":["radiata"],"const":"radiata"},{"type":"null"}],"title":"Previous Ets Species","deprecated":true},"previous_establishment_method":{"anyOf":[{"$ref":"#/components/schemas/EstablishmentMethod"},{"type":"null"}],"deprecated":true},"previous_species":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous Species","deprecated":true},"clearance_method":{"anyOf":[{"type":"string","enum":["clearance_harvest"],"const":"clearance_harvest"},{"type":"string","enum":["adverse_event"],"const":"adverse_event"},{"type":"null"}],"title":"Clearance Method","description":"The method used to clear the land","deprecated":true}},"type":"object","title":"CommonGeoJsonProperties","description":"The segments that are used for polygons used for reports"},"CompanyAndTag":{"properties":{"company_id":{"type":"integer","title":"Company Id","description":"Unique identifier of the company."},"tag":{"allOf":[{"$ref":"#/components/schemas/CompanyCustomerTags"}],"description":"Company's relationship tag for the site."}},"type":"object","required":["company_id","tag"],"title":"CompanyAndTag","description":"A company and one relationship tag assigned to it for a site."},"CompanyBranding":{"properties":{"header_color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Header Color","description":"CSS colour used for prominent branded elements such as headers."},"header_text_color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Header Text Color","description":"CSS colour used for text displayed on the header colour."},"logo_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Logo Url","description":"URL of the company logo shown in the platform and generated material."}},"type":"object","title":"CompanyBranding","description":"The company's visual identity in the platform and generated material."},"CompanyContact":{"properties":{"email_sender":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Sender","description":"Sender address for email sent on the company's behalf.","deprecated":true},"email_support":{"anyOf":[{"$ref":"#/components/schemas/NamedEmail"},{"type":"null"}],"description":"Reply-to contact attached to email sent on the company's behalf."}},"type":"object","title":"CompanyContact","description":"Contact details used when CarbonCrop communicates on a company's behalf."},"CompanyCustomerRelationshipData":{"properties":{"tags":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Tags","description":"Tags used to describe and filter the company's sites. For example, they may record river catchments or CRM states."}},"type":"object","required":["tags"],"title":"CompanyCustomerRelationshipData","description":"Company-specific data associated with a site. A site may be accessible to multiple companies,\nwhile some information should remain visible only to the company that owns it."},"CompanyCustomerTags":{"type":"string","enum":["carbon_manager","legal_owner","viewer","kickstarter_manager"],"title":"CompanyCustomerTags","description":"Tags describing the relationships between companies and a site.\n\nA site may have several relationship tags concurrently, assigned to the same or\ndifferent companies."},"CompanyEtsRegistrant":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Legal name of the registrant"},"etr_number":{"anyOf":[{"type":"string","pattern":"NZ-[\\d]+"},{"type":"null"}],"title":"Etr Number","description":"Emissions Trading Register account number, beginning with 'NZ-'."}},"type":"object","title":"CompanyEtsRegistrant","description":"A person or organisation registered in the New Zealand Emissions Trading Registar (ETR)\nhttps://www.emissionsregister.govt.nz/"},"CompanyLayerListModel":{"properties":{"company_id":{"type":"integer","title":"Company Id"},"layers":{"items":{"$ref":"#/components/schemas/LayerModel_Annotated_Union_CustomLayerProperties__CustomRasterCommonLayerProperties___FieldInfo_annotation_NoneType__required_True__discriminator__type____"},"type":"array","title":"Layers","description":"The latest version metadata for each layer."}},"type":"object","required":["company_id","layers"],"title":"CompanyLayerListModel","description":"The GIS layers available on maps viewed in a company's context."},"CompanyLayerVersionListModel":{"properties":{"company_id":{"type":"integer","title":"Company Id"},"layer_id":{"type":"integer","title":"Layer Id"},"version_list":{"items":{"$ref":"#/components/schemas/VersionModel_Annotated_Union_CustomLayerProperties__CustomRasterCommonLayerProperties___FieldInfo_annotation_NoneType__required_True__discriminator__type____"},"type":"array","title":"Version List","description":"Stored versions, ordered by version ID."}},"type":"object","required":["company_id","layer_id","version_list"],"title":"CompanyLayerVersionListModel","description":"The version history of a company-owned GIS layer."},"CompanyNotificationSettings":{"properties":{"slack_channel_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slack Channel Id","description":"Slack channel ID to send notifications to. Normally starts with a C, eg: 'C1234567890'."}},"type":"object","title":"CompanyNotificationSettings","description":"Destinations for notifications about activity associated with a company."},"CompanyProperties":{"properties":{"display_name":{"type":"string","title":"Display Name","description":"User-facing name used for the company."},"branding":{"anyOf":[{"$ref":"#/components/schemas/CompanyBranding"},{"type":"null"}],"description":"Visual identity used for reports sent by this company."},"reports":{"anyOf":[{"$ref":"#/components/schemas/CompanyReports"},{"type":"null"}],"description":"Reports that are available to users."},"company_contact":{"anyOf":[{"$ref":"#/components/schemas/CompanyContact"},{"type":"null"}],"description":"Contact details used for communication sent on the company's behalf."},"per_configuration":{"anyOf":[{"$ref":"#/components/schemas/PerDisplayConfig"},{"type":"null"}],"description":"Configuration for filing Provisional Emissions Returns (PER) on behalf of the company's sites."},"nzu_price":{"anyOf":[{"$ref":"#/components/schemas/NZUPrice"},{"type":"null"}],"description":"Deprecated custom NZU price forecast. Use carbon_prices instead.","deprecated":true},"carbon_prices":{"anyOf":[{"$ref":"#/components/schemas/CarbonPriceConfig"},{"type":"null"}],"description":"Carbon price curves and the credit schemes that use them."},"invoice_config":{"anyOf":[{"$ref":"#/components/schemas/InvoiceConfig"},{"type":"null"}],"description":"Configuration for invoices created for the company's sites."},"notifications":{"anyOf":[{"$ref":"#/components/schemas/CompanyNotificationSettings"},{"type":"null"}],"description":"Configuration for company-wide notifications"},"default_carbon_management_agreement":{"anyOf":[{"$ref":"#/components/schemas/CarbonManagementAgreement"},{"type":"null"}],"description":"Carbon management agreement used for new sites created by the company. Later changes do not affect existing site agreements."},"service_fee_before_deductions":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Service Fee Before Deductions","description":"Whether the company's service fee is calculated from gross revenue before costs are deducted."},"participant_specific_table":{"anyOf":[{"$ref":"#/components/schemas/ParticipantSpecificTable"},{"type":"null"}],"description":"Participant Specific Table associated with the company's ETS registrant. Generally expected when the registrant has 100 hectares or more of post-1989 forest land."},"min_service_fee":{"anyOf":[{"$ref":"#/components/schemas/EnableableValue_float_"},{"type":"null"}],"description":"Minimum service fee, in NZD, charged to the company's customers."},"ets_registrant":{"anyOf":[{"$ref":"#/components/schemas/CompanyEtsRegistrant"},{"type":"null"}],"description":"ETS participant whose holding account applies to sites for which this company is the legal owner."},"on_site_create":{"anyOf":[{"$ref":"#/components/schemas/SiteCreateActions"},{"type":"null"}],"description":"Automated actions performed when a site is created for the company.","default":{"trigger_unity_flow":true}},"on_task_create":{"anyOf":[{"$ref":"#/components/schemas/TaskCreateActions"},{"type":"null"}],"description":"Task types that users may create for the company's sites."},"customer_relationship_metadata":{"anyOf":[{"$ref":"#/components/schemas/CustomerRelationshipMetadata"},{"type":"null"}],"description":"Configuration of site-specific metadata"}},"type":"object","required":["display_name"],"title":"CompanyProperties","description":"Properties belonging to a company in the CarbonCrop platform."},"CompanyPropertiesResponse":{"properties":{"company_id":{"type":"integer","title":"Company Id"},"key":{"type":"string","title":"Key"},"properties":{"anyOf":[{"$ref":"#/components/schemas/CompanyProperties"},{"type":"null"}]}},"type":"object","required":["company_id","key"],"title":"CompanyPropertiesResponse"},"CompanyReports":{"properties":{"tamata_eligibility_report":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Tamata Eligibility Report","description":"Whether Tāmata-specific reports are available. Intended only for the Tāmata company."}},"type":"object","title":"CompanyReports","description":"Availability of company-specific reports."},"CompanyResponse":{"properties":{"company_id":{"type":"integer","title":"Company Id"},"key":{"type":"string","title":"Key"}},"type":"object","required":["company_id","key"],"title":"CompanyResponse"},"CompanyUserResponse":{"properties":{"user_id":{"type":"integer","title":"User Id"},"email":{"type":"string","title":"Email"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name"},"tags":{"items":{"$ref":"#/components/schemas/CompanyUserTags"},"type":"array","title":"Tags"}},"type":"object","required":["user_id","email","first_name","last_name","tags"],"title":"CompanyUserResponse","description":"Detailed information about a company user"},"CompanyUserTags":{"type":"string","enum":["administrator","operator"],"title":"CompanyUserTags","description":"Access level between a user and a company."},"CompleteIpcFormTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["complete_ipc_form"],"const":"complete_ipc_form","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"CompleteIpcFormTask"},"CompleteKycTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["complete_kyc"],"const":"complete_kyc","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"CompleteKycTask"},"CreateCompanyPost":{"properties":{"key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key"},"properties":{"$ref":"#/components/schemas/CompanyProperties"}},"type":"object","required":["properties"],"title":"CreateCompanyPost","description":"Information needed to create a company"},"CreateCreditNoteRequest":{"properties":{"date":{"type":"string","format":"date","title":"Date"},"description":{"type":"string","title":"Description"},"total":{"type":"number","title":"Total"},"status":{"type":"string","enum":["DRAFT","AUTHORISED"],"title":"Status"}},"type":"object","required":["date","description","total","status"],"title":"CreateCreditNoteRequest","description":"Request data module for creating a credit note."},"CreateCustomerPost":{"properties":{"total_area":{"anyOf":[{"type":"integer"},{"type":"number"}],"title":"Total Area","default":0},"title_no_list":{"items":{"type":"string"},"type":"array","title":"Title No List"},"site_properties":{"anyOf":[{"$ref":"#/components/schemas/CustomerProperties"},{"type":"null"}]},"company_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Key"},"userType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Usertype"},"survey_data":{"anyOf":[{"$ref":"#/components/schemas/HubspotDealProperties"},{"type":"null"}]}},"type":"object","required":["title_no_list"],"title":"CreateCustomerPost","description":"Request data model for new customer."},"CreateCustomerResponse":{"properties":{"customer_id":{"type":"integer","title":"Customer Id"}},"type":"object","required":["customer_id"],"title":"CreateCustomerResponse","description":"Response data model for new customer."},"CreateEtsAccountTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericNotesTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["create_ets_account"],"const":"create_ets_account","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"CreateEtsAccountTask"},"CreateFlowRunResponse":{"properties":{"id":{"type":"string","title":"Id"},"created":{"type":"string","format":"date-time","title":"Created"}},"type":"object","required":["id","created"],"title":"CreateFlowRunResponse"},"CreateHoldingAccountProperties":{"properties":{"comments":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/Comment"},{"type":"string"}]},"type":"array"},{"type":"null"}],"title":"Comments"},"parent_task_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Parent Task Id"},"sub_task_index":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Sub Task Index"},"nzetr_workflow_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nzetr Workflow Id"},"send_for_signature":{"anyOf":[{"$ref":"#/components/schemas/StepComplete"},{"type":"null"}]},"submit_signed":{"anyOf":[{"$ref":"#/components/schemas/StepComplete"},{"type":"null"}]}},"type":"object","title":"CreateHoldingAccountProperties"},"CreateHoldingAccountTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"task_type":{"type":"string","enum":["create_holding_account"],"const":"create_holding_account","title":"Task Type"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/CreateHoldingAccountProperties"},{"type":"null"}]}},"type":"object","required":["uuid","customer_id","task_type","status"],"title":"CreateHoldingAccountTask"},"CreateInitialUsers":{"properties":{"submitter":{"anyOf":[{"$ref":"#/components/schemas/UserPostWithMobile"},{"type":"null"}]},"auth_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Auth Id"}},"type":"object","title":"CreateInitialUsers","description":"User data with submitter."},"CreateInvoiceCosts":{"properties":{"costs_and_disbursements":{"items":{"$ref":"#/components/schemas/InvoiceCostAndDisbursement"},"type":"array","title":"Costs And Disbursements","default":[]},"already_invoiced_costs_and_disbursements":{"items":{"$ref":"#/components/schemas/InvoiceCostAndDisbursement"},"type":"array","title":"Already Invoiced Costs And Disbursements","description":"Costs and disbursements which were already invoiced to the customer, but need to be included for the service fee calculation.","default":[]}},"type":"object","title":"CreateInvoiceCosts"},"CreateUserCustomerPost":{"properties":{"total_area":{"anyOf":[{"type":"integer"},{"type":"number"}],"title":"Total Area","default":0},"title_no_list":{"items":{"type":"string"},"type":"array","title":"Title No List"},"site_properties":{"anyOf":[{"$ref":"#/components/schemas/CustomerProperties"},{"type":"null"}]},"company_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Key"},"userType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Usertype"},"survey_data":{"anyOf":[{"$ref":"#/components/schemas/HubspotDealProperties"},{"type":"null"}]},"users":{"$ref":"#/components/schemas/CreateInitialUsers"},"run_ets_ai":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Run Ets Ai","default":true},"run_finance":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Run Finance","default":true}},"type":"object","required":["title_no_list","users"],"title":"CreateUserCustomerPost","description":"Request data model v2 for user and new customer."},"CreateUserResponse":{"properties":{"user_id":{"type":"integer","title":"User Id"},"token":{"type":"string","title":"Token"}},"type":"object","required":["user_id","token"],"title":"CreateUserResponse"},"CreditSalePotential":{"properties":{"initial_value_2022":{"type":"number","title":"Initial Value 2022"},"future_value_over_forecast":{"type":"number","title":"Future Value Over Forecast"},"cashflows":{"additionalProperties":{"type":"number"},"type":"object","title":"Cashflows"}},"type":"object","required":["initial_value_2022","future_value_over_forecast","cashflows"],"title":"CreditSalePotential","description":"A prediction of dollar values for carbon sales. This is\na monetary combination of YieldPotential and CarbonPrices. The year corresponds to\nthe year in which the sequestration happened. For example the 2023 credit sale\npotential is for sequestration that happened from 1st Jan 2023 to 31st December 2023"},"CreditSchemeType":{"type":"string","enum":["ets","ets_averaging","ets_stock_change","alternative_scheme","open","verra","gold_standard","isometric","equitable_earth","art_trees","iso_ghgp_inventory"],"title":"CreditSchemeType"},"CtrTraceFeatureProperties":{"properties":{"methodology_version":{"type":"string","title":"Methodology Version"},"ctr_id":{"type":"integer","title":"Ctr Id"}},"type":"object","required":["methodology_version","ctr_id"],"title":"CtrTraceFeatureProperties","description":"Non-geometric information about a CTR"},"CtrTraceResponse":{"properties":{"type":{"type":"string","title":"Type","default":"Feature"},"properties":{"$ref":"#/components/schemas/CtrTraceFeatureProperties"},"geometry":{"type":"object","title":"Geometry"}},"type":"object","required":["properties","geometry"],"title":"CtrTraceResponse","description":"The response given when requesting details about\na single CTR. This is a geojson feature that provides the\ngeometry and some additional metadata in the properties\nfield"},"CursorPositionEvent":{"properties":{"source_id":{"type":"string","format":"uuid","title":"Source Id"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"event_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Event Time"},"event_type":{"type":"string","enum":["cursor_position"],"const":"cursor_position","title":"Event Type"},"position":{"$ref":"#/components/schemas/Position"},"initials":{"type":"string","maxLength":4,"minLength":1,"title":"Initials"},"color":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$","title":"Color"}},"type":"object","required":["source_id","event_type","position","initials","color"],"title":"CursorPositionEvent"},"CustomLayerProperties":{"properties":{"style":{"anyOf":[{"$ref":"#/components/schemas/StyleSpecification"},{"type":"null"}]},"version_created":{"anyOf":[{"$ref":"#/components/schemas/VersionData"},{"type":"null"}]},"data_type":{"anyOf":[{"type":"string","enum":["geojson"],"const":"geojson"},{"type":"null"}],"title":"Data Type","default":"geojson"},"type":{"type":"string","enum":["custom_layer"],"const":"custom_layer","title":"Type"},"name":{"type":"string","title":"Name"}},"additionalProperties":false,"type":"object","required":["type","name"],"title":"CustomLayerProperties","description":"User-defined layer with explicit styling controlled by the user."},"CustomRasterCommonLayerProperties":{"properties":{"version_created":{"anyOf":[{"$ref":"#/components/schemas/VersionData"},{"type":"null"}]},"data_type":{"type":"string","enum":["raster"],"const":"raster","title":"Data Type"},"max_zoom":{"type":"integer","title":"Max Zoom"},"tile_url":{"type":"string","title":"Tile Url"},"type":{"type":"string","enum":["custom_raster_layer"],"const":"custom_raster_layer","title":"Type"},"name":{"type":"string","title":"Name"},"legends":{"anyOf":[{"items":{"$ref":"#/components/schemas/RasterLegendEntry"},"type":"array","maxItems":50},{"type":"null"}],"title":"Legends"},"color_range":{"anyOf":[{"$ref":"#/components/schemas/RasterColorRangeLegend"},{"type":"null"}]}},"additionalProperties":false,"type":"object","required":["data_type","max_zoom","tile_url","type","name"],"title":"CustomRasterCommonLayerProperties","description":"Raster tiles without a first-class layer type in the system (e.g. company-owned tile sets)."},"CustomSpeciesCarbonStock":{"properties":{"id":{"type":"string","title":"Id","description":"A stable identifier supplied by the forestry consultant and unique among the company's custom species."},"name":{"type":"string","title":"Name","description":"The name shown to users in species selectors."},"plants_per_hectare":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Plants Per Hectare","description":"The default planting density when this species is selected for a polygon. It can be overridden on the polygon."},"establishment_cost_per_hectare":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Establishment Cost Per Hectare","description":"The default establishment cost in New Zealand dollars per hectare when this species is selected for a polygon. It can be overridden on the polygon."},"FOREST_TYPE":{"allOf":[{"$ref":"#/components/schemas/TupuAkeForestTypeId"}],"description":"The MPI FOREST_TYPE classification used when generating ETS registration spatial data for upload to MPI systems. When no custom stock curve is supplied, it also selects the default MPI curve used in forecasts."},"PREDOMINANT_SPECIES_ID":{"anyOf":[{"$ref":"#/components/schemas/TupuAkePredominantSpeciesId"},{"type":"null"}],"description":"The MPI PREDOMINANT_SPECIES_ID classification used when generating ETS registration spatial data."},"TREE_SPECIES_NAME_ID":{"anyOf":[{"$ref":"#/components/schemas/TupuAkeTreeSpeciesId"},{"type":"null"}],"description":"The MPI TREE_SPECIES_NAME_ID classification used when generating ETS registration spatial data."},"stock":{"anyOf":[{"items":{"$ref":"#/components/schemas/CustomSpeciesRegionalStock"},"type":"array"},{"$ref":"#/components/schemas/CustomSpeciesGlobalStock"},{"type":"null"}],"title":"Stock","description":"A global curve, one or more ETS regional curves, or null to use the default MPI curve selected by FOREST_TYPE."}},"type":"object","required":["id","name","FOREST_TYPE"],"title":"CustomSpeciesCarbonStock","description":"A custom species and the carbon-stock curve used in polygon forecasts."},"CustomSpeciesData":{"properties":{"filename":{"type":"string","title":"Filename","description":"The uploaded CSV filename, retained so users can identify the source and version of the configuration."},"species":{"items":{"$ref":"#/components/schemas/CustomSpeciesCarbonStock"},"type":"array","title":"Species","description":"The custom species available to the company's sites."}},"type":"object","required":["filename","species"],"title":"CustomSpeciesData","description":"A company's uploaded custom-species configuration."},"CustomSpeciesGlobalStock":{"properties":{"values":{"items":{"type":"number"},"type":"array","title":"Values","description":"Cumulative carbon stock in tCO2e/ha by forest age, beginning at age zero. After the final supplied age, forecasts continue using the final value."}},"type":"object","required":["values"],"title":"CustomSpeciesGlobalStock","description":"A custom carbon-stock curve that applies in every ETS region."},"CustomSpeciesRegionalStock":{"properties":{"region":{"anyOf":[{"type":"string","enum":["AUCKLAND"],"const":"AUCKLAND"},{"type":"string","enum":["WAIKATO/TAUPO"],"const":"WAIKATO/TAUPO"},{"type":"string","enum":["BAY OF PLENTY"],"const":"BAY OF PLENTY"},{"type":"string","enum":["GISBORNE"],"const":"GISBORNE"},{"type":"string","enum":["HAWKES BAY/SOUTHERN NORTH ISLAND"],"const":"HAWKES BAY/SOUTHERN NORTH ISLAND"},{"type":"string","enum":["NELSON/MARLBOROUGH"],"const":"NELSON/MARLBOROUGH"},{"type":"string","enum":["CANTERBURY/WEST COAST"],"const":"CANTERBURY/WEST COAST"},{"type":"string","enum":["OTAGO"],"const":"OTAGO"},{"type":"string","enum":["SOUTHLAND"],"const":"SOUTHLAND"}],"title":"Region","description":"The ETS region in which this carbon-stock curve applies."},"values":{"items":{"type":"number"},"type":"array","title":"Values","description":"Cumulative carbon stock in tCO2e/ha by forest age, beginning at age zero. After the final supplied age, forecasts continue using the final value."}},"type":"object","required":["region","values"],"title":"CustomSpeciesRegionalStock","description":"A custom carbon-stock curve for one ETS region."},"CustomSpeciesSummary":{"properties":{"id":{"type":"string","title":"Id","description":"A stable identifier supplied by the forestry consultant and unique among the company's custom species."},"name":{"type":"string","title":"Name","description":"The name shown to users in species selectors."},"plants_per_hectare":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Plants Per Hectare","description":"The default planting density when this species is selected for a polygon. It can be overridden on the polygon."},"establishment_cost_per_hectare":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Establishment Cost Per Hectare","description":"The default establishment cost in New Zealand dollars per hectare when this species is selected for a polygon. It can be overridden on the polygon."},"FOREST_TYPE":{"allOf":[{"$ref":"#/components/schemas/TupuAkeForestTypeId"}],"description":"The MPI FOREST_TYPE classification used when generating ETS registration spatial data for upload to MPI systems. When no custom stock curve is supplied, it also selects the default MPI curve used in forecasts."},"PREDOMINANT_SPECIES_ID":{"anyOf":[{"$ref":"#/components/schemas/TupuAkePredominantSpeciesId"},{"type":"null"}],"description":"The MPI PREDOMINANT_SPECIES_ID classification used when generating ETS registration spatial data."},"TREE_SPECIES_NAME_ID":{"anyOf":[{"$ref":"#/components/schemas/TupuAkeTreeSpeciesId"},{"type":"null"}],"description":"The MPI TREE_SPECIES_NAME_ID classification used when generating ETS registration spatial data."},"regions":{"anyOf":[{"items":{"anyOf":[{"type":"string","enum":["AUCKLAND"],"const":"AUCKLAND"},{"type":"string","enum":["WAIKATO/TAUPO"],"const":"WAIKATO/TAUPO"},{"type":"string","enum":["BAY OF PLENTY"],"const":"BAY OF PLENTY"},{"type":"string","enum":["GISBORNE"],"const":"GISBORNE"},{"type":"string","enum":["HAWKES BAY/SOUTHERN NORTH ISLAND"],"const":"HAWKES BAY/SOUTHERN NORTH ISLAND"},{"type":"string","enum":["NELSON/MARLBOROUGH"],"const":"NELSON/MARLBOROUGH"},{"type":"string","enum":["CANTERBURY/WEST COAST"],"const":"CANTERBURY/WEST COAST"},{"type":"string","enum":["OTAGO"],"const":"OTAGO"},{"type":"string","enum":["SOUTHLAND"],"const":"SOUTHLAND"}]},"type":"array"},{"type":"string","enum":["ALL_REGIONS"],"const":"ALL_REGIONS"}],"title":"Regions","description":"The ETS regions with custom curves. ALL_REGIONS indicates a global custom curve or use of an MPI fallback curve."}},"type":"object","required":["id","name","FOREST_TYPE","regions"],"title":"CustomSpeciesSummary","description":"Custom-species metadata without its carbon-stock values."},"CustomSpeciesSummaryList":{"properties":{"species":{"items":{"$ref":"#/components/schemas/CustomSpeciesSummary"},"type":"array","title":"Species","description":"The custom species available to the company's sites."}},"type":"object","required":["species"],"title":"CustomSpeciesSummaryList","description":"A company's custom species without their carbon-stock values."},"CustomTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"task_type":{"type":"string","enum":["custom_task"],"const":"custom_task","title":"Task Type"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"$ref":"#/components/schemas/CustomTaskProperties"}},"type":"object","required":["uuid","customer_id","task_type","status","properties"],"title":"CustomTask","description":"Represents a custom task for company users."},"CustomTaskProperties":{"properties":{"comments":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/Comment"},{"type":"string"}]},"type":"array"},{"type":"null"}],"title":"Comments"},"parent_task_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Parent Task Id"},"sub_task_index":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Sub Task Index"},"task_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","title":"CustomTaskProperties","description":"Properties for the custom task."},"CustomerCompanyAssociationsResponse":{"properties":{"companies":{"items":{"$ref":"#/components/schemas/CompanyAndTag"},"type":"array","title":"Companies","description":"Active company-site relationship tags. A company appears once for each tag assigned to it."}},"type":"object","required":["companies"],"title":"CustomerCompanyAssociationsResponse","description":"Companies and relationship tags associated with a site."},"CustomerId":{"properties":{"customer_id":{"type":"integer","title":"Customer Id"}},"type":"object","required":["customer_id"],"title":"CustomerId"},"CustomerProperties":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"userType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Usertype"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"comment_list":{"anyOf":[{"items":{"$ref":"#/components/schemas/Comment"},"type":"array"},{"type":"null"}],"title":"Comment List"},"mpi_report":{"anyOf":[{"$ref":"#/components/schemas/MpiReport"},{"type":"null"}]},"land_activity_type":{"anyOf":[{"type":"string","enum":["land_owner"],"const":"land_owner"},{"type":"string","enum":["holder_of_lease"],"const":"holder_of_lease"},{"type":"string","enum":["crown_conservation"],"const":"crown_conservation"},{"type":"null"}],"title":"Land Activity Type"},"lease_expiry_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lease Expiry Date","description":"ISO-8601 date for the expiry of a registered forestry right or lease over the land."},"lease_expires_next_harvest":{"anyOf":[{"type":"string","enum":["yes"],"const":"yes"},{"type":"string","enum":["no"],"const":"no"},{"type":"string","enum":["not_applicable"],"const":"not_applicable"},{"type":"null"}],"title":"Lease Expires Next Harvest","description":"This field shows if a registered forestry right or lease expires at the next harvest."},"carboncrop_share_manual_override":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Carboncrop Share Manual Override"},"financial_start_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Financial Start Year"},"no_ccus_reason":{"anyOf":[{"type":"string","enum":["not_interested"],"const":"not_interested"},{"type":"string","enum":["not_eligible"],"const":"not_eligible"},{"type":"string","enum":["too_small"],"const":"too_small"},{"type":"string","enum":["phase_2_only"],"const":"phase_2_only"},{"type":"null"}],"title":"No Ccus Reason"},"carboncrop_share_calculation_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Carboncrop Share Calculation Version"},"ets":{"anyOf":[{"$ref":"#/components/schemas/EtsProperties"},{"type":"null"}]},"ai_forest_loss":{"anyOf":[{"items":{"$ref":"#/components/schemas/FlossyResult"},"type":"array"},{"type":"null"}],"title":"Ai Forest Loss"},"carbon_management_agreement":{"anyOf":[{"$ref":"#/components/schemas/CarbonManagementAgreementWithStartYear"},{"type":"null"}]},"flow_runs":{"anyOf":[{"items":{"$ref":"#/components/schemas/FlowRun"},"type":"array"},{"type":"null"}],"title":"Flow Runs"}},"additionalProperties":true,"type":"object","title":"CustomerProperties","description":"Customer properties data model."},"CustomerRelationshipMetadata":{"properties":{"tags":{"anyOf":[{"items":{"$ref":"#/components/schemas/TagMetadata"},"type":"array"},{"type":"null"}],"title":"Tags","description":"Definitions of the user-controlled metadata tags available to the company."}},"type":"object","required":["tags"],"title":"CustomerRelationshipMetadata","description":"Metadata a company may record about its own relationships with sites.\n\nThis information belongs to the relationship rather than to the site itself.\nUnlike customer-site tags, it does not grant permissions or control access."},"CustomerSegmentationPost":{"properties":{"features":{"items":{"$ref":"#/components/schemas/Feature_IdTypes_Union_Polygon__MultiPolygon__CommonGeoJsonProperties_"},"type":"array","title":"Features"}},"type":"object","required":["features"],"title":"CustomerSegmentationPost","description":"Feature collection of features where teh ID's may be duplicates,\nnon-integers etc."},"CustomerUserTags":{"type":"string","enum":["submitter","contact","editor","task_editor","invoice_recipient","account_holder","input_task_editor","input_task_inputer","input_task_viewer"],"title":"CustomerUserTags","description":"Customer user association tags."},"CustomerUsersResponse":{"properties":{"users":{"items":{"$ref":"#/components/schemas/UserInfoCustomerTagsResponse"},"type":"array","title":"Users"}},"type":"object","required":["users"],"title":"CustomerUsersResponse"},"CustomersForUser":{"properties":{"customer_id":{"type":"integer","title":"Customer Id"},"customer_user_tags":{"items":{"$ref":"#/components/schemas/CustomerUserTags"},"type":"array","title":"Customer User Tags"},"properties":{"$ref":"#/components/schemas/CustomerProperties"}},"type":"object","required":["customer_id","customer_user_tags","properties"],"title":"CustomersForUser"},"Dimensions":{"properties":{"report_category":{"anyOf":[{"type":"string","enum":["existing_indigenous_ets_forest"],"const":"existing_indigenous_ets_forest"},{"type":"string","enum":["future_native_planting"],"const":"future_native_planting"},{"type":"string","enum":["existing_exotic_ets_forest"],"const":"existing_exotic_ets_forest"},{"type":"string","enum":["future_exotic_planting"],"const":"future_exotic_planting"},{"type":"string","enum":["potential_ets_forest"],"const":"potential_ets_forest"},{"type":"string","enum":["scattered_forest"],"const":"scattered_forest"},{"type":"string","enum":["native_carboncrop"],"const":"native_carboncrop"},{"type":"string","enum":["pre_1990_forest"],"const":"pre_1990_forest"},{"type":"string","enum":["other_vegetation"],"const":"other_vegetation"},{"type":"string","enum":["pasture"],"const":"pasture"},{"type":"string","enum":["unassessed_native_forest"],"const":"unassessed_native_forest"},{"type":"string","enum":["unassessed_exotic_forest"],"const":"unassessed_exotic_forest"},{"type":"string","enum":["unassessed_scrub"],"const":"unassessed_scrub"},{"type":"string","enum":["scrub"],"const":"scrub"},{"type":"string","enum":["excluded"],"const":"excluded"},{"type":"string","enum":["unassessed"],"const":"unassessed"},{"type":"null"}],"title":"Report Category","description":"Broad categorization of forest types useful for reports"},"sequestration_status":{"anyOf":[{"type":"string","enum":["sequestering","steady_state"]},{"type":"null"}],"title":"Sequestration Status","description":"Whether the forest is actively sequestering carbon or has reached a steady state."},"registration_status":{"anyOf":[{"type":"string","enum":["draft"],"const":"draft"},{"type":"string","enum":["intended"],"const":"intended"},{"type":"string","enum":["prepared"],"const":"prepared"},{"type":"string","enum":["rejected"],"const":"rejected"},{"type":"string","enum":["registered"],"const":"registered"},{"type":"string","enum":["submitted"],"const":"submitted"},{"type":"null"}],"title":"Registration Status","description":"Progress of the land through registration in its carbon credit scheme."},"forest_type":{"type":"string","enum":["exotic","native","unknown","no_forest"],"title":"Forest Type","description":"Forest type assigned to the land."},"credit_scheme":{"anyOf":[{"$ref":"#/components/schemas/CreditSchemeType"},{"type":"null"}],"description":"Carbon credit scheme associated with the land."},"planting_status":{"anyOf":[{"type":"string","enum":["draft","confirmed","planted"]},{"type":"null"}],"title":"Planting Status","description":"Status of the planting planned or recorded for the land."},"establishment_year":{"anyOf":[{"type":"string","enum":["b2020"],"const":"b2020"},{"type":"integer"},{"type":"null"}],"title":"Establishment Year","description":"Calendar year in which the forest was or will be established. 'b2020' groups establishment before 2020."}},"type":"object","required":["forest_type"],"title":"Dimensions","description":"Discrete characteristics used to describe, filter, and group land."},"DimsAndMeasures":{"properties":{"dimensions":{"$ref":"#/components/schemas/Dimensions"},"measures":{"$ref":"#/components/schemas/Measures"}},"type":"object","required":["dimensions","measures"],"title":"DimsAndMeasures","description":"Analytical measures associated with a set of land characteristics.\n\n``dimensions`` contains discrete characteristics used to describe, filter, and\ngroup land. ``measures`` contains quantities calculated for that land which can\nbe aggregated across any selected entries."},"EmailLog":{"properties":{"to":{"$ref":"#/components/schemas/User"},"email_date":{"type":"string","title":"Email Date"},"status":{"type":"string","enum":["sent","bounced","error"],"title":"Status"}},"type":"object","required":["to","email_date","status"],"title":"EmailLog","description":"A record of if an email has been sent to a specific user"},"EmissionReturn":{"properties":{"tupuake_units":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Tupuake Units"},"submitted":{"anyOf":[{"$ref":"#/components/schemas/PerStepComplete"},{"type":"null"}]}},"type":"object","title":"EmissionReturn","description":"Emission return common data model."},"EmissionsReturnTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"task_type":{"type":"string","enum":["emissions_return"],"const":"emissions_return","title":"Task Type"},"status":{"type":"string","enum":["no_per","prepare","landholder_input","process_changes","submit","finish"],"title":"Status"},"properties":{"$ref":"#/components/schemas/EmissionsReturnTaskProperties"}},"type":"object","required":["uuid","customer_id","task_type","status","properties"],"title":"EmissionsReturnTask","description":"Represents a Emissions Return"},"EmissionsReturnTaskProperties":{"properties":{"comments":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/Comment"},{"type":"string"}]},"type":"array"},{"type":"null"}],"title":"Comments"},"parent_task_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Parent Task Id"},"sub_task_index":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Sub Task Index"},"prepare":{"anyOf":[{"$ref":"#/components/schemas/PerPrepare"},{"type":"null"}]},"landholder_input":{"anyOf":[{"$ref":"#/components/schemas/PerLandholderInput"},{"type":"null"}]},"process_changes":{"anyOf":[{"$ref":"#/components/schemas/PerProcessChanges"},{"type":"null"}]},"submission":{"anyOf":[{"$ref":"#/components/schemas/PerEmissionReturn"},{"type":"null"}]},"invoice_uploaded_to_google_drive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Invoice Uploaded To Google Drive"},"emissions_return_year":{"type":"integer","title":"Emissions Return Year"}},"type":"object","required":["emissions_return_year"],"title":"EmissionsReturnTaskProperties","description":"Properties for the Emissions Return task."},"Empty":{"properties":{},"type":"object","title":"Empty"},"EnableableValue_float_":{"properties":{"enabled":{"type":"boolean","title":"Enabled"},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value"}},"type":"object","required":["enabled"],"title":"EnableableValue[float]"},"EstablishmentMethod":{"type":"string","enum":["direct_planting","natural_regeneration"],"title":"EstablishmentMethod"},"EtrAccount":{"properties":{"etr_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Etr Account Id","description":"New Zealand Emissions Trading Register (NZETR) holding account number."},"etr_account_holders":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Etr Account Holders","description":"Names of the NZETR holding account holders."}},"type":"object","title":"EtrAccount","description":"NZETR holding account details"},"EtsProperties":{"properties":{"mer":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/Mer2023Properties"},"type":"object"},{"type":"null"}],"title":"Mer","deprecated":true},"per":{"anyOf":[{"$ref":"#/components/schemas/PerProperties"},{"type":"null"}],"deprecated":true},"unit_balance":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Unit Balance"},"unit_balance_updated":{"anyOf":[{"$ref":"#/components/schemas/PerStepComplete"},{"type":"null"}]}},"type":"object","title":"EtsProperties","description":"ETS properties."},"EtsRegistrationDetails":{"properties":{"ELIGIBILIT":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Eligibilit"}},"additionalProperties":true,"type":"object","title":"EtsRegistrationDetails"},"EtsRegistrationTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"task_type":{"type":"string","enum":["register_land_to_ets_v2"],"const":"register_land_to_ets_v2","title":"Task Type"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericTaskProperties"},{"type":"null"}]}},"type":"object","required":["uuid","customer_id","task_type","status"],"title":"EtsRegistrationTask"},"FeatureCollection_IdTypes_GeometryTypes_BoundaryOverviewProperties_NoneType_":{"properties":{"type":{"type":"string","enum":["FeatureCollection"],"const":"FeatureCollection","title":"Type"},"features":{"items":{"$ref":"#/components/schemas/Feature_IdTypes_GeometryTypes_BoundaryOverviewProperties_"},"type":"array","title":"Features"},"metadata":{"type":"null","title":"Metadata"}},"type":"object","required":["type","features"],"title":"FeatureCollection[IdTypes, GeometryTypes, BoundaryOverviewProperties, NoneType]"},"FeatureCollection_IdTypes_GeometryTypes_CommonGeoJsonProperties_SegmentationMetadata_":{"properties":{"type":{"type":"string","enum":["FeatureCollection"],"const":"FeatureCollection","title":"Type"},"features":{"items":{"$ref":"#/components/schemas/Feature_IdTypes_GeometryTypes_CommonGeoJsonProperties_"},"type":"array","title":"Features"},"metadata":{"anyOf":[{"$ref":"#/components/schemas/SegmentationMetadata"},{"type":"null"}]}},"type":"object","required":["type","features"],"title":"FeatureCollection[IdTypes, GeometryTypes, CommonGeoJsonProperties, SegmentationMetadata]"},"FeatureCollection_IdTypes_GeometryTypes_dict_str__Any__NoneType_":{"properties":{"type":{"type":"string","enum":["FeatureCollection"],"const":"FeatureCollection","title":"Type"},"features":{"items":{"$ref":"#/components/schemas/Feature_IdTypes_GeometryTypes_dict_str__Any__"},"type":"array","title":"Features"},"metadata":{"type":"null","title":"Metadata"}},"type":"object","required":["type","features"],"title":"FeatureCollection[IdTypes, GeometryTypes, dict[str, Any], NoneType]"},"FeatureCollection_IdTypes_Union_Point__MultiPoint__PhotoPointProperties_NoneType_":{"properties":{"type":{"type":"string","enum":["FeatureCollection"],"const":"FeatureCollection","title":"Type"},"features":{"items":{"$ref":"#/components/schemas/Feature_IdTypes_Union_Point__MultiPoint__PhotoPointProperties_"},"type":"array","title":"Features"},"metadata":{"type":"null","title":"Metadata"}},"type":"object","required":["type","features"],"title":"FeatureCollection[IdTypes, Union[Point, MultiPoint], PhotoPointProperties, NoneType]"},"FeatureCollection_IdTypes_Union_Point__NoneType__PhotoTakenProperties_NoneType_":{"properties":{"type":{"type":"string","enum":["FeatureCollection"],"const":"FeatureCollection","title":"Type"},"features":{"items":{"$ref":"#/components/schemas/Feature_IdTypes_Union_Point__NoneType__PhotoTakenProperties_"},"type":"array","title":"Features"},"metadata":{"type":"null","title":"Metadata"}},"type":"object","required":["type","features"],"title":"FeatureCollection[IdTypes, Union[Point, NoneType], PhotoTakenProperties, NoneType]"},"FeatureCollection_IdTypes_Union_Polygon__MultiPolygon__CommonGeoJsonProperties_Any_":{"properties":{"type":{"type":"string","enum":["FeatureCollection"],"const":"FeatureCollection","title":"Type"},"features":{"items":{"$ref":"#/components/schemas/Feature_IdTypes_Union_Polygon__MultiPolygon__CommonGeoJsonProperties_"},"type":"array","title":"Features"},"metadata":{"anyOf":[{},{"type":"null"}],"title":"Metadata"}},"type":"object","required":["type","features"],"title":"FeatureCollection[IdTypes, Union[Polygon, MultiPolygon], CommonGeoJsonProperties, Any]"},"FeatureCollection_IdTypes_Union_Polygon__MultiPolygon__Union_SiteBoundaryFeatureProperties__NoneType__NoneType_":{"properties":{"type":{"type":"string","enum":["FeatureCollection"],"const":"FeatureCollection","title":"Type"},"features":{"items":{"$ref":"#/components/schemas/Feature_IdTypes_Union_Polygon__MultiPolygon__Union_SiteBoundaryFeatureProperties__NoneType__"},"type":"array","title":"Features"},"metadata":{"type":"null","title":"Metadata"}},"type":"object","required":["type","features"],"title":"FeatureCollection[IdTypes, Union[Polygon, MultiPolygon], Union[SiteBoundaryFeatureProperties, NoneType], NoneType]"},"FeatureCollection_IdTypes_Union_Polygon__MultiPolygon___FeaturePropertyType__CollectionMetadataType_":{"properties":{"type":{"type":"string","enum":["FeatureCollection"],"const":"FeatureCollection","title":"Type"},"features":{"items":{"$ref":"#/components/schemas/Feature_IdTypes_Union_Polygon__MultiPolygon___FeaturePropertyType_"},"type":"array","title":"Features"},"metadata":{"anyOf":[{"$ref":"#/components/schemas/PropertyTypes"},{"type":"null"}]}},"type":"object","required":["type","features"],"title":"FeatureCollection[IdTypes, Union[Polygon, MultiPolygon], +FeaturePropertyType, +CollectionMetadataType]"},"FeatureCollection_NoneType_Point_SitePointProperty_NoneType_":{"properties":{"type":{"type":"string","enum":["FeatureCollection"],"const":"FeatureCollection","title":"Type"},"features":{"items":{"$ref":"#/components/schemas/Feature_NoneType_Point_SitePointProperty_"},"type":"array","title":"Features"},"metadata":{"type":"null","title":"Metadata"}},"type":"object","required":["type","features"],"title":"FeatureCollection[NoneType, Point, SitePointProperty, NoneType]"},"FeatureCollection_str_GeometryTypes_NzTitleProperties_NoneType_":{"properties":{"type":{"type":"string","enum":["FeatureCollection"],"const":"FeatureCollection","title":"Type"},"features":{"items":{"$ref":"#/components/schemas/Feature_str_GeometryTypes_NzTitleProperties_"},"type":"array","title":"Features"},"metadata":{"type":"null","title":"Metadata"}},"type":"object","required":["type","features"],"title":"FeatureCollection[str, GeometryTypes, NzTitleProperties, NoneType]"},"FeatureMeasureProperties":{"properties":{"descriptor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Descriptor"},"ets_caa_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Ets Caa Number"},"caa_balance":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Caa Balance"},"forest_events":{"anyOf":[{"items":{"$ref":"#/components/schemas/AnyForestEvent"},"type":"array"},{"type":"null"}],"title":"Forest Events"}},"type":"object","title":"FeatureMeasureProperties","description":"Limited feature properties containing descriptor, ets_caa_number, caa_balance, and forest_events."},"Feature_IdTypes_GeometryTypes_BoundaryOverviewProperties_":{"properties":{"type":{"type":"string","enum":["Feature"],"const":"Feature","title":"Type"},"id":{"anyOf":[{"$ref":"#/components/schemas/IdTypes"},{"type":"null"}]},"properties":{"$ref":"#/components/schemas/BoundaryOverviewProperties"},"geometry":{"$ref":"#/components/schemas/GeometryTypes"}},"type":"object","required":["type","properties","geometry"],"title":"Feature[IdTypes, GeometryTypes, BoundaryOverviewProperties]"},"Feature_IdTypes_GeometryTypes_CommonGeoJsonProperties_":{"properties":{"type":{"type":"string","enum":["Feature"],"const":"Feature","title":"Type"},"id":{"anyOf":[{"$ref":"#/components/schemas/IdTypes"},{"type":"null"}]},"properties":{"$ref":"#/components/schemas/CommonGeoJsonProperties"},"geometry":{"$ref":"#/components/schemas/GeometryTypes"}},"type":"object","required":["type","properties","geometry"],"title":"Feature[IdTypes, GeometryTypes, CommonGeoJsonProperties]"},"Feature_IdTypes_GeometryTypes_PropertyTypes_":{"properties":{"type":{"type":"string","enum":["Feature"],"const":"Feature","title":"Type"},"id":{"anyOf":[{"$ref":"#/components/schemas/IdTypes"},{"type":"null"}]},"properties":{"$ref":"#/components/schemas/PropertyTypes"},"geometry":{"$ref":"#/components/schemas/GeometryTypes"}},"type":"object","required":["type","properties","geometry"],"title":"Feature[IdTypes, GeometryTypes, PropertyTypes]"},"Feature_IdTypes_GeometryTypes_dict_str__Any__":{"properties":{"type":{"type":"string","enum":["Feature"],"const":"Feature","title":"Type"},"id":{"anyOf":[{"$ref":"#/components/schemas/IdTypes"},{"type":"null"}]},"properties":{"type":"object","title":"Properties"},"geometry":{"$ref":"#/components/schemas/GeometryTypes"}},"type":"object","required":["type","properties","geometry"],"title":"Feature[IdTypes, GeometryTypes, dict[str, Any]]"},"Feature_IdTypes_Point_CommentPointProperties_":{"properties":{"type":{"type":"string","enum":["Feature"],"const":"Feature","title":"Type"},"id":{"anyOf":[{"$ref":"#/components/schemas/IdTypes"},{"type":"null"}]},"properties":{"$ref":"#/components/schemas/CommentPointProperties"},"geometry":{"$ref":"#/components/schemas/Point"}},"type":"object","required":["type","properties","geometry"],"title":"Feature[IdTypes, Point, CommentPointProperties]"},"Feature_IdTypes_Union_Point__MultiPoint__PhotoPointProperties_":{"properties":{"type":{"type":"string","enum":["Feature"],"const":"Feature","title":"Type"},"id":{"anyOf":[{"$ref":"#/components/schemas/IdTypes"},{"type":"null"}]},"properties":{"$ref":"#/components/schemas/PhotoPointProperties"},"geometry":{"anyOf":[{"$ref":"#/components/schemas/Point"},{"$ref":"#/components/schemas/MultiPoint"}],"title":"Geometry"}},"type":"object","required":["type","properties","geometry"],"title":"Feature[IdTypes, Union[Point, MultiPoint], PhotoPointProperties]"},"Feature_IdTypes_Union_Point__NoneType__PhotoTakenProperties_":{"properties":{"type":{"type":"string","enum":["Feature"],"const":"Feature","title":"Type"},"id":{"anyOf":[{"$ref":"#/components/schemas/IdTypes"},{"type":"null"}]},"properties":{"$ref":"#/components/schemas/PhotoTakenProperties"},"geometry":{"anyOf":[{"$ref":"#/components/schemas/Point"},{"type":"null"}]}},"type":"object","required":["type","properties","geometry"],"title":"Feature[IdTypes, Union[Point, NoneType], PhotoTakenProperties]"},"Feature_IdTypes_Union_Polygon__MultiPolygon__CommonGeoJsonProperties_":{"properties":{"type":{"type":"string","enum":["Feature"],"const":"Feature","title":"Type"},"id":{"anyOf":[{"$ref":"#/components/schemas/IdTypes"},{"type":"null"}]},"properties":{"$ref":"#/components/schemas/CommonGeoJsonProperties"},"geometry":{"anyOf":[{"$ref":"#/components/schemas/Polygon"},{"$ref":"#/components/schemas/MultiPolygon"}],"title":"Geometry"}},"type":"object","required":["type","properties","geometry"],"title":"Feature[IdTypes, Union[Polygon, MultiPolygon], CommonGeoJsonProperties]"},"Feature_IdTypes_Union_Polygon__MultiPolygon__Dict_str__Any__":{"properties":{"type":{"type":"string","enum":["Feature"],"const":"Feature","title":"Type"},"id":{"anyOf":[{"$ref":"#/components/schemas/IdTypes"},{"type":"null"}]},"properties":{"type":"object","title":"Properties"},"geometry":{"anyOf":[{"$ref":"#/components/schemas/Polygon"},{"$ref":"#/components/schemas/MultiPolygon"}],"title":"Geometry"}},"type":"object","required":["type","properties","geometry"],"title":"Feature[IdTypes, Union[Polygon, MultiPolygon], Dict[str, Any]]"},"Feature_IdTypes_Union_Polygon__MultiPolygon__Union_SiteBoundaryFeatureProperties__NoneType__":{"properties":{"type":{"type":"string","enum":["Feature"],"const":"Feature","title":"Type"},"id":{"anyOf":[{"$ref":"#/components/schemas/IdTypes"},{"type":"null"}]},"properties":{"anyOf":[{"$ref":"#/components/schemas/SiteBoundaryFeatureProperties"},{"type":"null"}]},"geometry":{"anyOf":[{"$ref":"#/components/schemas/Polygon"},{"$ref":"#/components/schemas/MultiPolygon"}],"title":"Geometry"}},"type":"object","required":["type","properties","geometry"],"title":"Feature[IdTypes, Union[Polygon, MultiPolygon], Union[SiteBoundaryFeatureProperties, NoneType]]"},"Feature_IdTypes_Union_Polygon__MultiPolygon___FeaturePropertyType_":{"properties":{"type":{"type":"string","enum":["Feature"],"const":"Feature","title":"Type"},"id":{"anyOf":[{"$ref":"#/components/schemas/IdTypes"},{"type":"null"}]},"properties":{"$ref":"#/components/schemas/PropertyTypes"},"geometry":{"anyOf":[{"$ref":"#/components/schemas/Polygon"},{"$ref":"#/components/schemas/MultiPolygon"}],"title":"Geometry"}},"type":"object","required":["type","properties","geometry"],"title":"Feature[IdTypes, Union[Polygon, MultiPolygon], +FeaturePropertyType]"},"Feature_NoneType_Point_SitePointProperty_":{"properties":{"type":{"type":"string","enum":["Feature"],"const":"Feature","title":"Type"},"id":{"type":"null","title":"Id"},"properties":{"$ref":"#/components/schemas/SitePointProperty"},"geometry":{"$ref":"#/components/schemas/Point"}},"type":"object","required":["type","properties","geometry"],"title":"Feature[NoneType, Point, SitePointProperty]"},"Feature_str_GeometryTypes_NzTitleProperties_":{"properties":{"type":{"type":"string","enum":["Feature"],"const":"Feature","title":"Type"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"properties":{"$ref":"#/components/schemas/NzTitleProperties"},"geometry":{"$ref":"#/components/schemas/GeometryTypes"}},"type":"object","required":["type","properties","geometry"],"title":"Feature[str, GeometryTypes, NzTitleProperties]"},"FiledCAAReturn":{"properties":{"intent":{"type":"string","enum":["include"],"const":"include","title":"Intent"},"filed":{"type":"boolean","enum":[true],"const":true,"title":"Filed"},"balance_outcome":{"type":"integer","title":"Balance Outcome"},"stock_change":{"type":"integer","title":"Stock Change"},"year":{"type":"integer","title":"Year"}},"type":"object","required":["intent","filed","balance_outcome","stock_change","year"],"title":"FiledCAAReturn","description":"An emissions return for a CAA that has been filed."},"FillLayer":{"properties":{"type":{"type":"string","enum":["fill"],"const":"fill","title":"Type"},"filter":{"anyOf":[{"prefixItems":[{"type":"string","enum":["=="],"const":"=="},{"prefixItems":[{"type":"string","enum":["get"],"const":"get"},{"type":"string"}],"type":"array","maxItems":2,"minItems":2},{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"}]}],"type":"array","maxItems":3,"minItems":3},{"type":"null"}],"title":"Filter"},"paint":{"anyOf":[{"$ref":"#/components/schemas/FillPaint"},{"type":"null"}]}},"type":"object","required":["type"],"title":"FillLayer","description":"A fill style layer."},"FillMpiApplicationTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["fill_mpi_application"],"const":"fill_mpi_application","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"FillMpiApplicationTask"},"FillPaint":{"properties":{"fill-color":{"type":"string","title":"Fill-Color"}},"type":"object","required":["fill-color"],"title":"FillPaint","description":"Paint properties for a fill layer."},"FinaliseMappingTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["finalise_mapping"],"const":"finalise_mapping","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"FinaliseMappingTask"},"FlossyResult":{"properties":{"area_detected":{"type":"number","title":"Area Detected"},"run_date":{"type":"string","title":"Run Date"}},"type":"object","required":["area_detected","run_date"],"title":"FlossyResult","description":"AI forest result object.\n\nFlossy is the name of our Forest Loss AI Model. This object stores an output\nsummary from an execution of this model."},"FlowRun":{"properties":{"flow_run_id":{"type":"string","title":"Flow Run Id"},"trigger_time":{"type":"string","format":"date-time","title":"Trigger Time"}},"type":"object","required":["flow_run_id","trigger_time"],"title":"FlowRun","description":"An asynchronous task running somewhere in our infrastructure (probably prefect)"},"FlowRunStatus":{"properties":{"flow_name":{"type":"string","title":"Flow Name"},"state":{"$ref":"#/components/schemas/PrefectState"}},"type":"object","required":["flow_name","state"],"title":"FlowRunStatus"},"ForestDetailsConfirmationCaaDetails":{"properties":{"geometry_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Geometry Hash"},"caa_number":{"type":"integer","title":"Caa Number"},"actual_year_of_establishment":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Actual Year Of Establishment"},"actual_year_of_establishment_comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Actual Year Of Establishment Comment"},"actual_species":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Actual Species"},"actual_species_comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Actual Species Comment"},"general_comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"General Comment","deprecated":true},"is_polygon_accurate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Polygon Accurate"},"is_polygon_accurate_comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Is Polygon Accurate Comment"},"intend_to_trim":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Intend To Trim"},"intend_to_trim_comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Intend To Trim Comment"},"intend_to_clear":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Intend To Clear"},"intend_to_clear_comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Intend To Clear Comment"},"commit_to_other_schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Commit To Other Schema"},"commit_to_other_schema_comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Commit To Other Schema Comment"}},"type":"object","required":["caa_number"],"title":"ForestDetailsConfirmationCaaDetails"},"ForestDetailsConfirmationTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"task_type":{"type":"string","enum":["forest_details_confirmation"],"const":"forest_details_confirmation","title":"Task Type"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/ForestDetailsConfirmationTaskProperties"},{"type":"null"}]}},"type":"object","required":["uuid","customer_id","task_type","status"],"title":"ForestDetailsConfirmationTask"},"ForestDetailsConfirmationTaskProperties":{"properties":{"comments":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/Comment"},{"type":"string"}]},"type":"array"},{"type":"null"}],"title":"Comments"},"parent_task_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Parent Task Id"},"sub_task_index":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Sub Task Index"},"caa_details":{"anyOf":[{"items":{"$ref":"#/components/schemas/ForestDetailsConfirmationCaaDetails"},"type":"array"},{"type":"null"}],"title":"Caa Details"},"segments_version":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Segments Version"},"carbon_scheme_stage":{"anyOf":[{"$ref":"#/components/schemas/Carbon_Scheme_Stage"},{"type":"null"}]},"further_discussion_required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Further Discussion Required"},"further_discussion_comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Further Discussion Comment"},"answer_completed":{"anyOf":[{"$ref":"#/components/schemas/StepComplete"},{"type":"null"}]},"email_logs":{"anyOf":[{"items":{"$ref":"#/components/schemas/EmailLog"},"type":"array"},{"type":"null"}],"title":"Email Logs"},"review_completed":{"anyOf":[{"$ref":"#/components/schemas/StepComplete"},{"type":"null"}]}},"type":"object","title":"ForestDetailsConfirmationTaskProperties"},"ForestLossSegmentationDetailedLayerProperties":{"properties":{"version_created":{"anyOf":[{"$ref":"#/components/schemas/VersionData"},{"type":"null"}]},"data_type":{"anyOf":[{"type":"string","enum":["geojson"],"const":"geojson"},{"type":"null"}],"title":"Data Type","default":"geojson"},"type":{"type":"string","enum":["forest_loss_segmentation_detailed"],"const":"forest_loss_segmentation_detailed","title":"Type"},"model_id":{"type":"string","title":"Model Id"},"imagery_source":{"$ref":"#/components/schemas/ImageryLayer"}},"additionalProperties":false,"type":"object","required":["type","model_id","imagery_source"],"title":"ForestLossSegmentationDetailedLayerProperties","description":"The forest loss segmentation layer is a set of polygons that have been\ngenerated by the AI model for determining the forest loss of the\narea."},"ForestLossSegmentationLayerProperties":{"properties":{"version_created":{"anyOf":[{"$ref":"#/components/schemas/VersionData"},{"type":"null"}]},"data_type":{"anyOf":[{"type":"string","enum":["geojson"],"const":"geojson"},{"type":"null"}],"title":"Data Type","default":"geojson"},"type":{"type":"string","enum":["forest_loss_segmentation"],"const":"forest_loss_segmentation","title":"Type"},"model_id":{"type":"string","title":"Model Id"},"imagery_source":{"$ref":"#/components/schemas/ImageryLayer"}},"additionalProperties":false,"type":"object","required":["type","model_id","imagery_source"],"title":"ForestLossSegmentationLayerProperties","description":"The forest loss segmentation layer is a set of polygons that have been\ngenerated by the AI model for determining the forest loss of the\narea."},"ForestStatus1990Type":{"type":"string","enum":["forest","not-forest","unsure"],"title":"ForestStatus1990Type","description":"Types of 1990 forest status."},"ForestTypeKey":{"type":"string","enum":["douglas_fir","exotic_hardwood","exotic_softwood","indigenous","radiata","pinus_radiata"],"title":"ForestTypeKey"},"GenericNotesTaskProperties":{"properties":{"notes":{"type":"string","title":"Notes"},"comments":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/Comment"},{"type":"string"}]},"type":"array"},{"type":"null"}],"title":"Comments"},"parent_task_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Parent Task Id"}},"type":"object","required":["notes"],"title":"GenericNotesTaskProperties"},"GenericTaskProperties":{"properties":{"comments":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/Comment"},{"type":"string"}]},"type":"array"},{"type":"null"}],"title":"Comments"},"parent_task_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Parent Task Id"},"sub_task_index":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Sub Task Index"}},"type":"object","title":"GenericTaskProperties"},"GeometryCollection_Annotated_Union_Point__LineString__Polygon__MultiPoint__MultiLineString__MultiPolygon___FieldInfo_annotation_NoneType__required_True__discriminator__type____":{"properties":{"type":{"type":"string","enum":["GeometryCollection"],"const":"GeometryCollection","title":"Type"},"geometries":{"items":{"oneOf":[{"$ref":"#/components/schemas/Point"},{"$ref":"#/components/schemas/LineString"},{"$ref":"#/components/schemas/Polygon"},{"$ref":"#/components/schemas/MultiPoint"},{"$ref":"#/components/schemas/MultiLineString"},{"$ref":"#/components/schemas/MultiPolygon"}],"discriminator":{"propertyName":"type","mapping":{"LineString":"#/components/schemas/LineString","MultiLineString":"#/components/schemas/MultiLineString","MultiPoint":"#/components/schemas/MultiPoint","MultiPolygon":"#/components/schemas/MultiPolygon","Point":"#/components/schemas/Point","Polygon":"#/components/schemas/Polygon"}}},"type":"array","title":"Geometries"}},"type":"object","required":["type","geometries"],"title":"GeometryCollection[Annotated[Union[Point, LineString, Polygon, MultiPoint, MultiLineString, MultiPolygon], FieldInfo(annotation=NoneType, required=True, discriminator='type')]]"},"GeometryTypes":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/Point"},{"$ref":"#/components/schemas/LineString"},{"$ref":"#/components/schemas/Polygon"},{"$ref":"#/components/schemas/MultiPoint"},{"$ref":"#/components/schemas/MultiLineString"},{"$ref":"#/components/schemas/MultiPolygon"}],"discriminator":{"propertyName":"type","mapping":{"LineString":"#/components/schemas/LineString","MultiLineString":"#/components/schemas/MultiLineString","MultiPoint":"#/components/schemas/MultiPoint","MultiPolygon":"#/components/schemas/MultiPolygon","Point":"#/components/schemas/Point","Polygon":"#/components/schemas/Polygon"}}},{"$ref":"#/components/schemas/GeometryCollection_Annotated_Union_Point__LineString__Polygon__MultiPoint__MultiLineString__MultiPolygon___FieldInfo_annotation_NoneType__required_True__discriminator__type____"},{"type":"null"}]},"GetAccessResponse":{"properties":{"available_features":{"items":{"$ref":"#/components/schemas/AuthFeature"},"type":"array","title":"Available Features"}},"type":"object","required":["available_features"],"title":"GetAccessResponse"},"GetFinancePlanResponse":{"properties":{"areas":{"additionalProperties":{"type":"number"},"type":"object","title":"Areas"},"yields":{"additionalProperties":{"$ref":"#/components/schemas/YieldPotential"},"type":"object","title":"Yields"},"mpi_fees":{"additionalProperties":{"additionalProperties":{"type":"number"},"type":"object"},"type":"object","title":"Mpi Fees"},"cashflows":{"$ref":"#/components/schemas/Cashflows"},"start_year":{"type":"integer","title":"Start Year"},"carboncrop_share":{"$ref":"#/components/schemas/CarbonCropShare"},"company_share":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Company Share"}},"type":"object","required":["areas","yields","mpi_fees","cashflows","start_year","carboncrop_share","company_share"],"title":"GetFinancePlanResponse","description":"The data that is given to the frontend containing the financial data\nfor the whole project"},"HEL":{"type":"integer","enum":[0,4,5,6,7,8],"title":"HEL","description":"Highly erodible land (HEL) refers to land that is very susceptible to erosion.\n\nThis data measures HEL across the North Island of\nAotearoa New Zealand using the Woody layer 2022. Highly\nerodible land (HEL) refers to land that is very susceptible to\nerosion. Landslide erosion is the sudden failure of soil slopes\nduring storm rainfall. Gully erosion is massive soil erosion that\nbegins at gully heads and expands up hillsides over decadal time\nscales. Earthflow erosion is the slow downward movement of wet\nsoil slopes towards waterways."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HubspotDealProperties":{"properties":{"amount":{"anyOf":[{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Amount"},"assessed_land_area_segment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assessed Land Area Segment"},"assessed_land_area":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Assessed Land Area"},"photos_number_uploaded":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Photos Number Uploaded"},"deal_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Role"},"land_registered_ets":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Land Registered Ets"},"planning_to_plant":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning To Plant"},"recent_planting":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recent Planting"},"recent_clearance":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recent Clearance"},"assessment_submission_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assessment Submission Message"},"how_found_us___other_specified":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"How Found Us   Other Specified"},"region_new_zealand":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Region New Zealand"}},"type":"object","title":"HubspotDealProperties"},"HubspotDealUpdateResponse":{"properties":{"deals_updated":{"items":{"type":"integer"},"type":"array","title":"Deals Updated"}},"type":"object","required":["deals_updated"],"title":"HubspotDealUpdateResponse","description":"Response for updating hubspot deals."},"IdTypes":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"null"}]},"ImageryLayer":{"properties":{"name":{"type":"string","title":"Name","description":"What to name this layer when displaying it to the user"},"source":{"anyOf":[{"$ref":"#/components/schemas/SourceName"},{"type":"string","enum":[""],"const":""},{"type":"null"}],"title":"Source","description":"Where this imagery came from, functions as a \"category\" of imagery. May be absent on legacy or stored layers."},"siteUrl":{"type":"string","title":"Siteurl","description":"URL pointing to where the imagery is sourced from. This is so that users can go and find more information about it"},"tileUrl":{"type":"string","title":"Tileurl","description":"Url to a tileserver. Expects there to be {x}, {y} and {z} somewhere in the URL"},"attribution":{"type":"string","title":"Attribution","description":"HTML attribution and licensing information that clients should display."},"startDate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Startdate","description":"The date of the oldest image in this layer. It is the best available date when capture began and may be estimated when the source provides only a year or month. Consumers expect ISO 8601, but the field remains a string to allow legacy database values that are not ISO 8601 compliant."},"endDate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Enddate","description":"The date of the newest image in this layer. It is the best available date when capture ended and may be estimated when the source provides only a year or month. Consumers expect ISO 8601, but the field remains a string to allow legacy database values that are not ISO 8601 compliant."},"extraText":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Extratext","description":"Additional plain-text information to display about this layer that is not represented by other fields, such as a legend, scale, or survey operator."},"minZoom":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Minzoom","description":"Minimum zoom level (tile) which can be requested from this source"},"maxZoom":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Maxzoom","description":"Maximum zoom level (tile) which can be requested from this source"},"tileSize":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Tilesize","description":"Size of the tiles in pixels"},"ground_sample_distance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ground Sample Distance","description":"Ground sample distance (also referred to as pixel size) for an orthophoto is the distance on the ground, measured in x and y components, represented by each pixel in the image, in metres per pixel."},"linz_imagery_survey_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Linz Imagery Survey Id","description":"Primary key of the NZ Imagery Survey Index (https://data.linz.govt.nz/layer/95677-nz-imagery-survey-index/)."}},"type":"object","required":["name","siteUrl","tileUrl","attribution"],"title":"ImageryLayer","description":"Describes a source of XYZ Tiles that can be used to display Raster Imagery on a map"},"InviteCompanyUserPost":{"properties":{"email":{"type":"string","title":"Email"},"company_user_tags":{"items":{"$ref":"#/components/schemas/CompanyUserTags"},"type":"array","title":"Company User Tags"}},"type":"object","required":["email","company_user_tags"],"title":"InviteCompanyUserPost","description":"Invites a user to a company by email."},"InviteSiteUserPost":{"properties":{"email":{"type":"string","title":"Email"},"customer_user_tags":{"items":{"$ref":"#/components/schemas/CustomerUserTags"},"type":"array","title":"Customer User Tags"},"send_invitation":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Invitation","default":true}},"type":"object","required":["email","customer_user_tags"],"title":"InviteSiteUserPost","description":"Request data for site user invitation."},"InvoiceCalculationMinimal":{"properties":{"costs_and_disbursements":{"items":{"$ref":"#/components/schemas/InvoiceCostAndDisbursement"},"type":"array","title":"Costs And Disbursements","default":[]},"already_invoiced_costs_and_disbursements":{"items":{"$ref":"#/components/schemas/InvoiceCostAndDisbursement"},"type":"array","title":"Already Invoiced Costs And Disbursements","description":"Costs and disbursements which were already invoiced to the customer, but need to be included for the service fee calculation.","default":[]},"nzus_issued":{"$ref":"#/components/schemas/InvoiceNZUsIssued"},"sequestration_period":{"$ref":"#/components/schemas/InvoiceSequestrationPeriod"}},"type":"object","required":["nzus_issued","sequestration_period"],"title":"InvoiceCalculationMinimal","description":"Minimal properties for invoice calculation."},"InvoiceConfig":{"properties":{"bcc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Bcc","description":"Addresses BCC'd on invoice emails for the company's sites. Each value may be an email address or 'Name <email>'."}},"type":"object","title":"InvoiceConfig","description":"Configuration for invoices created for the company's sites."},"InvoiceCostAndDisbursement":{"properties":{"description":{"type":"string","title":"Description"},"quantity":{"type":"string","title":"Quantity","examples":["1","0.0","NaN"]},"total_ex_tax":{"type":"string","title":"Total Ex Tax","examples":["1","0.0","NaN"]}},"type":"object","required":["description","quantity","total_ex_tax"],"title":"InvoiceCostAndDisbursement","description":"Cost and disbursement for invoice."},"InvoiceDataResponse":{"properties":{"invoice_id":{"type":"integer","title":"Invoice Id"},"invoice_number":{"type":"string","title":"Invoice Number"},"invoice_date":{"type":"string","title":"Invoice Date"},"total_ex_tax":{"type":"string","title":"Total Ex Tax","examples":["1","0.0","NaN"]},"total_inc_tax":{"type":"string","title":"Total Inc Tax","examples":["1","0.0","NaN"]},"tax":{"type":"string","title":"Tax","examples":["1","0.0","NaN"]},"status":{"$ref":"#/components/schemas/InvoiceStatus"},"properties":{"$ref":"#/components/schemas/InvoiceProperties"}},"type":"object","required":["invoice_id","invoice_number","invoice_date","total_ex_tax","total_inc_tax","tax","status","properties"],"title":"InvoiceDataResponse","description":"Response data module for invoice POST method."},"InvoiceGoogleDriveFileIdResponse":{"properties":{"file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Id"}},"type":"object","title":"InvoiceGoogleDriveFileIdResponse","description":"Response data model for invoice file ID in Google Drive."},"InvoiceNZUsIssued":{"properties":{"nzu_price":{"type":"string","title":"Nzu Price","examples":["1","0.0","NaN"]},"amount":{"type":"string","title":"Amount","examples":["1","0.0","NaN"]}},"type":"object","required":["nzu_price","amount"],"title":"InvoiceNZUsIssued","description":"NZUs issues and NZU price data for invoice."},"InvoicePostRequest":{"properties":{"invoice_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Number"},"properties":{"$ref":"#/components/schemas/InvoiceCalculationMinimal"}},"type":"object","required":["properties"],"title":"InvoicePostRequest","description":"Request used to create an invoice."},"InvoiceProperties":{"properties":{"costs_and_disbursements":{"items":{"$ref":"#/components/schemas/InvoiceCostAndDisbursement"},"type":"array","title":"Costs And Disbursements","default":[]},"already_invoiced_costs_and_disbursements":{"items":{"$ref":"#/components/schemas/InvoiceCostAndDisbursement"},"type":"array","title":"Already Invoiced Costs And Disbursements","description":"Costs and disbursements which were already invoiced to the customer, but need to be included for the service fee calculation.","default":[]},"nzus_issued":{"$ref":"#/components/schemas/InvoiceNZUsIssued"},"sequestration_period":{"$ref":"#/components/schemas/InvoiceSequestrationPeriod"},"min_service_fee_amount":{"anyOf":[{"type":"string","examples":["1","0.0","NaN"]},{"type":"null"}],"title":"Min Service Fee Amount"},"service_fee_before_deductions":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Service Fee Before Deductions"},"service_fee_proportion":{"type":"string","title":"Service Fee Proportion","examples":["1","0.0","NaN"]},"cc_service_fee":{"$ref":"#/components/schemas/InvoiceCostAndDisbursement"},"service_fee_calculation":{"$ref":"#/components/schemas/CalculatedServiceFee"},"payment":{"$ref":"#/components/schemas/CalculatedPayment"},"nzetr_balance":{"anyOf":[{"$ref":"#/components/schemas/UnitBalance"},{"type":"null"}]},"is_manual_invoice_date":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Manual Invoice Date"}},"type":"object","required":["nzus_issued","sequestration_period","service_fee_proportion","cc_service_fee","service_fee_calculation","payment"],"title":"InvoiceProperties","description":"Properties of invoice data."},"InvoiceSequestrationPeriod":{"properties":{"start":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start"},"end":{"type":"string","title":"End"}},"type":"object","required":["end"],"title":"InvoiceSequestrationPeriod","description":"Period of sequestration for invoice."},"InvoiceStatus":{"type":"string","enum":["draft","sent","voided"],"title":"InvoiceStatus","description":"Invoice status."},"InvoiceStatusUpdateRequest":{"properties":{"status":{"$ref":"#/components/schemas/InvoiceStatus"}},"type":"object","required":["status"],"title":"InvoiceStatusUpdateRequest","description":"Request data module for invoice status update PUT method."},"InvoiceTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"task_type":{"type":"string","enum":["invoice"],"const":"invoice","title":"Task Type"},"status":{"type":"string","enum":["prepare_invoice","awaiting_units","invoice_sent","in_dispute","transaction_prepared","complete"],"title":"Status"},"properties":{"anyOf":[{"$ref":"#/components/schemas/InvoiceTaskProperties"},{"type":"null"}]}},"type":"object","required":["uuid","customer_id","task_type","status"],"title":"InvoiceTask"},"InvoiceTaskProperties":{"properties":{"invoice_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Invoice Id"},"email_logs":{"anyOf":[{"items":{"$ref":"#/components/schemas/EmailLog"},"type":"array"},{"type":"null"}],"title":"Email Logs"},"prepare_notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prepare Notes"},"dispute_notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dispute Notes"},"dispute_status":{"anyOf":[{"type":"string","enum":["no_dispute","in_dispute","resolved"]},{"type":"null"}],"title":"Dispute Status"},"invoice_prepared":{"anyOf":[{"$ref":"#/components/schemas/StepComplete"},{"type":"null"}]},"invoice_sent":{"anyOf":[{"$ref":"#/components/schemas/StepComplete"},{"type":"null"}]},"email_sending_status":{"anyOf":[{"type":"string","enum":["email_sending","email_failed","email_sent"]},{"type":"null"}],"title":"Email Sending Status"},"parent_task_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Parent Task Id"},"comments":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/Comment"},{"type":"string"}]},"type":"array"},{"type":"null"}],"title":"Comments"}},"type":"object","title":"InvoiceTaskProperties"},"InvoiceUpdateInput":{"properties":{"costs_and_disbursements":{"items":{"$ref":"#/components/schemas/InvoiceCostAndDisbursement"},"type":"array","title":"Costs And Disbursements","default":[]},"already_invoiced_costs_and_disbursements":{"items":{"$ref":"#/components/schemas/InvoiceCostAndDisbursement"},"type":"array","title":"Already Invoiced Costs And Disbursements","description":"Costs and disbursements which were already invoiced to the customer, but need to be included for the service fee calculation.","default":[]},"nzus_issued":{"$ref":"#/components/schemas/InvoiceNZUsIssued"},"sequestration_period":{"$ref":"#/components/schemas/InvoiceSequestrationPeriod"},"nzetr_balance":{"anyOf":[{"$ref":"#/components/schemas/UnitBalance"},{"type":"null"}]},"invoice_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Date"},"is_manual_invoice_date":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Manual Invoice Date"}},"type":"object","required":["nzus_issued","sequestration_period"],"title":"InvoiceUpdateInput","description":"API input data module includes calculation properties and\nother properties which are not necessary for calculation but required."},"JobData":{"properties":{"id":{"type":"string","title":"Id"}},"type":"object","required":["id"],"title":"JobData"},"LUC":{"type":"integer","enum":[0,1,2,3,4,5,6,7,8],"title":"LUC","description":"Land use capability classification system for New Zealand land.\n\nThe LUC system classifies land based on its capability to sustain agricultural production,\ntaking into account physical limitations and soil conservation needs."},"LandTransitionTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"task_type":{"type":"string","enum":["land_transition"],"const":"land_transition","title":"Task Type"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/LandTransitionTaskProperties"},{"type":"null"}]}},"type":"object","required":["uuid","customer_id","task_type","status"],"title":"LandTransitionTask"},"LandTransitionTaskProperties":{"properties":{"comments":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/Comment"},{"type":"string"}]},"type":"array"},{"type":"null"}],"title":"Comments"},"parent_task_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Parent Task Id"},"sub_task_index":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Sub Task Index"},"user_input":{"anyOf":[{"$ref":"#/components/schemas/LandTransitionTaskUserInput"},{"type":"null"}]},"review_completed":{"anyOf":[{"$ref":"#/components/schemas/StepComplete"},{"type":"null"}]}},"type":"object","title":"LandTransitionTaskProperties"},"LandTransitionTaskUserInput":{"properties":{"user_input_completed":{"anyOf":[{"$ref":"#/components/schemas/StepComplete"},{"type":"null"}]}},"type":"object","title":"LandTransitionTaskUserInput"},"LandUseCapabilityClassRestrictions":{"properties":{"ALLOW_25":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Allow 25","description":"\n    This field shows whether the polygon includes land\n    you believe can be registered under the 25%\n    allowance for restricted forest land.\n    "},"PRMT":{"anyOf":[{"$ref":"#/components/schemas/Luc6Permit"},{"type":"null"}],"description":"\n    Permit to plant on LUC 6 land.\n    "},"LUC7_8_OTH":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Luc7 8 Oth","description":"\n    This field shows whether the polygon includes land\n    you believe to be unrestricted Land Use Capability\n    class 7 to 8, other, or unmapped land under the Act.\n    LUC 'other' means the following: estuary, lake,\n    quarry, mine, other earthworks, icefield, river, urban\n    area, airport or oxidation pond.\n    "},"not_restricted_reason":{"anyOf":[{"$ref":"#/components/schemas/NotRestrictedReasonType"},{"type":"null"}],"description":"\n    This field shows the reason why the polygon is not restricted under the Act. This field is only relevant if LUC7_8_OTH is True\n    "},"ballot_status":{"anyOf":[{"$ref":"#/components/schemas/BallotStatusType"},{"type":"null"}],"description":"\n    This field shows the status of the ballot for the polygon. This field is only relevant if LUC restriction is 'LUC 6 Ballot'\n    "},"MAORI_EX":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Maori Ex","description":"\n    This field shows whether the polygon includes land\n    you believe to be exempt Māori land under the Act.\n    "},"CROWN_AFF":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Crown Aff","description":"\n    This field shows whether the polygon includes land\n    you believe to be Crown afforestation land under the\n    Act.\n    "},"EROSION":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Erosion","description":"\n    This field shows whether the polygon includes land\n    you believe to be erosion-prone land under the Act.\n    "},"UNFARMED":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Unfarmed","description":"\n    This field shows whether the polygon includes land\n    you believe to be unfarmed land under the Act.\n    "},"TRANS_EX":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Trans Ex","description":"\n    This field shows whether the polygon includes land\n    you consider to be eligible for a transitional exemption\n    under the Act.\n    "}},"type":"object","title":"LandUseCapabilityClassRestrictions"},"LandUseChangeReportTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["land_use_change_report"],"const":"land_use_change_report","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"LandUseChangeReportTask"},"LayerListModel":{"properties":{"customer_id":{"type":"integer","title":"Customer Id"},"layers":{"items":{"$ref":"#/components/schemas/LayerModel_AllLayerProperties_"},"type":"array","title":"Layers"}},"type":"object","required":["customer_id","layers"],"title":"LayerListModel","description":"Information about what layers are available for a customer"},"LayerModel":{"properties":{"layer_id":{"type":"integer","title":"Layer Id"},"version_id":{"type":"integer","title":"Version Id"},"properties":{"$ref":"#/components/schemas/AllLayerProperties"}},"type":"object","required":["layer_id","version_id","properties"],"title":"LayerModel","description":"Metadata about a layer: eg what version it is"},"LayerModel_AllLayerProperties_":{"properties":{"layer_id":{"type":"integer","title":"Layer Id"},"version_id":{"type":"integer","title":"Version Id"},"properties":{"$ref":"#/components/schemas/AllLayerProperties"}},"type":"object","required":["layer_id","version_id","properties"],"title":"LayerModel[AllLayerProperties]"},"LayerModel_Annotated_Union_CustomLayerProperties__CustomRasterCommonLayerProperties___FieldInfo_annotation_NoneType__required_True__discriminator__type____":{"properties":{"layer_id":{"type":"integer","title":"Layer Id"},"version_id":{"type":"integer","title":"Version Id"},"properties":{"oneOf":[{"$ref":"#/components/schemas/CustomLayerProperties"},{"$ref":"#/components/schemas/CustomRasterCommonLayerProperties"}],"title":"Properties","discriminator":{"propertyName":"type","mapping":{"custom_layer":"#/components/schemas/CustomLayerProperties","custom_raster_layer":"#/components/schemas/CustomRasterCommonLayerProperties"}}}},"type":"object","required":["layer_id","version_id","properties"],"title":"LayerModel[Annotated[Union[CustomLayerProperties, CustomRasterCommonLayerProperties], FieldInfo(annotation=NoneType, required=True, discriminator='type')]]"},"Layer_AllLayerProperties_IdTypes_GeometryTypes_PropertyTypes_":{"properties":{"type":{"type":"string","enum":["FeatureCollection"],"const":"FeatureCollection","title":"Type","default":"FeatureCollection"},"features":{"items":{"$ref":"#/components/schemas/Feature_IdTypes_GeometryTypes_PropertyTypes_"},"type":"array","title":"Features"},"metadata":{"type":"null","title":"Metadata"},"layer_properties":{"$ref":"#/components/schemas/AllLayerProperties"}},"type":"object","required":["features","layer_properties"],"title":"Layer[AllLayerProperties, IdTypes, GeometryTypes, PropertyTypes]"},"Layer_Annotated_Union_CustomLayerProperties__CustomRasterCommonLayerProperties___FieldInfo_annotation_NoneType__required_True__discriminator__type____IdTypes_GeometryTypes_PropertyTypes_":{"properties":{"type":{"type":"string","enum":["FeatureCollection"],"const":"FeatureCollection","title":"Type","default":"FeatureCollection"},"features":{"items":{"$ref":"#/components/schemas/Feature_IdTypes_GeometryTypes_PropertyTypes_"},"type":"array","title":"Features"},"metadata":{"type":"null","title":"Metadata"},"layer_properties":{"oneOf":[{"$ref":"#/components/schemas/CustomLayerProperties"},{"$ref":"#/components/schemas/CustomRasterCommonLayerProperties"}],"title":"Layer Properties","discriminator":{"propertyName":"type","mapping":{"custom_layer":"#/components/schemas/CustomLayerProperties","custom_raster_layer":"#/components/schemas/CustomRasterCommonLayerProperties"}}}},"type":"object","required":["features","layer_properties"],"title":"Layer[Annotated[Union[CustomLayerProperties, CustomRasterCommonLayerProperties], FieldInfo(annotation=NoneType, required=True, discriminator='type')], IdTypes, GeometryTypes, PropertyTypes]"},"Layer_CommentPointsLayerProperties_IdTypes_Point_CommentPointProperties_":{"properties":{"type":{"type":"string","enum":["FeatureCollection"],"const":"FeatureCollection","title":"Type","default":"FeatureCollection"},"features":{"items":{"$ref":"#/components/schemas/Feature_IdTypes_Point_CommentPointProperties_"},"type":"array","title":"Features"},"metadata":{"type":"null","title":"Metadata"},"layer_properties":{"$ref":"#/components/schemas/CommentPointsLayerProperties"}},"type":"object","required":["features","layer_properties"],"title":"Layer[CommentPointsLayerProperties, IdTypes, Point, CommentPointProperties]"},"LineLayer":{"properties":{"type":{"type":"string","enum":["line"],"const":"line","title":"Type"},"filter":{"anyOf":[{"prefixItems":[{"type":"string","enum":["=="],"const":"=="},{"prefixItems":[{"type":"string","enum":["get"],"const":"get"},{"type":"string"}],"type":"array","maxItems":2,"minItems":2},{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"}]}],"type":"array","maxItems":3,"minItems":3},{"type":"null"}],"title":"Filter"},"paint":{"anyOf":[{"$ref":"#/components/schemas/LinePaint"},{"type":"null"}]}},"type":"object","required":["type"],"title":"LineLayer","description":"A line style layer."},"LinePaint":{"properties":{"line-color":{"type":"string","title":"Line-Color"}},"type":"object","required":["line-color"],"title":"LinePaint","description":"Paint properties for a line layer."},"LineString":{"properties":{"type":{"type":"string","enum":["LineString"],"const":"LineString","title":"Type"},"coordinates":{"items":{"anyOf":[{"prefixItems":[{"type":"number"},{"type":"number"}],"type":"array","maxItems":2,"minItems":2},{"prefixItems":[{"type":"number"},{"type":"number"},{"type":"number"}],"type":"array","maxItems":3,"minItems":3}]},"type":"array","minItems":2,"title":"Coordinates"}},"type":"object","required":["type","coordinates"],"title":"LineString"},"LocalPdfFile":{"properties":{"filename":{"type":"string","title":"Filename"},"size":{"type":"integer","title":"Size"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"}},"type":"object","required":["filename","size"],"title":"LocalPdfFile"},"LocalPdfJobData":{"properties":{"tasks":{"items":{"$ref":"#/components/schemas/LocalPdfJobTask"},"type":"array","title":"Tasks"},"status":{"$ref":"#/components/schemas/LocalPdfJobStatus"}},"type":"object","required":["tasks","status"],"title":"LocalPdfJobData"},"LocalPdfJobStatus":{"type":"string","enum":["waiting","processing","finished","error"],"title":"LocalPdfJobStatus"},"LocalPdfJobTask":{"properties":{"result":{"anyOf":[{"$ref":"#/components/schemas/LocalPdfResult"},{"type":"null"}]}},"type":"object","title":"LocalPdfJobTask"},"LocalPdfResult":{"properties":{"files":{"items":{"$ref":"#/components/schemas/LocalPdfFile"},"type":"array","title":"Files"}},"type":"object","required":["files"],"title":"LocalPdfResult"},"Location":{"properties":{"lat":{"type":"number","title":"Lat"},"lon":{"type":"number","title":"Lon"}},"type":"object","required":["lat","lon"],"title":"Location"},"Luc6Permit":{"properties":{"ID":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"\n    This field shows the Land Use Capability class 6 land\n    permit ID.\n    "},"YEAR":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year","description":"\n    This field shows the year the permit for Land Use\n    Capability class 6 land was issued.\n\n    Format must be YYYY (4-digit year).\n    Year must be 2026 or later\n    "}},"type":"object","title":"Luc6Permit"},"Measures":{"properties":{"aea":{"type":"number","title":"Aea","description":"Area, in hectares. 'aea' is the compact form of 'area'."},"status_1990":{"anyOf":[{"additionalProperties":{"type":"number"},"type":"object"},{"type":"null"}],"title":"Status 1990","description":"Area in each 1990 forest-status classification, in hectares."},"seq":{"items":{"type":"integer"},"type":"array","title":"Seq","description":"Annual sequestration/carbon yield, in tonnes of CO2e. Index zero represents the response's start_year."},"luc":{"anyOf":[{"additionalProperties":{"type":"number"},"type":"object"},{"type":"null"}],"title":"Luc","description":"Land Use Capability (LUC) area distribution. Keys are LUC classes and values are hectares."},"hel":{"anyOf":[{"additionalProperties":{"type":"number"},"type":"object"},{"type":"null"}],"title":"Hel","description":"Highly Erodible Land (HEL) area distribution. Keys are HEL classes and values are hectares."},"cms":{"anyOf":[{"type":"boolean","enum":[true],"const":true},{"type":"null"}],"title":"Cms","description":"CCU Data Missing. True when CarbonCrop Unit data needed for this dimension is unavailable; omitted otherwise."},"esc":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Esc","description":"Total forest establishment cost for the area, in NZD."}},"type":"object","required":["aea","seq"],"title":"Measures","description":"Quantities calculated for land that can be aggregated across selected entries.\n\nField names are shortened to keep site-summary responses compact."},"Mer2022Task":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"task_type":{"type":"string","enum":["mer.2022"],"const":"mer.2022","title":"Task Type"},"status":{"type":"string","enum":["no_per","prepare","landholder_input","process_changes","submit","finish"],"title":"Status"},"properties":{"$ref":"#/components/schemas/Mer2022TaskProperties"}},"type":"object","required":["uuid","customer_id","task_type","status","properties"],"title":"Mer2022Task","description":"Final Emissions Return 2022"},"Mer2022TaskProperties":{"properties":{"comments":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/Comment"},{"type":"string"}]},"type":"array"},{"type":"null"}],"title":"Comments"},"parent_task_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Parent Task Id"},"sub_task_index":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Sub Task Index"},"tupuake_units":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Tupuake Units"}},"additionalProperties":true,"type":"object","title":"Mer2022TaskProperties","description":"Data about the 2018-2022 MER (which is filed in 2023).\nNote: the Mer2023Properties will be deprecated in future."},"Mer2023Properties":{"properties":{"tupuake_units":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Tupuake Units"}},"additionalProperties":true,"type":"object","title":"Mer2023Properties","description":"Data about the 2018-2022 MER (which is filed in 2023).\nNote: this is not typed on the backend yet. See the frontend code for the data model"},"MpiAssessmentTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["mpi_assessment"],"const":"mpi_assessment","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"MpiAssessmentTask"},"MpiReport":{"properties":{"summary_of_land_status_changes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary Of Land Status Changes"},"environmental_and_climatic_factors":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Environmental And Climatic Factors"},"etr_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Etr Account Id"},"etr_account_holders":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Etr Account Holders"},"submitter":{"anyOf":[{"$ref":"#/components/schemas/MpiSubmitter"},{"type":"null"}]}},"type":"object","title":"MpiReport","description":"MPI report data model."},"MpiReportProperties":{"properties":{"land_status_1989":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Land Status 1989"},"land_status_1989_map":{"anyOf":[{"$ref":"#/components/schemas/ImageryLayer"},{"type":"null"}]},"land_status_change_summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Land Status Change Summary"},"land_status_change":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Land Status Change"},"land_status_at_report_submit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Land Status At Report Submit"},"land_status_at_report_submit_map":{"anyOf":[{"$ref":"#/components/schemas/ImageryLayer"},{"type":"null"}]},"group_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Key"},"0":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"0"}},"type":"object","title":"MpiReportProperties"},"MpiShapefileLayerProperties":{"properties":{"version_created":{"anyOf":[{"$ref":"#/components/schemas/VersionData"},{"type":"null"}]},"data_type":{"anyOf":[{"type":"string","enum":["geojson"],"const":"geojson"},{"type":"null"}],"title":"Data Type","default":"geojson"},"type":{"anyOf":[{"type":"string","enum":["mpi_registered_shapefiles"],"const":"mpi_registered_shapefiles"},{"type":"string","enum":["mpi_rejected_shapefiles"],"const":"mpi_rejected_shapefiles"},{"type":"string","enum":["mpi_submitted_shapefiles"],"const":"mpi_submitted_shapefiles"}],"title":"Type"},"name":{"type":"string","title":"Name"}},"additionalProperties":false,"type":"object","required":["type","name"],"title":"MpiShapefileLayerProperties","description":"Layer that is used to store the current view of the site\naccording to the Ministry of Primary Industries (MPI)"},"MpiSubmitter":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"}},"type":"object","title":"MpiSubmitter","description":"Records who submitted the MPI Evidence Report. Generally this should be the account manager\nwho is working with the customer and wrote up the details."},"MultiLineString":{"properties":{"type":{"type":"string","enum":["MultiLineString"],"const":"MultiLineString","title":"Type"},"coordinates":{"items":{"items":{"anyOf":[{"prefixItems":[{"type":"number"},{"type":"number"}],"type":"array","maxItems":2,"minItems":2},{"prefixItems":[{"type":"number"},{"type":"number"},{"type":"number"}],"type":"array","maxItems":3,"minItems":3}]},"type":"array"},"type":"array","title":"Coordinates"}},"type":"object","required":["type","coordinates"],"title":"MultiLineString"},"MultiPoint":{"properties":{"type":{"type":"string","enum":["MultiPoint"],"const":"MultiPoint","title":"Type"},"coordinates":{"items":{"anyOf":[{"prefixItems":[{"type":"number"},{"type":"number"}],"type":"array","maxItems":2,"minItems":2},{"prefixItems":[{"type":"number"},{"type":"number"},{"type":"number"}],"type":"array","maxItems":3,"minItems":3},{"type":"array","maxItems":0,"minItems":0}]},"type":"array","title":"Coordinates"}},"type":"object","required":["type","coordinates"],"title":"MultiPoint"},"MultiPolygon":{"properties":{"type":{"type":"string","enum":["MultiPolygon"],"const":"MultiPolygon","title":"Type"},"coordinates":{"items":{"items":{"items":{"anyOf":[{"prefixItems":[{"type":"number"},{"type":"number"}],"type":"array","maxItems":2,"minItems":2},{"prefixItems":[{"type":"number"},{"type":"number"},{"type":"number"}],"type":"array","maxItems":3,"minItems":3}]},"type":"array"},"type":"array"},"type":"array","title":"Coordinates"}},"type":"object","required":["type","coordinates"],"title":"MultiPolygon"},"NZUPrice":{"properties":{"file_name":{"type":"string","title":"File Name","description":"Name of the uploaded file."},"uploaded_by":{"allOf":[{"$ref":"#/components/schemas/User"}],"description":"User who uploaded the estimates."},"date_uploaded":{"type":"string","format":"date-time","title":"Date Uploaded","description":"Date and time when the estimates were uploaded."},"enabled":{"type":"boolean","title":"Enabled","description":"Whether these estimates override the system default carbon prices."},"start_year":{"type":"integer","title":"Start Year","description":"First calendar year represented by values."},"values":{"items":{"type":"number"},"type":"array","title":"Values","description":"Annual price estimates, in NZD per carbon unit, for sequential years beginning with start_year."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"User-facing name for this carbon price curve."}},"type":"object","required":["file_name","uploaded_by","date_uploaded","enabled","start_year","values"],"title":"NZUPrice","description":"Forecasts of a carbon unit price. The historic name is retained for API compatibility."},"NamedEmail":{"properties":{"name":{"type":"string","title":"Name","description":"Name displayed alongside the email address."},"email":{"type":"string","title":"Email","description":"Email address."}},"type":"object","required":["name","email"],"title":"NamedEmail","description":"An email address with a name.\n\nMany email clients support displaying a name alongside an email address.\nFor example: \"Support Team\" and \"support@company.com\""},"NoLayerProperties":{"properties":{"version_created":{"anyOf":[{"$ref":"#/components/schemas/VersionData"},{"type":"null"}]},"type":{"type":"null","enum":[null],"title":"Type"},"data_type":{"type":"null","title":"Data Type"}},"additionalProperties":false,"type":"object","title":"NoLayerProperties","description":"This layer has no properties"},"NoRasterLayerProperties":{"properties":{"version_created":{"anyOf":[{"$ref":"#/components/schemas/VersionData"},{"type":"null"}]},"data_type":{"type":"string","enum":["raster"],"const":"raster","title":"Data Type"},"max_zoom":{"type":"integer","title":"Max Zoom"},"tile_url":{"type":"string","title":"Tile Url"},"type":{"type":"null","enum":[null],"title":"Type"}},"additionalProperties":false,"type":"object","required":["data_type","max_zoom","tile_url"],"title":"NoRasterLayerProperties","description":"This layer has no additional properties beyond the strictly necessary."},"NotRestrictedReasonType":{"type":"string","enum":["luc7_8","indigenous_forest","forest_land_oct_2025","unmapped_land"],"title":"NotRestrictedReasonType","description":"Types of reasons for land not being restricted."},"NotificationSetting":{"properties":{"email":{"type":"boolean","title":"Email","default":true}},"type":"object","title":"NotificationSetting"},"NotificationSettings":{"properties":{"mention":{"allOf":[{"$ref":"#/components/schemas/NotificationSetting"}],"default":{"email":true}},"assigned_task_status_change":{"allOf":[{"$ref":"#/components/schemas/NotificationSetting"}],"default":{"email":true}},"assigned_task_assignee_change":{"allOf":[{"$ref":"#/components/schemas/NotificationSetting"}],"default":{"email":true}},"assigned_task_subtask_assignee_change":{"allOf":[{"$ref":"#/components/schemas/NotificationSetting"}],"default":{"email":true}},"assigned_task_subtask_status_change":{"allOf":[{"$ref":"#/components/schemas/NotificationSetting"}],"default":{"email":true}}},"type":"object","title":"NotificationSettings","description":"Notification settings for the user."},"NzTitleProperties":{"properties":{"id":{"type":"integer","title":"Id"},"title_no":{"type":"string","title":"Title No"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"total_area":{"type":"number","title":"Total Area"},"owners":{"type":"string","title":"Owners"}},"type":"object","required":["id","title_no","total_area","owners"],"title":"NzTitleProperties","description":"NZ title properties model."},"NzuTransferAccount":{"properties":{"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number"},"account_holder":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Holder"},"account_balance":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Account Balance"}},"type":"object","title":"NzuTransferAccount","description":"Represents an NZETR account involved in the transfer of NZUs."},"OpenTupuakePartyTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["open_tupuake_party"],"const":"open_tupuake_party","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"OpenTupuakePartyTask"},"ParcelStatus":{"properties":{"parcel_id":{"type":"integer","title":"Parcel Id"},"status":{"anyOf":[{"type":"string","enum":["Current"],"const":"Current"},{"type":"string","enum":["Historic"],"const":"Historic"},{"type":"string","enum":["Approved as to Survey"],"const":"Approved as to Survey"},{"type":"string","enum":["Survey Historic"],"const":"Survey Historic"}],"title":"Status"}},"type":"object","required":["parcel_id","status"],"title":"ParcelStatus"},"ParcelStatusResponse":{"properties":{"customer_id":{"type":"integer","title":"Customer Id"},"parcel_status":{"items":{"$ref":"#/components/schemas/ParcelStatus"},"type":"array","title":"Parcel Status"},"projects_sharing_parcels":{"items":{"type":"integer"},"type":"array","title":"Projects Sharing Parcels"}},"type":"object","required":["customer_id","parcel_status","projects_sharing_parcels"],"title":"ParcelStatusResponse"},"ParticipantSpecificTable":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ResidualAndStock"},"type":"array","title":"Data","description":"Participant-specific carbon stock values by forest type."},"table_generated_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Table Generated Date","description":"Date on which MPI generated the Participant Specific Table."},"upload_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Upload Date","description":"Date on which the table was uploaded to the CarbonCrop platform."}},"type":"object","required":["data"],"title":"ParticipantSpecificTable","description":"Participant-specific carbon stock and sequestration estimates for an ETS registrant.\n\nA Participant Specific Table (PST) is produced from forest measurements collected\nusing the Field Measurement Approach (FMA). It provides estimates specific to the\nregistrant's forest land in place of MPI's default carbon tables.\n\nA PST is generally required when an ETS registrant has 100 hectares or more of\npost-1989 forest land.\n\nFor current eligibility and measurement requirements, see:\nhttps://www.mpi.govt.nz/forestry/forestry-in-the-emissions-trading-scheme/emissions-returns-and-carbon-units-nzus-for-forestry/measuring-your-forest-to-get-participant-specific-tables"},"PaymentResponseData":{"properties":{"invoice_id":{"type":"integer","title":"Invoice Id"},"amount":{"type":"string","title":"Amount","examples":["1","0.0","NaN"]},"currency":{"type":"string","title":"Currency"},"currency_rate":{"type":"string","title":"Currency Rate","examples":["1","0.0","NaN"]},"status":{"$ref":"#/components/schemas/PaymentStatus"},"payment_id":{"type":"integer","title":"Payment Id"}},"type":"object","required":["invoice_id","amount","currency","currency_rate","status","payment_id"],"title":"PaymentResponseData","description":"Data module for payment."},"PaymentStatus":{"type":"string","enum":["pending","started","cleared","cancelled"],"title":"PaymentStatus","description":"Payment status."},"PaymentStatusUpdateRequest":{"properties":{"status":{"$ref":"#/components/schemas/PaymentStatus"}},"type":"object","required":["status"],"title":"PaymentStatusUpdateRequest","description":"Request data module for payment status update."},"PendingCAAReturn":{"properties":{"intent":{"anyOf":[{"type":"string","enum":["include"],"const":"include"},{"type":"string","enum":["skip"],"const":"skip"}],"title":"Intent"},"filed":{"type":"boolean","enum":[false],"const":false,"title":"Filed"},"year":{"type":"integer","title":"Year"}},"type":"object","required":["intent","filed","year"],"title":"PendingCAAReturn","description":"An emissions return for a CAA that has not yet been filed."},"Per2023Properties":{"properties":{"prepare":{"anyOf":[{"$ref":"#/components/schemas/PerPrepare"},{"type":"null"}]},"landholder_input":{"anyOf":[{"$ref":"#/components/schemas/PerLandholderInput"},{"type":"null"}]},"process_changes":{"anyOf":[{"$ref":"#/components/schemas/PerProcessChanges"},{"type":"null"}]},"submission":{"anyOf":[{"$ref":"#/components/schemas/PerEmissionReturn"},{"type":"null"}]},"invoice_uploaded_to_google_drive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Invoice Uploaded To Google Drive"}},"type":"object","title":"Per2023Properties","description":"PER 2023 data model."},"Per2023Task":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"task_type":{"type":"string","enum":["per"],"const":"per","title":"Task Type"},"status":{"type":"string","enum":["no_per","prepare","landholder_input","process_changes","submit","finish"],"title":"Status"},"properties":{"anyOf":[{"$ref":"#/components/schemas/PerTaskProperties"},{"type":"null"}]}},"type":"object","required":["uuid","customer_id","task_type","status"],"title":"Per2023Task","description":"Represents a Provisional Emissions Return (PER)"},"Per2024Task":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"task_type":{"type":"string","enum":["per.2024"],"const":"per.2024","title":"Task Type"},"status":{"type":"string","enum":["no_per","prepare","landholder_input","process_changes","submit","finish"],"title":"Status"},"properties":{"anyOf":[{"$ref":"#/components/schemas/PerTaskProperties"},{"type":"null"}]}},"type":"object","required":["uuid","customer_id","task_type","status"],"title":"Per2024Task","description":"Represents a Provisional Emissions Return (PER) 2024"},"PerChange":{"properties":{"has_change":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Change"},"change_details":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Change Details"}},"type":"object","title":"PerChange","description":"PER change data model.\n\nSome information we want about the PER is about certain types of land change. If there are changes\nwe want more information from the user (ie a free text field), but if there are no changes then we don't.\n\nThis data model provides a way to record if there are changes, and if so what they are."},"PerConfirmation":{"properties":{"confirmed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Confirmed"},"lost_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lost Reason"}},"type":"object","title":"PerConfirmation","description":"Does the landowner want us to file a PER for them?\nIf not, why not?\n\nGenerally we expect that users will want us to file a PER for the\nas it results in a higher payment. So if they don't want us to, we want to\nknow why."},"PerDisplayConfig":{"properties":{"enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enabled","description":"Whether the company can file PERs on behalf of its sites."},"show_landholder_confirmation":{"type":"boolean","title":"Show Landholder Confirmation","description":"Whether to show the landholder confirmation step in the PER workflow. If a company is managing sites that it owns, this can be set to false. If a company is providing a service to external customers, this should be enabled."}},"type":"object","required":["show_landholder_confirmation"],"title":"PerDisplayConfig","description":"Controls how a company handles Provisional Emissions Returns (PERs)."},"PerEmail":{"properties":{"to":{"$ref":"#/components/schemas/User"},"email_date":{"type":"string","title":"Email Date"},"status":{"anyOf":[{"type":"string","enum":["sent"],"const":"sent"},{"type":"string","enum":["opened"],"const":"opened"},{"type":"string","enum":["completed"],"const":"completed"},{"type":"string","enum":["bounced"],"const":"bounced"},{"type":"string","enum":["error"],"const":"error"}],"title":"Status"}},"type":"object","required":["to","email_date","status"],"title":"PerEmail","description":"PER 2023 email sending record data model."},"PerEmailPost":{"properties":{"email":{"type":"string","title":"Email"},"task_uuid":{"type":"string","format":"uuid","title":"Task Uuid"}},"type":"object","required":["email","task_uuid"],"title":"PerEmailPost","description":"Data model for PER email invitation."},"PerEmissionReturn":{"properties":{"standard":{"anyOf":[{"$ref":"#/components/schemas/EmissionReturn"},{"type":"null"}]},"permanent":{"anyOf":[{"$ref":"#/components/schemas/EmissionReturn"},{"type":"null"}]}},"type":"object","title":"PerEmissionReturn","description":"PER emission return. THe two different accounting methods available require\nfiling separate emission returns."},"PerLandholderInput":{"properties":{"email_logs":{"items":{"$ref":"#/components/schemas/PerEmail"},"type":"array","title":"Email Logs","default":[]},"property_changes":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Property Changes"},"ownership_changes":{"$ref":"#/components/schemas/PerChange"},"forest_changes":{"$ref":"#/components/schemas/PerChange"},"caa_changes":{"$ref":"#/components/schemas/PerChange"},"additional_changes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Additional Changes"},"per_confirmation":{"$ref":"#/components/schemas/PerConfirmation"},"step_complete":{"anyOf":[{"$ref":"#/components/schemas/PerStepComplete"},{"type":"null"}]}},"type":"object","required":["ownership_changes","forest_changes","caa_changes","per_confirmation"],"title":"PerLandholderInput","description":"PER 2023 landholder input step data model.\n\nThis step is completed by the landowner, and records information that an account manager cannot\ndetermine by looking at aerial imagery."},"PerPrepare":{"properties":{"change_accounting_method":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Change Accounting Method"},"change_accounting_method_v2":{"anyOf":[{"type":"string","enum":["no"],"const":"no"},{"type":"string","enum":["to_be_changed"],"const":"to_be_changed"},{"type":"string","enum":["changed"],"const":"changed"},{"type":"null"}],"title":"Change Accounting Method V2"},"forest_loss_mapping":{"anyOf":[{"type":"string","enum":["no"],"const":"no"},{"type":"string","enum":["to_map"],"const":"to_map"},{"type":"string","enum":["mapped"],"const":"mapped"},{"type":"null"}],"title":"Forest Loss Mapping"},"file_per":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"File Per"},"step_complete":{"anyOf":[{"$ref":"#/components/schemas/PerStepComplete"},{"type":"null"}]}},"type":"object","title":"PerPrepare","description":"The initial setup step of the PER. This records if there are\nany issues with the land that would prevent us from filing a PER."},"PerProcessChanges":{"properties":{"property_changes":{"anyOf":[{"$ref":"#/components/schemas/ProcessPropertyChanges"},{"type":"null"}]},"ownership_changes":{"anyOf":[{"$ref":"#/components/schemas/ProcessOwnershipChanges"},{"type":"null"}]},"forest_changes":{"anyOf":[{"$ref":"#/components/schemas/ProcessForestChanges"},{"type":"null"}]},"caa_changes":{"anyOf":[{"$ref":"#/components/schemas/ProcessCaaChanges"},{"type":"null"}]},"additional_changes":{"anyOf":[{"$ref":"#/components/schemas/ProcessAdditionalChanges"},{"type":"null"}]},"step_complete":{"anyOf":[{"$ref":"#/components/schemas/PerStepComplete"},{"type":"null"}]}},"type":"object","title":"PerProcessChanges","description":"PER process changes step data model.\n\nThis comes after the landowner survey, and contains the tasks that the landowner has to do in\ndirect response to the landowner survey."},"PerProperties":{"properties":{"y2023":{"$ref":"#/components/schemas/Per2023Properties"}},"type":"object","required":["y2023"],"title":"PerProperties","description":"PER properties for different years."},"PerStepComplete":{"properties":{"by":{"$ref":"#/components/schemas/User"},"date":{"type":"string","title":"Date"}},"type":"object","required":["by","date"],"title":"PerStepComplete","description":"PER 2023 step completion data.\n\nFor some PER steps it is necessary to record who completed the step and when.\nFor example if the land is owned by a trust, which user filled in the landowner survey?\nThis allows auditing of the process, and knowing who to contact if there are any questions or issues.\nThis can also be used for internal-only-steps, if there are more review processes."},"PerTaskProperties":{"properties":{"comments":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/Comment"},{"type":"string"}]},"type":"array"},{"type":"null"}],"title":"Comments"},"parent_task_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Parent Task Id"},"sub_task_index":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Sub Task Index"},"prepare":{"anyOf":[{"$ref":"#/components/schemas/PerPrepare"},{"type":"null"}]},"landholder_input":{"anyOf":[{"$ref":"#/components/schemas/PerLandholderInput"},{"type":"null"}]},"process_changes":{"anyOf":[{"$ref":"#/components/schemas/PerProcessChanges"},{"type":"null"}]},"submission":{"anyOf":[{"$ref":"#/components/schemas/PerEmissionReturn"},{"type":"null"}]},"invoice_uploaded_to_google_drive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Invoice Uploaded To Google Drive"}},"type":"object","title":"PerTaskProperties","description":"Note that the PER task properties."},"PhotoArchivedBody":{"properties":{"archived":{"type":"boolean","title":"Archived"}},"type":"object","required":["archived"],"title":"PhotoArchivedBody"},"PhotoPointProperties":{"properties":{"point_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Point Number"}},"type":"object","title":"PhotoPointProperties"},"PhotoTakenProperties":{"properties":{"file_name":{"type":"string","title":"File Name"},"file_id":{"type":"string","title":"File Id"},"archived":{"type":"boolean","title":"Archived"},"upload_date":{"type":"string","format":"date-time","title":"Upload Date"},"taken_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Taken Date"}},"type":"object","required":["file_name","file_id","archived","upload_date"],"title":"PhotoTakenProperties"},"PlantingEvent":{"properties":{"event_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Event Id"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"event_type":{"type":"string","enum":["planting"],"const":"planting","title":"Event Type"},"species":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Species"},"species_percentage":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Species Percentage"},"ets_species":{"anyOf":[{"type":"string","enum":["douglas_fir"],"const":"douglas_fir"},{"type":"string","enum":["exotic_hardwood"],"const":"exotic_hardwood"},{"type":"string","enum":["exotic_softwood"],"const":"exotic_softwood"},{"type":"string","enum":["indigenous"],"const":"indigenous"},{"type":"string","enum":["pinus_radiata"],"const":"pinus_radiata"},{"type":"string","enum":["radiata"],"const":"radiata"},{"type":"null"}],"title":"Ets Species"},"additional_species":{"anyOf":[{"items":{"$ref":"#/components/schemas/AdditionalSpecies"},"type":"array"},{"type":"null"}],"title":"Additional Species"},"planting_status":{"anyOf":[{"type":"string","enum":["draft","confirmed","planted"]},{"type":"null"}],"title":"Planting Status"},"plants_per_hectare":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Plants Per Hectare"},"plants_spacing_width":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Plants Spacing Width"},"plants_spacing_length":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Plants Spacing Length"},"stem_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Stem Count","description":"The number of stems that were planted. THis is only required for some species"},"establishment_cost_per_hectare":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Establishment Cost Per Hectare"},"establishment_method":{"anyOf":[{"$ref":"#/components/schemas/EstablishmentMethod"},{"type":"null"}],"description":"The method used to establish the forest"}},"type":"object","required":["event_type"],"title":"PlantingEvent","description":"Putting plants in the ground: When you dig a hole and put a seedling in it."},"Point":{"properties":{"type":{"type":"string","enum":["Point"],"const":"Point","title":"Type"},"coordinates":{"anyOf":[{"prefixItems":[{"type":"number"},{"type":"number"}],"type":"array","maxItems":2,"minItems":2},{"prefixItems":[{"type":"number"},{"type":"number"},{"type":"number"}],"type":"array","maxItems":3,"minItems":3},{"type":"array","maxItems":0,"minItems":0}],"title":"Coordinates"}},"type":"object","required":["type","coordinates"],"title":"Point"},"Polygon":{"properties":{"type":{"type":"string","enum":["Polygon"],"const":"Polygon","title":"Type"},"coordinates":{"items":{"items":{"anyOf":[{"prefixItems":[{"type":"number"},{"type":"number"}],"type":"array","maxItems":2,"minItems":2},{"prefixItems":[{"type":"number"},{"type":"number"},{"type":"number"}],"type":"array","maxItems":3,"minItems":3}]},"type":"array"},"type":"array","title":"Coordinates"}},"type":"object","required":["type","coordinates"],"title":"Polygon"},"Position":{"properties":{"longitude":{"type":"number","maximum":180.0,"minimum":-180.0,"title":"Longitude"},"latitude":{"type":"number","maximum":90.0,"minimum":-90.0,"title":"Latitude"}},"type":"object","required":["longitude","latitude"],"title":"Position"},"Pre2007DeforestationReportTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["pre_2007_deforestation_report"],"const":"pre_2007_deforestation_report","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"Pre2007DeforestationReportTask"},"PrefectState":{"properties":{"type":{"$ref":"#/components/schemas/StateType"}},"type":"object","required":["type"],"title":"PrefectState"},"PrepareForestryRightsTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["prepare_forestry_rights"],"const":"prepare_forestry_rights","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"PrepareForestryRightsTask"},"ProcessAdditionalChanges":{"properties":{"confirmed":{"type":"boolean","title":"Confirmed","default":false},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"}},"type":"object","title":"ProcessAdditionalChanges","description":"Process additional changes. This is related to the `additional_changes` field in the landowner survey"},"ProcessCaaChanges":{"properties":{"confirmed":{"type":"boolean","title":"Confirmed","default":false},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"processed":{"type":"boolean","title":"Processed","default":false}},"type":"object","title":"ProcessCaaChanges","description":"Process CAA removal changes. This is related to the `caa_changes` field in the landowner survey"},"ProcessForestChanges":{"properties":{"confirmed":{"type":"boolean","title":"Confirmed","default":false},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"shapefile_uploaded":{"type":"boolean","title":"Shapefile Uploaded","default":false},"request_submitted":{"type":"boolean","title":"Request Submitted","default":false},"selected_activities":{"items":{"$ref":"#/components/schemas/TupuAkeActivityBase"},"type":"array","title":"Selected Activities","default":[]}},"type":"object","title":"ProcessForestChanges","description":"Process forest details changes. This is related to the `forest_changes` field in the landowner survey"},"ProcessOwnershipChanges":{"properties":{"confirmed":{"type":"boolean","title":"Confirmed","default":false},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"processed":{"type":"boolean","title":"Processed","default":false}},"type":"object","title":"ProcessOwnershipChanges","description":"Process ownership changes. This is related to the `ownership_changes` field in the landowner survey"},"ProcessPropertyChanges":{"properties":{"confirmed":{"type":"boolean","title":"Confirmed","default":false},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"transfer_form_completed":{"type":"boolean","title":"Transfer Form Completed","default":false},"request_submitted_and_paid":{"type":"boolean","title":"Request Submitted And Paid","default":false}},"type":"object","title":"ProcessPropertyChanges","description":"Process property changes, such as land being subdivided or sold."},"PropertyProperties":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"User-facing name of the site."},"company_customer_tag":{"anyOf":[{"$ref":"#/components/schemas/CompanyCustomerTags"},{"type":"null"}],"description":"Relationship through which the requested company manages or accesses the site."},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee","description":"ID of the company user responsible for progressing work on the site and communicating with its landholder."},"mpi_report":{"anyOf":[{"$ref":"#/components/schemas/EtrAccount"},{"type":"null"}],"description":"Minimal data about the site's MPI evidence report."},"customer_relationship_metadata":{"anyOf":[{"$ref":"#/components/schemas/CompanyCustomerRelationshipData"},{"type":"null"}],"description":"Company-controlled metadata about its relationship with the site."}},"type":"object","title":"PropertyProperties","description":"Site properties included in a compact site summary."},"PropertyTypes":{"anyOf":[{"type":"object"},{"$ref":"#/components/schemas/BaseModel"},{"type":"null"}]},"QueryCreditNoteResponse":{"properties":{"customer_id":{"type":"integer","title":"Customer Id"},"credit_note_id":{"type":"string","title":"Credit Note Id"},"date":{"type":"string","format":"date","title":"Date"},"description":{"type":"string","title":"Description"},"total":{"type":"number","title":"Total"}},"type":"object","required":["customer_id","credit_note_id","date","description","total"],"title":"QueryCreditNoteResponse","description":"Response data module for credit note query."},"Range":{"properties":{"min":{"type":"number","title":"Min"},"max":{"type":"number","title":"Max"}},"type":"object","required":["min","max"],"title":"Range","description":"Wrapper class for a numerical range defined by a minimum and a maximum."},"RasterColorRangeLegend":{"properties":{"start_color":{"type":"string","title":"Start Color"},"end_color":{"type":"string","title":"End Color"},"steps":{"type":"integer","maximum":20.0,"minimum":2.0,"title":"Steps"},"min":{"type":"number","title":"Min"},"max":{"type":"number","title":"Max"},"units":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Units"},"description":{"type":"string","title":"Description"},"tick_labels":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tick Labels"}},"type":"object","required":["start_color","end_color","steps","min","max","description"],"title":"RasterColorRangeLegend","description":"A stepped colour ramp from ``start_color`` to ``end_color`` over a numeric axis.\n\nThe axis runs from ``min`` to ``max`` with a tick at every step boundary, so\nthe ``steps + 1`` tick values are evenly spaced (min 0, max 6, 3 steps →\n0, 2, 4, 6)."},"RasterLegendEntry":{"properties":{"color":{"type":"string","title":"Color"},"description":{"type":"string","title":"Description"}},"type":"object","required":["color","description"],"title":"RasterLegendEntry","description":"One swatch in a user-defined legend for a custom raster layer."},"RawLocalPdfJobResponse":{"properties":{"data":{"$ref":"#/components/schemas/LocalPdfJobData"}},"type":"object","required":["data"],"title":"RawLocalPdfJobResponse"},"RedisCacheEntry":{"properties":{"key":{"type":"string","title":"Key"},"value":{"type":"string","title":"Value"},"ttl_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Ttl Seconds"}},"type":"object","required":["key","value"],"title":"RedisCacheEntry"},"RegisterLandToEtsTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericNotesTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["register_land_to_ets"],"const":"register_land_to_ets","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"RegisterLandToEtsTask"},"RemoveLandFromEtsTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericNotesTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["remove_land_from_ets"],"const":"remove_land_from_ets","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"RemoveLandFromEtsTask"},"ReportInfo":{"properties":{"name":{"type":"string","title":"Name"}},"type":"object","required":["name"],"title":"ReportInfo"},"RequestedPhotoLayerProperties":{"properties":{"version_created":{"anyOf":[{"$ref":"#/components/schemas/VersionData"},{"type":"null"}]},"data_type":{"anyOf":[{"type":"string","enum":["geojson"],"const":"geojson"},{"type":"null"}],"title":"Data Type","default":"geojson"},"type":{"type":"string","enum":["requested_photo_points"],"const":"requested_photo_points","title":"Type"}},"additionalProperties":false,"type":"object","required":["type"],"title":"RequestedPhotoLayerProperties","description":"The segments layer is the main set of polygons for the project,\nthey are used for reports, analysis and other purposes."},"ResidualAndStock":{"properties":{"forest_type":{"$ref":"#/components/schemas/ForestTypeKey"},"stock":{"items":{"type":"number"},"type":"array","title":"Stock"},"residual":{"items":{"type":"number"},"type":"array","title":"Residual"}},"type":"object","required":["forest_type","stock","residual"],"title":"ResidualAndStock","description":"Carbon stock curves for a single forest type"},"RmaComplianceTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["rma_compliance"],"const":"rma_compliance","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"RmaComplianceTask"},"SegmentationMetadata":{"properties":{"version_id":{"type":"integer","title":"Version Id"},"user_id":{"type":"integer","title":"User Id"},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp"}},"type":"object","required":["version_id","user_id"],"title":"SegmentationMetadata","description":"Metadata about a segmentation layer: eg what version it is"},"SegmentationPostResponse":{"properties":{"messages":{"items":{"$ref":"#/components/schemas/UpdateSegmentMessage"},"type":"array","title":"Messages"},"metadata":{"$ref":"#/components/schemas/SegmentationMetadata"}},"type":"object","required":["messages","metadata"],"title":"SegmentationPostResponse","description":"Response data model for updating segmentation."},"SegmentsLayerProperties":{"properties":{"version_created":{"anyOf":[{"$ref":"#/components/schemas/VersionData"},{"type":"null"}]},"data_type":{"anyOf":[{"type":"string","enum":["geojson"],"const":"geojson"},{"type":"null"}],"title":"Data Type","default":"geojson"},"type":{"type":"string","enum":["segments"],"const":"segments","title":"Type"}},"additionalProperties":false,"type":"object","required":["type"],"title":"SegmentsLayerProperties","description":"The segments layer is the main set of polygons for the project,\nthey are used for reports, analysis and other purposes."},"SegmentsPrefectLayerProperties":{"properties":{"version_created":{"anyOf":[{"$ref":"#/components/schemas/VersionData"},{"type":"null"}]},"data_type":{"anyOf":[{"type":"string","enum":["geojson"],"const":"geojson"},{"type":"null"}],"title":"Data Type","default":"geojson"},"type":{"type":"string","enum":["segments-prefect"],"const":"segments-prefect","title":"Type"},"imagery_source":{"type":"null","title":"Imagery Source"},"model_id":{"type":"string","title":"Model Id"}},"additionalProperties":false,"type":"object","required":["type","imagery_source","model_id"],"title":"SegmentsPrefectLayerProperties","description":"The segments layer is the main set of polygons for the project,\nthey are used for reports, analysis and other purposes."},"SendInvoiceRequest":{"properties":{"to":{"items":{"type":"string"},"type":"array","title":"To"},"task_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Task Id"},"is_resend":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Resend","default":false}},"type":"object","required":["to"],"title":"SendInvoiceRequest","description":"Request data for sending invoice email."},"ShapefileConversion":{"properties":{"geometry":{"$ref":"#/components/schemas/FeatureCollection_IdTypes_GeometryTypes_dict_str__Any__NoneType_"},"shapefile_schema":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Shapefile Schema"},"shapefile_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Shapefile Name"}},"type":"object","required":["geometry"],"title":"ShapefileConversion"},"SignOffTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["sign_off"],"const":"sign_off","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"SignOffTask"},"SimpleTaskStatus":{"type":"string","enum":["todo","in_progress","review","done","cancelled"],"title":"SimpleTaskStatus"},"SingleFeatureMeasures":{"properties":{"properties":{"$ref":"#/components/schemas/FeatureMeasureProperties"},"measures":{"items":{"$ref":"#/components/schemas/DimsAndMeasures"},"type":"array","title":"Measures"}},"type":"object","required":["properties","measures"],"title":"SingleFeatureMeasures","description":"A single feature with its properties and measures."},"SiteBoundaryFeatureProperties":{"properties":{"title_no":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title No"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"owners":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owners"},"title_area":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Title Area"},"title_list":{"anyOf":[{"items":{"$ref":"#/components/schemas/TitleProperties"},"type":"array"},{"type":"null"}],"title":"Title List"}},"type":"object","title":"SiteBoundaryFeatureProperties","description":"The site boundary layer user title geometry data as layer feature.\n\nNOTE: OLD title properties for non-dissolved site boundary layer\nand it will be removed after data migration"},"SiteBoundaryLayerProperties":{"properties":{"version_created":{"anyOf":[{"$ref":"#/components/schemas/VersionData"},{"type":"null"}]},"data_type":{"anyOf":[{"type":"string","enum":["geojson"],"const":"geojson"},{"type":"null"}],"title":"Data Type","default":"geojson"},"type":{"type":"string","enum":["site_boundary"],"const":"site_boundary","title":"Type"}},"additionalProperties":false,"type":"object","required":["type"],"title":"SiteBoundaryLayerProperties","description":"The site boundary layer is the main set of polygons for the project,\nthey are used for reports, analysis and other purposes."},"SiteCreateActions":{"properties":{"trigger_unity_flow":{"type":"boolean","title":"Trigger Unity Flow","description":"Whether to run the initial carbon-stock estimation pipeline for a new site.","default":true}},"type":"object","title":"SiteCreateActions","description":"Automated actions to perform when a site is created for the company."},"SitePointProperty":{"properties":{"customer_id":{"type":"integer","title":"Customer Id"}},"type":"object","required":["customer_id"],"title":"SitePointProperty","description":"Feature property of site point."},"SiteSummary":{"properties":{"site_area_m2":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Site Area M2","description":"Total area within the site boundary, in square metres."},"location":{"anyOf":[{"$ref":"#/components/schemas/Location"},{"type":"null"}],"description":"Area-weighted centre of the site's boundary polygons."},"company_share_proportion":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Company Share Proportion","description":"Proportion of carbon revenue allocated to the carbon manager as payment for its services, from 0 to 1. For example, 0.15 represents 15%."},"customer_id":{"type":"integer","title":"Customer Id","description":"Unique identifier of the site."},"create_time":{"type":"string","format":"date-time","title":"Create Time","description":"Approximate time when the site was created."},"edit_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Edit Time","description":"Approximate time of the site's latest edit, such as a change to its polygons."},"measures":{"additionalProperties":{"$ref":"#/components/schemas/Measures"},"type":"object","title":"Measures","description":"Measures for areas of the site, keyed by IDs in the response's dimensions dictionary."},"properties":{"allOf":[{"$ref":"#/components/schemas/PropertyProperties"}],"description":"Site and company-site relationship properties included in the summary."},"economics_cache_update_start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Economics Cache Update Start Time","description":"Time when the latest calculation of the site's cached analytical measures started."},"economics_cache_update_end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Economics Cache Update End Time","description":"Time when the latest calculation of the site's cached analytical measures completed."}},"type":"object","required":["customer_id","create_time","edit_time","measures","properties"],"title":"SiteSummary","description":"Compact site details and analytical measures grouped by dimension. Note that the words Site and Customer are synonmous."},"SiteWithDimensions":{"properties":{"site":{"allOf":[{"$ref":"#/components/schemas/SiteSummary"}],"description":"Compact summary of the site."},"dimensions":{"additionalProperties":{"$ref":"#/components/schemas/Dimensions"},"type":"object","title":"Dimensions","description":"Land classifications keyed by the IDs referenced from the site's measures."},"start_year":{"type":"integer","title":"Start Year","description":"Calendar year represented by index zero of each annual carbon-yield array."}},"type":"object","required":["site","dimensions","start_year"],"title":"SiteWithDimensions","description":"A compact site summary and the dimensions referenced by its measures."},"SitesListResponse":{"properties":{"sites":{"items":{"$ref":"#/components/schemas/SiteSummary"},"type":"array","title":"Sites","description":"Compact summaries of sites associated with the company."},"dimensions":{"additionalProperties":{"$ref":"#/components/schemas/Dimensions"},"type":"object","title":"Dimensions","description":"Reusable land classifications keyed by the IDs referenced from each site's measures."},"start_year":{"type":"integer","title":"Start Year","description":"Calendar year represented by index zero of each annual carbon-yield array."}},"type":"object","required":["sites","dimensions","start_year"],"title":"SitesListResponse","description":"Compact summaries of sites associated with a company.\n\nDimension combinations are defined once in ``dimensions`` so they can be shared\nby many sites. Each key in a site's ``measures`` dictionary refers to the same key\nin ``dimensions``. For example:\n\n\"dimensions\": {\n    \"1\": { \"forest_type\": \"native\"},\n    \"2\": { \"forest_type\": \"exotic\"}\n},\n\"sites\": [\n    {\n        \"customer_id\": 1,\n        \"measures\": {\n            \"1\": { \"aea\": 100 },\n            \"2\": { \"aea\": 13 }\n        }\n    }\n]"},"SourceDataLayerProperties":{"properties":{"style":{"anyOf":[{"$ref":"#/components/schemas/StyleSpecification"},{"type":"null"}]},"version_created":{"anyOf":[{"$ref":"#/components/schemas/VersionData"},{"type":"null"}]},"data_type":{"anyOf":[{"type":"string","enum":["geojson"],"const":"geojson"},{"type":"null"}],"title":"Data Type","default":"geojson"},"type":{"type":"string","enum":["source_data"],"const":"source_data","title":"Type"},"name":{"type":"string","title":"Name"}},"additionalProperties":false,"type":"object","required":["type","name"],"title":"SourceDataLayerProperties","description":"General purpose layer that is used to store source data for a project.\nThis may include things like the original data that was used to\ndetermine the boundary of the project."},"SourceName":{"type":"string","enum":["mapbox_imagery","linz_base_map","linz_topographical","linz_aerial_imagery","linz_historical_imagery","retrolens","retrolens_hd","retrolens_hd_survey","planet_imagery","landsat_imagery","linz_scanned_pre_1990","linz_scanned_post_1989"]},"StateType":{"type":"string","enum":["SCHEDULED","PENDING","RUNNING","COMPLETED","FAILED","CANCELLED","CRASHED","PAUSED","CANCELLING"],"title":"StateType"},"StepComplete":{"properties":{"by":{"$ref":"#/components/schemas/User"},"date":{"type":"string","title":"Date"}},"type":"object","required":["by","date"],"title":"StepComplete","description":"Task step completion data.\n\nFor some task steps it is necessary to record who completed the step and when.\nFor example if the land is owned by a trust, which user filled in the landowner survey?\nThis allows auditing of the process, and knowing who to contact if there are any questions or issues.\nThis can also be used for internal-only-steps, if there are more review processes."},"StyleSpecification":{"properties":{"layers":{"items":{"oneOf":[{"$ref":"#/components/schemas/FillLayer"},{"$ref":"#/components/schemas/LineLayer"},{"$ref":"#/components/schemas/CircleLayer"}],"discriminator":{"propertyName":"type","mapping":{"circle":"#/components/schemas/CircleLayer","fill":"#/components/schemas/FillLayer","line":"#/components/schemas/LineLayer"}}},"type":"array","title":"Layers"}},"type":"object","required":["layers"],"title":"StyleSpecification","description":"Subset of Mapbox style used for vector layer styling."},"SubmitApplicationTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["submit_application"],"const":"submit_application","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"SubmitApplicationTask"},"TagMetadata":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid","description":"Unique identifier"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"User-facing display name"},"color":{"anyOf":[{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},{"type":"null"}],"title":"Color","description":"Display colour for the tag as a six-digit hexadecimal value, such as '#3A7F5C'."}},"type":"object","required":["uuid","name"],"title":"TagMetadata","description":"Information describing a tag"},"TaskCreateActions":{"properties":{"forest_details_confirmation":{"type":"boolean","title":"Forest Details Confirmation","description":"Whether users may create a forest-details-confirmation task. This task allows a landholder to review the species and establishment years of forests on their land.","default":false}},"type":"object","title":"TaskCreateActions","description":"Task types that users may create for the company's sites."},"TitleProperties":{"properties":{"title_no":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title No"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"owners":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owners"},"title_area":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Title Area"}},"type":"object","title":"TitleProperties","description":"NT Title properties."},"TitleWithOwner":{"properties":{"title_no":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title No"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"total_area_m2":{"type":"number","title":"Total Area M2"},"owner_list":{"items":{"type":"string"},"type":"array","title":"Owner List"},"parcel_list":{"items":{"type":"string"},"type":"array","title":"Parcel List"}},"type":"object","required":["title_no","total_area_m2","owner_list","parcel_list"],"title":"TitleWithOwner"},"TitlesResponse":{"properties":{"title_list":{"items":{"$ref":"#/components/schemas/TitleWithOwner"},"type":"array","title":"Title List"}},"type":"object","required":["title_list"],"title":"TitlesResponse"},"TokenResponse":{"properties":{"token":{"type":"string","title":"Token"}},"type":"object","required":["token"],"title":"TokenResponse"},"TransferEtsParticipationTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericNotesTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["transfer_ets_participation"],"const":"transfer_ets_participation","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"TransferEtsParticipationTask"},"TransferNzusProcess":{"properties":{"transfer_status":{"anyOf":[{"$ref":"#/components/schemas/TransferNzusStatus"},{"type":"null"}]},"email_logs":{"anyOf":[{"items":{"$ref":"#/components/schemas/PerEmail"},"type":"array"},{"type":"null"}],"title":"Email Logs"},"transfer_complete":{"anyOf":[{"$ref":"#/components/schemas/StepComplete"},{"type":"null"}]}},"type":"object","title":"TransferNzusProcess","description":"Represents the processing of a transfer NZUs task."},"TransferNzusProcessRequest":{"properties":{"transfer_status":{"anyOf":[{"$ref":"#/components/schemas/TransferNzusStatus"},{"type":"null"}]},"task_status":{"$ref":"#/components/schemas/SimpleTaskStatus"}},"type":"object","required":["task_status"],"title":"TransferNzusProcessRequest","description":"Represents the processing of a transfer NZUs task."},"TransferNzusRequest":{"properties":{"account_from":{"anyOf":[{"$ref":"#/components/schemas/NzuTransferAccount"},{"type":"null"}]},"account_to":{"anyOf":[{"$ref":"#/components/schemas/NzuTransferAccount"},{"type":"null"}]},"transfer_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Transfer Amount"},"request_complete":{"anyOf":[{"$ref":"#/components/schemas/StepComplete"},{"type":"null"}]},"request_email_log":{"anyOf":[{"$ref":"#/components/schemas/EmailLog"},{"type":"null"}]}},"type":"object","title":"TransferNzusRequest","description":"Represents a request to transfer NZUs from one NZETR account to another."},"TransferNzusStatus":{"type":"string","enum":["prepared","completed","cancelled"],"title":"TransferNzusStatus","description":"Represents the status of the transfer NZUs task."},"TransferNzusSubmission":{"properties":{"request_complete":{"$ref":"#/components/schemas/StepComplete"}},"type":"object","required":["request_complete"],"title":"TransferNzusSubmission","description":"Represents the submission of a transfer NZUs task, which sets the task ready for processing."},"TransferNzusTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericNotesTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["transfer_nzus"],"const":"transfer_nzus","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"TransferNzusTask"},"TransferNzusTaskEmailRequest":{"properties":{"send_to":{"$ref":"#/components/schemas/User"},"notified_by":{"$ref":"#/components/schemas/User"}},"type":"object","required":["send_to","notified_by"],"title":"TransferNzusTaskEmailRequest","description":"Represents the notification details for a transfer NZUs task."},"TransferNzusTaskProperties":{"properties":{"comments":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/Comment"},{"type":"string"}]},"type":"array"},{"type":"null"}],"title":"Comments"},"parent_task_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Parent Task Id"},"sub_task_index":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Sub Task Index"},"request_data":{"anyOf":[{"$ref":"#/components/schemas/TransferNzusRequest"},{"type":"null"}]},"process_data":{"anyOf":[{"$ref":"#/components/schemas/TransferNzusProcess"},{"type":"null"}]}},"type":"object","title":"TransferNzusTaskProperties","description":"Properties for the Transfer NZUs task."},"TransferNzusTaskV2":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"task_type":{"type":"string","enum":["transfer_nzus_v2"],"const":"transfer_nzus_v2","title":"Task Type"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"$ref":"#/components/schemas/TransferNzusTaskProperties"}},"type":"object","required":["uuid","customer_id","task_type","status","properties"],"title":"TransferNzusTaskV2","description":"Represents a task for transferring NZUs from NZETR account to another."},"TreeWeedCalculatorTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["tree_weed_calculator"],"const":"tree_weed_calculator","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"TreeWeedCalculatorTask"},"TupuAkeActivityBase":{"properties":{"operation_type_id":{"$ref":"#/components/schemas/TupuakeOperationId"},"ets_caa_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Ets Caa Number"},"operation_date":{"type":"string","title":"Operation Date"}},"type":"object","required":["operation_type_id","operation_date"],"title":"TupuAkeActivityBase","description":"Data model to identify an activity in Tupu-Ake.\nThis is used to record if certain activities have been completed in Tupu-Ake, such as submitting a service request or filing a PER."},"TupuAkeForestTypeId":{"type":"integer","enum":[1,2,3,4,6],"title":"TupuAkeForestTypeId"},"TupuAkePredominantSpeciesId":{"type":"integer","enum":[1,2,3,4,5,6,7,8,9,10,24,22,25,11,12,13,14,15,16,17,18,26,27,19,20],"title":"TupuAkePredominantSpeciesId"},"TupuAkeTreeSpeciesId":{"type":"integer","enum":[8,9,10,175,11,13,176,177,178,179,180,14,15,181,182,183,184,185,16,186,17,19,187,188,189,22,23,24,25,26,190,32,33,34,35,36,37,38,39,40,192,193,41,194,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,195,67,197,173,68,198,199,69,200,201,70,202,71,72,174,73,203,204,205,206,74,207,75,77,80,208,209,82,83,84,210,211,212,213,85,86,87,88,89,214,215,216,90,217,218,91,92,93,94,95,96,219,220,97,98,99,100,101,102,103,104,105,221,222,223,106,107,108,109,110,111,112,131,132,135,136,137,138,139,140,224,142,143,144,145,146,147,148,149,151,225,152,153,154,155,156,226,157,227,161,228,229,230,231,232,233,234,163,164,235,236,165,166,237,168,238,169,170,171,239,240,241,242,243,244,245],"title":"TupuAkeTreeSpeciesId"},"TupuakeOperationId":{"type":"integer","enum":[1,2,3],"title":"TupuakeOperationId"},"UnitBalance":{"properties":{"unit_balance":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Unit Balance"},"unit_balance_updated":{"anyOf":[{"$ref":"#/components/schemas/PerStepComplete"},{"type":"null"}]}},"type":"object","title":"UnitBalance","description":"Unit balance data."},"UpdateCaaToSubmittedTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["update_caa_to_submitted"],"const":"update_caa_to_submitted","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"UpdateCaaToSubmittedTask"},"UpdateSegmentMessage":{"properties":{"feature_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Feature Id"},"code":{"type":"string","title":"Code"},"detail":{"type":"string","title":"Detail"}},"type":"object","required":["code","detail"],"title":"UpdateSegmentMessage","description":"Message data Model for segment layer update."},"UploadEvidenceTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["upload_evidence"],"const":"upload_evidence","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"UploadEvidenceTask"},"UploadRegisteredShapefileTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["upload_registered_shapefile"],"const":"upload_registered_shapefile","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"UploadRegisteredShapefileTask"},"User":{"properties":{"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"}},"type":"object","title":"User","description":"Reference to a user in our DB"},"UserCompanyRelations":{"properties":{"company_id":{"type":"integer","title":"Company Id"},"company_name":{"type":"string","title":"Company Name"},"branding":{"anyOf":[{"$ref":"#/components/schemas/CompanyBranding"},{"type":"null"}]},"tags":{"items":{"$ref":"#/components/schemas/CompanyUserTags"},"type":"array","title":"Tags"}},"type":"object","required":["company_id","company_name","tags"],"title":"UserCompanyRelations","description":"Response for creating a user."},"UserInfoCustomerTagsResponse":{"properties":{"user_id":{"type":"integer","title":"User Id"},"email":{"type":"string","title":"Email"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name"},"status":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Status"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"properties":{"$ref":"#/components/schemas/UserProperties"},"user_customer_tags":{"items":{"$ref":"#/components/schemas/CustomerUserTags"},"type":"array","title":"User Customer Tags"}},"type":"object","required":["user_id","email","first_name","last_name","tags","properties","user_customer_tags"],"title":"UserInfoCustomerTagsResponse","description":"Add the specific tags for a customer to the user information"},"UserInfoResponse":{"properties":{"user_id":{"type":"integer","title":"User Id"},"email":{"type":"string","title":"Email"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name"},"status":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Status"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"properties":{"$ref":"#/components/schemas/UserProperties"}},"type":"object","required":["user_id","email","first_name","last_name","tags","properties"],"title":"UserInfoResponse","description":"Detailed information about a single user"},"UserPost":{"properties":{"email":{"type":"string","title":"Email"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name"}},"type":"object","required":["email"],"title":"UserPost","description":"User data for query/create user.\n\nOnly email is required when querying a existing user."},"UserPostWithMobile":{"properties":{"email":{"type":"string","title":"Email"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name"},"mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile"}},"type":"object","required":["email"],"title":"UserPostWithMobile","description":"User data for query/create user with mobile."},"UserProperties":{"properties":{"notification_settings":{"allOf":[{"$ref":"#/components/schemas/NotificationSettings"}],"default":{"mention":{"email":true},"assigned_task_status_change":{"email":true},"assigned_task_assignee_change":{"email":true},"assigned_task_subtask_assignee_change":{"email":true},"assigned_task_subtask_status_change":{"email":true}}}},"type":"object","title":"UserProperties","description":"User properties data model."},"UserPut":{"properties":{"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name"},"properties":{"anyOf":[{"$ref":"#/components/schemas/UserProperties"},{"type":"null"}]}},"type":"object","title":"UserPut","description":"User data for updating user."},"UserTagEnum":{"type":"string","enum":["carboncrop_employee","all_sites_editor"],"title":"UserTagEnum","description":"User tags."},"UsersCompanyListResponse":{"properties":{"companies":{"items":{"$ref":"#/components/schemas/UserCompanyRelations"},"type":"array","title":"Companies"}},"type":"object","required":["companies"],"title":"UsersCompanyListResponse","description":"Response for creating a user."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VersionData":{"properties":{"user_id":{"type":"integer","title":"User Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"}},"type":"object","required":["user_id","timestamp"],"title":"VersionData","description":"Metadata about a version of a layer"},"VersionListModel":{"properties":{"customer_id":{"type":"integer","title":"Customer Id"},"layer_id":{"type":"integer","title":"Layer Id"},"version_list":{"items":{"$ref":"#/components/schemas/VersionModel_AllLayerProperties_"},"type":"array","title":"Version List"}},"type":"object","required":["customer_id","layer_id","version_list"],"title":"VersionListModel","description":"A list of version for a single layer"},"VersionModel_AllLayerProperties_":{"properties":{"version_id":{"type":"integer","title":"Version Id"},"properties":{"$ref":"#/components/schemas/AllLayerProperties"},"is_latest":{"type":"boolean","title":"Is Latest"}},"type":"object","required":["version_id","properties","is_latest"],"title":"VersionModel[AllLayerProperties]"},"VersionModel_Annotated_Union_CustomLayerProperties__CustomRasterCommonLayerProperties___FieldInfo_annotation_NoneType__required_True__discriminator__type____":{"properties":{"version_id":{"type":"integer","title":"Version Id"},"properties":{"oneOf":[{"$ref":"#/components/schemas/CustomLayerProperties"},{"$ref":"#/components/schemas/CustomRasterCommonLayerProperties"}],"title":"Properties","discriminator":{"propertyName":"type","mapping":{"custom_layer":"#/components/schemas/CustomLayerProperties","custom_raster_layer":"#/components/schemas/CustomRasterCommonLayerProperties"}}},"is_latest":{"type":"boolean","title":"Is Latest"}},"type":"object","required":["version_id","properties","is_latest"],"title":"VersionModel[Annotated[Union[CustomLayerProperties, CustomRasterCommonLayerProperties], FieldInfo(annotation=NoneType, required=True, discriminator='type')]]"},"VoluntaryCarbonProject":{"properties":{"id":{"type":"integer","title":"Id"},"properties":{"$ref":"#/components/schemas/VoluntaryCarbonProjectProperties"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"}},"type":"object","required":["id","properties"],"title":"VoluntaryCarbonProject"},"VoluntaryCarbonProjectListResponse":{"properties":{"projects":{"items":{"$ref":"#/components/schemas/VoluntaryCarbonProject"},"type":"array","title":"Projects"}},"type":"object","required":["projects"],"title":"VoluntaryCarbonProjectListResponse"},"VoluntaryCarbonProjectProperties":{"properties":{"name":{"type":"string","minLength":1,"title":"Name"},"scheme_version":{"type":"string","title":"Scheme Version"}},"additionalProperties":true,"type":"object","required":["name","scheme_version"],"title":"VoluntaryCarbonProjectProperties"},"VoluntaryCarbonProjectSaveRequest":{"properties":{"properties":{"$ref":"#/components/schemas/VoluntaryCarbonProjectProperties"},"slots":{"additionalProperties":{"$ref":"#/components/schemas/VoluntaryCarbonProjectSlotStored_1_0_2"},"type":"object","title":"Slots"}},"additionalProperties":false,"type":"object","required":["properties"],"title":"VoluntaryCarbonProjectSaveRequest"},"VoluntaryCarbonProjectSlotDetail":{"properties":{"type":{"type":"string","title":"Type"},"content":{"$ref":"#/components/schemas/VoluntaryCarbonProjectSlotStored_1_0_2"}},"type":"object","required":["type","content"],"title":"VoluntaryCarbonProjectSlotDetail"},"VoluntaryCarbonProjectSlotListResponse":{"properties":{"slots":{"items":{"$ref":"#/components/schemas/VoluntaryCarbonProjectSlotSummary"},"type":"array","title":"Slots"}},"type":"object","required":["slots"],"title":"VoluntaryCarbonProjectSlotListResponse"},"VoluntaryCarbonProjectSlotStored_1_0_2":{"properties":{"status":{"$ref":"#/components/schemas/VoluntaryCarbonSlotStatus"},"content":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/VoluntaryCarbonSlotProseContent"},{"$ref":"#/components/schemas/VoluntaryCarbonSlotListContent"},{"$ref":"#/components/schemas/VoluntaryCarbonSlotTableContent"},{"$ref":"#/components/schemas/VoluntaryCarbonSlotNestedContent"}],"discriminator":{"propertyName":"kind","mapping":{"list":"#/components/schemas/VoluntaryCarbonSlotListContent","nested":"#/components/schemas/VoluntaryCarbonSlotNestedContent","prose":"#/components/schemas/VoluntaryCarbonSlotProseContent","table":"#/components/schemas/VoluntaryCarbonSlotTableContent"}}},{"type":"null"}],"title":"Content"},"gaps":{"items":{"type":"string"},"type":"array","title":"Gaps"},"provenance":{"items":{"$ref":"#/components/schemas/VoluntaryCarbonSlotProvenanceEntry"},"type":"array","title":"Provenance"}},"additionalProperties":false,"type":"object","required":["status"],"title":"VoluntaryCarbonProjectSlotStored_1_0_2"},"VoluntaryCarbonProjectSlotSummary":{"properties":{"type":{"type":"string","title":"Type"},"status":{"$ref":"#/components/schemas/VoluntaryCarbonSlotStatus"},"content_preview":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content Preview"}},"type":"object","required":["type","status"],"title":"VoluntaryCarbonProjectSlotSummary"},"VoluntaryCarbonProjectStandard":{"type":"string","enum":["isometric","verra","equitable_earth","gold_standard","cercabono"],"title":"VoluntaryCarbonProjectStandard"},"VoluntaryCarbonSlotCatalogEntry":{"properties":{"question":{"type":"string","title":"Question"},"required_for":{"items":{"$ref":"#/components/schemas/VoluntaryCarbonProjectStandard"},"type":"array","title":"Required For"},"optional_for":{"items":{"$ref":"#/components/schemas/VoluntaryCarbonProjectStandard"},"type":"array","title":"Optional For"},"standards":{"additionalProperties":{"type":"string"},"type":"object","title":"Standards"},"is_core":{"type":"boolean","title":"Is Core"}},"type":"object","required":["question","required_for","optional_for","standards","is_core"],"title":"VoluntaryCarbonSlotCatalogEntry"},"VoluntaryCarbonSlotCatalogResponse":{"properties":{"scheme_version":{"type":"string","title":"Scheme Version"},"types":{"additionalProperties":{"$ref":"#/components/schemas/VoluntaryCarbonSlotCatalogEntry"},"type":"object","title":"Types"}},"type":"object","required":["scheme_version","types"],"title":"VoluntaryCarbonSlotCatalogResponse"},"VoluntaryCarbonSlotListContent":{"properties":{"kind":{"type":"string","enum":["list"],"const":"list","title":"Kind"},"body":{"items":{"type":"string"},"type":"array","title":"Body"}},"additionalProperties":false,"type":"object","required":["kind","body"],"title":"VoluntaryCarbonSlotListContent"},"VoluntaryCarbonSlotNestedContent":{"properties":{"kind":{"type":"string","enum":["nested"],"const":"nested","title":"Kind"},"sections":{"items":{"$ref":"#/components/schemas/VoluntaryCarbonSlotSection"},"type":"array","title":"Sections"}},"additionalProperties":false,"type":"object","required":["kind","sections"],"title":"VoluntaryCarbonSlotNestedContent"},"VoluntaryCarbonSlotProseContent":{"properties":{"kind":{"type":"string","enum":["prose"],"const":"prose","title":"Kind"},"body":{"type":"string","title":"Body"}},"additionalProperties":false,"type":"object","required":["kind","body"],"title":"VoluntaryCarbonSlotProseContent"},"VoluntaryCarbonSlotProvenanceEntry":{"properties":{"file":{"type":"string","title":"File"},"location":{"type":"string","title":"Location"},"confidence":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Confidence"}},"additionalProperties":false,"type":"object","required":["file","location"],"title":"VoluntaryCarbonSlotProvenanceEntry"},"VoluntaryCarbonSlotSection":{"properties":{"title":{"type":"string","title":"Title"},"content":{"oneOf":[{"$ref":"#/components/schemas/VoluntaryCarbonSlotProseContent"},{"$ref":"#/components/schemas/VoluntaryCarbonSlotListContent"},{"$ref":"#/components/schemas/VoluntaryCarbonSlotTableContent"},{"$ref":"#/components/schemas/VoluntaryCarbonSlotNestedContent"}],"title":"Content","discriminator":{"propertyName":"kind","mapping":{"list":"#/components/schemas/VoluntaryCarbonSlotListContent","nested":"#/components/schemas/VoluntaryCarbonSlotNestedContent","prose":"#/components/schemas/VoluntaryCarbonSlotProseContent","table":"#/components/schemas/VoluntaryCarbonSlotTableContent"}}}},"additionalProperties":false,"type":"object","required":["title","content"],"title":"VoluntaryCarbonSlotSection"},"VoluntaryCarbonSlotStatus":{"type":"string","enum":["complete","partial","missing"],"title":"VoluntaryCarbonSlotStatus"},"VoluntaryCarbonSlotTableBody":{"properties":{"columns":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Columns"},"rows":{"items":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},"type":"object"},"type":"array","title":"Rows"}},"additionalProperties":false,"type":"object","required":["rows"],"title":"VoluntaryCarbonSlotTableBody"},"VoluntaryCarbonSlotTableContent":{"properties":{"kind":{"type":"string","enum":["table"],"const":"table","title":"Kind"},"body":{"$ref":"#/components/schemas/VoluntaryCarbonSlotTableBody"}},"additionalProperties":false,"type":"object","required":["kind","body"],"title":"VoluntaryCarbonSlotTableContent"},"WriteElfReportTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["write_elf_report"],"const":"write_elf_report","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"WriteElfReportTask"},"WriteMpiEvidenceReportTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["write_mpi_evidence_report"],"const":"write_mpi_evidence_report","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"WriteMpiEvidenceReportTask"},"WriteSpecificEventReportTask":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"assignee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assignee"},"customer_id":{"type":"integer","title":"Customer Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time"},"status":{"$ref":"#/components/schemas/SimpleTaskStatus"},"properties":{"anyOf":[{"$ref":"#/components/schemas/GenericTaskProperties"},{"type":"null"}]},"task_type":{"type":"string","enum":["write_specific_event_report"],"const":"write_specific_event_report","title":"Task Type"}},"type":"object","required":["uuid","customer_id","status","task_type"],"title":"WriteSpecificEventReportTask"},"YieldPotential":{"properties":{"mean_annual_yield":{"type":"number","title":"Mean Annual Yield"},"yield_over_forecast":{"type":"number","title":"Yield Over Forecast"},"yields":{"additionalProperties":{"type":"integer"},"type":"object","title":"Yields"}},"type":"object","required":["mean_annual_yield","yield_over_forecast","yields"],"title":"YieldPotential","description":"A prediction of carbon sequestration. The year corresponds to\nthe year in which the sequestration happened. For example the 2023 credit sale\npotential is for sequestration that happened from 1st Jan 2023 to 31st December 2023"},"YieldsForCAA":{"properties":{"caa_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Caa Number"},"feature_ids":{"items":{"$ref":"#/components/schemas/IdTypes"},"type":"array","title":"Feature Ids"},"area_ha":{"type":"number","title":"Area Ha"},"yields":{"additionalProperties":{"type":"integer"},"type":"object","title":"Yields"}},"type":"object","required":["feature_ids","area_ha","yields"],"title":"YieldsForCAA","description":"Yield data for one CAA"}},"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"}}}}