{"openapi":"3.0.1","info":{"title":"Efimis REST API","version":"v1"},"servers":[{"url":"/sandbox"}],"paths":{"/api/v1/applicablerates":{"get":{"tags":["ApplicableRates"],"summary":"Find applicable rate","description":"Find appropriate rates based on what has been entered so far against the work item","parameters":[{"name":"matterId","in":"query","description":"","schema":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c"}},{"name":"clientId","in":"query","description":"","schema":{"type":"string","description":"e.g. client_c0645dc026a74ae99ec436df63d77d2c"}},{"name":"feeEarnerId","in":"query","description":"","schema":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c"}},{"name":"startTime","in":"query","description":"Work item start time in UTC. Some rates are applicable only in certain periods","schema":{"type":"string","format":"date-time"}},{"name":"taskTypeId","in":"query","description":"","schema":{"type":"string","description":"e.g. tasktype_c0645dc026a74ae99ec436df63d77d2c"}},{"name":"showAll","in":"query","description":"Return all applicable rates, or just the most appropriate one","schema":{"type":"boolean","default":false}},{"name":"taskTypeName","in":"query","description":"Name or code of the task type","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEFindApplicableRatesResult"}}}}}}},"/api/v1/clients":{"get":{"tags":["Clients"],"summary":"Find clients","parameters":[{"name":"pageIndex","in":"query","description":"","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"","schema":{"type":"integer","format":"int32","default":100}},{"name":"keywords","in":"query","description":"","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEFindClientsResult"}}}}}},"post":{"tags":["Clients"],"summary":"Create client","parameters":[{"name":"id","in":"query","description":"","schema":{"type":"string","description":"e.g. client_c0645dc026a74ae99ec436df63d77d2c"}}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Client"}]}},"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Client"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Client"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PECreateClientResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/clients/{id}":{"get":{"tags":["Clients"],"summary":"Get client","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. client_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultOfClientData"}}}}}},"put":{"tags":["Clients"],"summary":"Update client","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. client_c0645dc026a74ae99ec436df63d77d2c"}}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Client"}]}},"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Client"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Client"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEUpdateClientResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]},"delete":{"tags":["Clients"],"summary":"Delete client","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. client_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEDeleteClientResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/clients/{id}/close":{"post":{"tags":["Clients"],"summary":"Close client","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. client_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PECloseClientResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/clients/{id}/activate":{"post":{"tags":["Clients"],"summary":"Reactivate client","description":"Reactivate a client after it has been closed.","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. client_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEActivateClientResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/costrecoveries":{"get":{"tags":["CostRecoveries"],"summary":"Find Cost Recoveries","parameters":[{"name":"pageIndex","in":"query","description":"The page index of search results (starts at 0)","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"The number of records to return with each page of results","schema":{"type":"integer","format":"int32","default":25}},{"name":"matterId","in":"query","description":"The id of the matter to fetch cost recoveries for","schema":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c"}},{"name":"supplierId","in":"query","description":"The id of the supplier for the cost recovery","schema":{"type":"string","description":"e.g. supplier_c0645dc026a74ae99ec436df63d77d2c"}},{"name":"keywords","in":"query","description":"Keyword search on the description, matter number, client name, supplier name or reference","schema":{"type":"string"}},{"name":"isBillable","in":"query","description":"Whether is cost recovery is billable","schema":{"type":"boolean"}},{"name":"invoiceId","in":"query","description":"The id of the invoice that the cost recovery was billed on","schema":{"type":"string","description":"e.g. invoice_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResultOfDisbursementData"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]},"post":{"tags":["CostRecoveries"],"summary":"Create cost recovery","parameters":[{"name":"id","in":"query","description":"If not specified, a new one is generated","schema":{"type":"string","description":"e.g. disbursement_c0645dc026a74ae99ec436df63d77d2c"}}],"requestBody":{"description":"The disbursement","content":{"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Disbursement"}]}},"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Disbursement"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Disbursement"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultOfDisbursementData"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/costrecoveries/{id}":{"get":{"tags":["CostRecoveries"],"summary":"Get cost recovery","parameters":[{"name":"id","in":"path","description":"The Id of the cost recovery","required":true,"schema":{"type":"string","description":"e.g. disbursement_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultOfDisbursementData"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]},"delete":{"tags":["CostRecoveries"],"summary":"Delete cost recovery","parameters":[{"name":"id","in":"path","description":"The id of the cost recovery","required":true,"schema":{"type":"string","description":"e.g. disbursement_c0645dc026a74ae99ec436df63d77d2c"}},{"name":"date","in":"query","description":"The date to post the cancellation on","schema":{"type":"string","format":"date-time"}},{"name":"reason","in":"query","description":"The reason for cancelling","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PECancelDisbursementResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/disbursementcodes":{"get":{"tags":["DisbursementCodes"],"summary":"Find disbursement codes","parameters":[{"name":"pageIndex","in":"query","description":"","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"","schema":{"type":"integer","format":"int32","default":100}},{"name":"keywords","in":"query","description":"","schema":{"type":"string"}},{"name":"code","in":"query","schema":{"type":"string"}},{"name":"types","in":"query","schema":{"type":"array","items":{"$ref":"#/components/schemas/PEDisbursementType"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindDisbursementCodesResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]}},"/api/v1/disbursementcodes/{code}":{"get":{"tags":["DisbursementCodes"],"summary":"Find disbursement codes","parameters":[{"name":"pageIndex","in":"query","description":"","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"","schema":{"type":"integer","format":"int32","default":100}},{"name":"code","in":"path","description":"","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindDisbursementCodesResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]}},"/api/v1/disbursementcodes/{type}/{code}":{"get":{"tags":["DisbursementCodes"],"summary":"Get disbursement rate by type and code","parameters":[{"name":"type","in":"path","description":"","required":true,"schema":{"allOf":[{"$ref":"#/components/schemas/PEDisbursementType"}]}},{"name":"code","in":"path","description":"","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"number","format":"double"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]}},"/api/v1/divisions":{"get":{"tags":["Divisions"],"summary":"Find divisions","parameters":[{"name":"pageIndex","in":"query","description":"","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"","schema":{"type":"integer","format":"int32","default":100}},{"name":"keywords","in":"query","description":"","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultOfPagedListOfDivisionData"}}}}}}},"/api/v1/divisions/{id}":{"get":{"tags":["Divisions"],"summary":"Get division by id","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. division_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultOfDivisionData"}}}}}}},"/api/v1/documentcollections/{id}":{"get":{"tags":["DocumentCollections"],"summary":"Get document collection","parameters":[{"name":"id","in":"path","description":"Document collection id","required":true,"schema":{"type":"string","description":"e.g. documentcollection_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultOfDocumentCollectionData"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["tenant-user"]}]}},"/api/v1/documents/{id}/download":{"get":{"tags":["Documents"],"summary":"Download a document","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. document_c0645dc026a74ae99ec436df63d77d2c"}},{"name":"documentCollectionId","in":"query","description":"","schema":{"type":"string","description":"e.g. documentcollection_c0645dc026a74ae99ec436df63d77d2c"}},{"name":"asFileName","in":"query","description":"Optional. Return the file as Save as a file name","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/PEDownloadDocumentResult"}},"application /json":{"schema":{"$ref":"#/components/schemas/PEDownloadDocumentResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["tenant-user"]}]}},"/api/v1/documents/{id}":{"get":{"tags":["Documents"],"summary":"Get document metadata","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. document_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEGetDocumentResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["tenant-user"]}]}},"/api/v1/documents/{id}/checkin":{"post":{"tags":["Documents"],"summary":"Check in document","description":"Check in a new version of a document, and release any exclusive edit lock. Ensure exactly one form data part have the filename property.","parameters":[{"name":"id","in":"path","description":"The document id","required":true,"schema":{"type":"string","description":"e.g. document_c0645dc026a74ae99ec436df63d77d2c"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"comment":{"type":"string","description":"Explain why this version is created. Specify this as a form data part with the name of comment"}}},"encoding":{"comment":{"style":"form"}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PECheckInDocumentResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["tenant-user","policy.write"]}]}},"/api/v1/documents/{id}/checkout":{"post":{"tags":["Documents"],"summary":"Check out document","description":"Mark a document as being exclusively checked out. Others cannot check in new versions.","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. document_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PECheckOutDocumentResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["tenant-user","policy.write"]}]}},"/api/v1/documents":{"post":{"tags":["Documents"],"summary":"Create and upload document","description":"Create and upload one or more documents as a multipart/form-data. Only form data parts with a filename property is \nprocessed, with the value used as the file name stored in the system. The name property of each part is ignored.","parameters":[{"name":"collection","in":"query","description":"The document collection to save the file to, e.g. documentcollection_12345678123412341234123456789012","required":true,"schema":{"type":"string","description":"e.g. documentcollection_c0645dc026a74ae99ec436df63d77d2c"}},{"name":"folder","in":"query","description":"The destination folder in the collection, e.g. documentfolder_12345678123412341234123456789012. The root folder if not specified.","schema":{"type":"string","description":"e.g. documentfolder_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PECreateDocumentResult"}}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["tenant-user","policy.write"]}]}},"/api/v1/documents/file":{"post":{"tags":["Documents"],"summary":"File a report","description":"File a report as a PDF document to a document collection, optionally under a folder","parameters":[{"name":"collection","in":"query","description":"","required":true,"schema":{"type":"string","description":"e.g. documentcollection_c0645dc026a74ae99ec436df63d77d2c"}},{"name":"reportId","in":"query","description":"The report id PDF and file","required":true,"schema":{"type":"string"}},{"name":"fileName","in":"query","description":"File the report with this file name, or use a random name","schema":{"type":"string"}},{"name":"folder","in":"query","description":"The folder to file it to, or the root folder if not specified","schema":{"type":"string","description":"e.g. documentfolder_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PECreateDocumentResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["tenant-user","policy.write"]}]}},"/api/v1/employees":{"get":{"tags":["Employees"],"summary":"Find employees","parameters":[{"name":"pageIndex","in":"query","description":"","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"","schema":{"type":"integer","format":"int32","default":100}},{"name":"keywords","in":"query","description":"","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEFindEmployeesResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]},"post":{"tags":["Employees"],"summary":"Create employee","parameters":[{"name":"id","in":"query","description":"","schema":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c"}}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Employee"}]}},"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Employee"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Employee"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PECreateEmployeeResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/employees/{id}":{"get":{"tags":["Employees"],"summary":"Get employee","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultOfEmployeeData"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]},"put":{"tags":["Employees"],"summary":"Update employee","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c"}}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Employee"}]}},"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Employee"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Employee"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEUpdateEmployeeResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]},"delete":{"tags":["Employees"],"summary":"Delete employee","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEDeleteEmployeeResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/employees/{id}/activate":{"post":{"tags":["Employees"],"summary":"Activate employee","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEActivateEmployeeResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/entities":{"get":{"tags":["Entities"],"summary":"Find entities","parameters":[{"name":"pageIndex","in":"query","description":"","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"","schema":{"type":"integer","format":"int32","default":100}},{"name":"keywords","in":"query","description":"","schema":{"type":"string"}},{"name":"isClient","in":"query","description":"","schema":{"type":"boolean"}},{"name":"isEmployee","in":"query","description":"","schema":{"type":"boolean"}},{"name":"isSupplier","in":"query","description":"","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResultOfEntityData"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]},"post":{"tags":["Entities"],"summary":"Create entity","parameters":[{"name":"id","in":"query","description":"","schema":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c"}}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Entity"}]}},"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Entity"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Entity"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PECreateEntityResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/entities/{id}":{"get":{"tags":["Entities"],"summary":"Get entity","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultOfEntityData"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]},"patch":{"tags":["Entities"],"summary":"Patch entity","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c"}}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EntityEdit"}]}},"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EntityEdit"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EntityEdit"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEUpdateEntityResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]},"delete":{"tags":["Entities"],"summary":"Delete entity","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEDeleteEntityResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/entities/{id}/activate":{"post":{"tags":["Entities"],"summary":"Activate entity","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEActivateEntityResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/entities/{id}/undelete":{"post":{"tags":["Entities"],"summary":"Undelete entity","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEActivateEntityResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/entities/{id}/members":{"get":{"tags":["Entities"],"summary":"Get entity relations","description":"Returns entities that are related to this entity.","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c"}},{"name":"pageIndex","in":"query","description":"","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"","schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEFindEntityRelationsResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]},"post":{"tags":["Entities"],"summary":"Create a relation between entities","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c"}}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PE.Mk2.App.WebApi.DataTypes.EntityRelationRequest"}],"description":"Request to create a relation between entities"}},"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PE.Mk2.App.WebApi.DataTypes.EntityRelationRequest"}],"description":"Request to create a relation between entities"}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PE.Mk2.App.WebApi.DataTypes.EntityRelationRequest"}],"description":"Request to create a relation between entities"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PESetEntityRelationResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/entities/members/{memberId}":{"get":{"tags":["Entities"],"summary":"Get entity relation","parameters":[{"name":"memberId","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. relation_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEGetEntityRelationResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]},"delete":{"tags":["Entities"],"summary":"Delete entity relation","parameters":[{"name":"memberId","in":"path","description":"The RelationId to be deleted","required":true,"schema":{"type":"string","description":"e.g. relation_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEDeleteRelationLinksResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/invoices":{"get":{"tags":["Invoices"],"summary":"Find invoices","parameters":[{"name":"pageIndex","in":"query","description":"The index of the page to retrieve","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"The number of items per page","schema":{"type":"integer","format":"int32","default":100}},{"name":"keywords","in":"query","description":"Optional keywords to filter the invoices. Keywords can be matter number, client name, invoice number, matter title, acting person name, or responsible person name","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResultOfInvoiceData"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]},"post":{"tags":["Invoices"],"summary":"Create invoice","requestBody":{"description":"Full invoice specification","content":{"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Invoice"}]}},"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Invoice"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Invoice"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultOfInvoiceData"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]},"put":{"tags":["Invoices"],"summary":"Update invoice","parameters":[{"name":"id","in":"query","description":"Invoice ID to update","schema":{"type":"string","description":"e.g. invoice_c0645dc026a74ae99ec436df63d77d2c"}}],"requestBody":{"description":"Full invoice specification","content":{"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Invoice"}]}},"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Invoice"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Invoice"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultOfInvoiceData"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/invoices/prototype":{"get":{"tags":["Invoices"],"summary":"Create prototype invoice","description":"Makes a prototype invoice for a matter that can be sent to the POST endpoint to create an invoice.","parameters":[{"name":"matterId","in":"query","description":"The matter to make a prototype invoice for","schema":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c"}},{"name":"billToDate","in":"query","description":"Include only items up to and including this date","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultOfInvoice"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]}},"/api/v1/invoices/invoices/{invoiceId}/receipt":{"post":{"tags":["Invoices"],"summary":"Post receipt","parameters":[{"name":"invoiceId","in":"path","description":"The ID of the invoice for which the receipt is being posted","required":true,"schema":{"type":"string","description":"e.g. invoice_c0645dc026a74ae99ec436df63d77d2c"}}],"requestBody":{"description":"The details of the receipt to be posted","content":{"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PEInvoicePostReceipt"}]}},"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PEInvoicePostReceipt"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PEInvoicePostReceipt"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEPostReceiptResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/invoices/payments":{"get":{"tags":["Invoices"],"summary":"Get invoice payments","parameters":[{"name":"invoiceId","in":"query","description":"The ID of the invoice for which payments are being retrieved","schema":{"type":"string","description":"e.g. invoice_c0645dc026a74ae99ec436df63d77d2c"}},{"name":"pageIndex","in":"query","description":"The index of the page to retrieve","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"The number of items per page","schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResultOfLedgerEntryData"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]}},"/api/v1/matters":{"get":{"tags":["Matters"],"summary":"Find matters","parameters":[{"name":"pageIndex","in":"query","description":"","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"","schema":{"type":"integer","format":"int32","default":100}},{"name":"keywords","in":"query","description":"","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResultOfMatterData"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]},"post":{"tags":["Matters"],"summary":"Create matter","description":"Depending on whether there's a checklist, it could move to Draft state until it is completed\nor directly move to Active state. If an ID is not provided, a new one will be generated.","parameters":[{"name":"id","in":"query","description":"","schema":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c"}}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Matter"}]}},"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Matter"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Matter"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultOfMatterData"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/matters/{id}":{"get":{"tags":["Matters"],"summary":"Get matter","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultOfMatterData"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]},"patch":{"tags":["Matters"],"summary":"Patch matter","description":"Any property exposed by MatterEdit can be changed.","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c"}}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MatterEdit"}]}},"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MatterEdit"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MatterEdit"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEUpdateMatterResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]},"delete":{"tags":["Matters"],"summary":"Delete matter","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEDeleteMatterResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/matters/{id}/ledgers":{"get":{"tags":["Matters"],"summary":"Get matter ledgers","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEFindLedgersResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]}},"/api/v1/matters/{id}/summary":{"get":{"tags":["Matters"],"summary":"Get matter account summary","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEGetMatterSummaryResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]}},"/api/v1/matters/summaries":{"get":{"tags":["Matters"],"summary":"Get matter account summaries","parameters":[{"name":"id","in":"query","description":"","schema":{"type":"array","items":{"$ref":"#/components/schemas/MatterId"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PEMatterSummaryData"}}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]}},"/api/v1/matters/can":{"get":{"tags":["Matters"],"summary":"Check state transition eligibility","description":"Check if matter(s) can transition to a state.\nE.g. if a matter can be closed.","parameters":[{"name":"id","in":"query","description":"","schema":{"type":"array","items":{"$ref":"#/components/schemas/MatterId"}}},{"name":"state","in":"query","description":"State to transition the matter to","schema":{"allOf":[{"$ref":"#/components/schemas/PEMatterState"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PECanTransitionResult"}}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]}},"/api/v1/matters/{id}/permissions":{"put":{"tags":["Matters"],"summary":"Configure matter permissions","description":"Configure matter permissions in one operation.\naclOverride=true disables matter-specific ACL (firm default/open access).\naclOverride=false enables matter-specific ACL.\nIf aclOverride is omitted, accessEntries implies matter-specific ACL.","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c"}}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PE.Mk2.App.WebApi.DataTypes.MatterPermissionsRequest"}]}},"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PE.Mk2.App.WebApi.DataTypes.MatterPermissionsRequest"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PE.Mk2.App.WebApi.DataTypes.MatterPermissionsRequest"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEConfigureMatterPermissionsResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/matters/{id}/close":{"put":{"tags":["Matters"],"summary":"Close matter","description":"Matters that cannot be closed will go into a Closing state. It can be reopened by using the 'activate' action.","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PECloseMatterResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/matters/{id}/activate":{"put":{"tags":["Matters"],"summary":"Reactivate matter","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEActivateMatterResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/mattertypes":{"get":{"tags":["MatterTypes"],"summary":"Find Matter Types","parameters":[{"name":"pageIndex","in":"query","description":"","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"","schema":{"type":"integer","format":"int32","default":100}},{"name":"keywords","in":"query","description":"","schema":{"type":"string"}},{"name":"parentId","in":"query","description":"If passed in this will return all matching matter types with this parent id","schema":{"type":"string","description":"e.g. mattertype_c0645dc026a74ae99ec436df63d77d2c"}},{"name":"isParent","in":"query","description":"If passed in this will only return items that are a parent","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResultOfMatterTypeData"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]},"post":{"tags":["MatterTypes"],"summary":"Create a Matter Type","parameters":[{"name":"id","in":"query","description":"","schema":{"type":"string","description":"e.g. mattertype_c0645dc026a74ae99ec436df63d77d2c"}}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MatterType"}]}},"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MatterType"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MatterType"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultOfMatterTypeData"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/mattertypes/{id}":{"get":{"tags":["MatterTypes"],"summary":"Get Matter Type","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. mattertype_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultOfMatterTypeData"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]}},"/api/v1/ratesets":{"get":{"tags":["RateSets"],"summary":"Find rate sets","parameters":[{"name":"includeInactive","in":"query","description":"If true, will also include inactive rate sets","schema":{"type":"boolean","default":false}},{"name":"pageIndex","in":"query","description":"The page of results to return (default 0)","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"The number of results to return per page (default 100)","schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEFindRateSetsResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]}},"/api/v1/roles":{"get":{"tags":["Roles"],"summary":"Find roles","parameters":[{"name":"pageIndex","in":"query","description":"","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"","schema":{"type":"integer","format":"int32","default":25}},{"name":"keywords","in":"query","description":"","schema":{"type":"string"}},{"name":"isSystemRole","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PE.Identity.Messages.FindRolesResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]}},"/api/v1/roles/{id}":{"get":{"tags":["Roles"],"summary":"Get role by id","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PE.Identity.Messages.GetRoleResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]}},"/api/v1/suppliers":{"get":{"tags":["Suppliers"],"summary":"Find suppliers","parameters":[{"name":"pageIndex","in":"query","description":"","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"","schema":{"type":"integer","format":"int32","default":25}},{"name":"keywords","in":"query","description":"","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResultOfSupplierData"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]},"post":{"tags":["Suppliers"],"summary":"Create supplier","parameters":[{"name":"id","in":"query","description":"","schema":{"type":"string","description":"e.g. supplier_c0645dc026a74ae99ec436df63d77d2c"}}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Supplier"}]}},"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Supplier"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Supplier"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultOfSupplierData"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/suppliers/{id}":{"get":{"tags":["Suppliers"],"summary":"Get supplier","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. supplier_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultOfSupplierData"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]},"put":{"tags":["Suppliers"],"summary":"Update supplier","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. supplier_c0645dc026a74ae99ec436df63d77d2c"}}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Supplier"}]}},"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Supplier"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Supplier"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultOfSupplierData"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]},"delete":{"tags":["Suppliers"],"summary":"Delete supplier","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. supplier_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEDeleteSupplierResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/suppliers/{id}/suspend":{"post":{"tags":["Suppliers"],"summary":"Suspend supplier","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. supplier_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PESuspendSupplierResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/suppliers/{id}/close":{"post":{"tags":["Suppliers"],"summary":"Close supplier","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. supplier_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PECloseSupplierResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/suppliers/{id}/activate":{"post":{"tags":["Suppliers"],"summary":"Activate supplier","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. supplier_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEActivateSupplierResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/tasktypes":{"get":{"tags":["TaskTypes"],"summary":"Find task types for work items","parameters":[{"name":"pageIndex","in":"query","description":"","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"","schema":{"type":"integer","format":"int32","default":100}},{"name":"keywords","in":"query","description":"","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindTaskTypesResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]}},"/api/v1/taxcodes":{"get":{"tags":["TaxCodes"],"summary":"Find Tax Codes","parameters":[{"name":"pageIndex","in":"query","description":"Page Index (default 0)","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"Page Size (default 25)","schema":{"type":"integer","format":"int32","default":25}},{"name":"appliesTo","in":"query","description":"Whether the tax code applies to PE.Mk2.Accounting.V1.TaxAppliesTo.Sales or PE.Mk2.Accounting.V1.TaxAppliesTo.Purchases. If null, it will return all tax codes","schema":{"allOf":[{"$ref":"#/components/schemas/PETaxAppliesTo"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindTaxCodesResult"}}}}}}},"/api/v1/webhooks":{"put":{"tags":["Webhooks"],"summary":"Register Or Update Webhook","description":"Creates or replaces a webhook registration for the current tenant and application owner.\nA registration must contain either app events or ops events, but not both.\nOps event registrations require `ReadDevOps` scope.\n\nUse `http://webhook.site` (or equivalent) as a temporary receiver when validating payload shape and delivery.","requestBody":{"description":"Webhook identifier, target URL, secret, enabled state, and subscribed event type names.","content":{"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PEWebhookSpec"}]}},"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PEWebhookSpec"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PEWebhookSpec"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PERegisterWebhookResult"}}}}},"callbacks":{"MatterUpdated":{"/receiver/url":{"post":{"summary":"PE.Mk2.Accounting.V1.MatterUpdated","description":"Matter details updated","requestBody":{"content":{"application/json":{"schema":{"title":"MatterUpdatedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/MatterUpdated"}},"description":"MatterUpdated webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"ClientCreated":{"/receiver/url":{"post":{"summary":"PE.Mk2.Accounting.V1.ClientCreated","description":"Client moved into a state where it's gathering required data before work can be done for it.","requestBody":{"content":{"application/json":{"schema":{"title":"ClientCreatedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/ClientCreated"}},"description":"ClientCreated webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"ClientUpdated":{"/receiver/url":{"post":{"summary":"PE.Mk2.Accounting.V1.ClientUpdated","description":"Client details updated","requestBody":{"content":{"application/json":{"schema":{"title":"ClientUpdatedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/ClientUpdated"}},"description":"ClientUpdated webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"EmployeeCreated":{"/receiver/url":{"post":{"summary":"PE.Mk2.Accounting.V1.EmployeeCreated","description":"Employee record created.","requestBody":{"content":{"application/json":{"schema":{"title":"EmployeeCreatedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/EmployeeCreated"}},"description":"EmployeeCreated webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"EmployeeUpdated":{"/receiver/url":{"post":{"summary":"PE.Mk2.Accounting.V1.EmployeeUpdated","description":"Employee details updated","requestBody":{"content":{"application/json":{"schema":{"title":"EmployeeUpdatedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/EmployeeUpdated"}},"description":"EmployeeUpdated webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"SupplierCreated":{"/receiver/url":{"post":{"summary":"PE.Mk2.Accounting.V1.SupplierCreated","description":"Supplier moved into a state where it's gathering required data before work can be done for it.","requestBody":{"content":{"application/json":{"schema":{"title":"SupplierCreatedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/SupplierCreated"}},"description":"SupplierCreated webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"SupplierUpdated":{"/receiver/url":{"post":{"summary":"PE.Mk2.Accounting.V1.SupplierUpdated","description":"Supplier details updated","requestBody":{"content":{"application/json":{"schema":{"title":"SupplierUpdatedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/SupplierUpdated"}},"description":"SupplierUpdated webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"WorkItemFinalised":{"/receiver/url":{"post":{"summary":"PE.Mk2.Accounting.V1.WorkItemFinalised","description":"A pending work item has been turned into finalised","requestBody":{"content":{"application/json":{"schema":{"title":"WorkItemFinalisedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/WorkItemFinalised"}},"description":"WorkItemFinalised webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"WorkItemUnfinalised":{"/receiver/url":{"post":{"summary":"PE.Mk2.Accounting.V1.WorkItemUnfinalised","description":"A finalised work item has been turned into pending","requestBody":{"content":{"application/json":{"schema":{"title":"WorkItemUnfinalisedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/WorkItemUnfinalised"}},"description":"WorkItemUnfinalised webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"InvoiceIssued":{"/receiver/url":{"post":{"summary":"PE.Mk2.Accounting.V1.InvoiceIssued","description":"Invoice has been approved, accounting entries posted, and issued","requestBody":{"content":{"application/json":{"schema":{"title":"InvoiceIssuedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/InvoiceIssued"}},"description":"InvoiceIssued webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"InvoiceUnfinalised":{"/receiver/url":{"post":{"summary":"PE.Mk2.Accounting.V1.InvoiceUnfinalised","description":"An Issued or Closed invoice has been put back into Draft state","requestBody":{"content":{"application/json":{"schema":{"title":"InvoiceUnfinalisedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/InvoiceUnfinalised"}},"description":"InvoiceUnfinalised webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"PurchaseFinalised":{"/receiver/url":{"post":{"summary":"PE.Mk2.Accounting.V1.PurchaseFinalised","description":"When a purchase order has been accepted an turned into a purchase","requestBody":{"content":{"application/json":{"schema":{"title":"PurchaseFinalisedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/PurchaseFinalised"}},"description":"PurchaseFinalised webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"PurchaseUnfinalised":{"/receiver/url":{"post":{"summary":"PE.Mk2.Accounting.V1.PurchaseUnfinalised","description":"If a purchase was created from a purchase order this will turn it back into a purchase order","requestBody":{"content":{"application/json":{"schema":{"title":"PurchaseUnfinalisedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/PurchaseUnfinalised"}},"description":"PurchaseUnfinalised webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"JournalPosted":{"/receiver/url":{"post":{"summary":"PE.Mk2.Accounting.V1.JournalPosted","description":"A General Journal transaction has been posted","requestBody":{"content":{"application/json":{"schema":{"title":"JournalPostedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/JournalPosted"}},"description":"JournalPosted webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"ApprovalAccepted":{"/receiver/url":{"post":{"summary":"PE.Mk2.Accounting.V1.ApprovalAccepted","description":"All the approval steps have been accepted, approval considered accepted","requestBody":{"content":{"application/json":{"schema":{"title":"ApprovalAcceptedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/ApprovalAccepted"}},"description":"ApprovalAccepted webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"ApprovalAsserted":{"/receiver/url":{"post":{"summary":"PE.Mk2.Accounting.V1.ApprovalAsserted","description":"Directly approved by the responsible person.","requestBody":{"content":{"application/json":{"schema":{"title":"ApprovalAssertedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/ApprovalAsserted"}},"description":"ApprovalAsserted webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"ApprovalRejected":{"/receiver/url":{"post":{"summary":"PE.Mk2.Accounting.V1.ApprovalRejected","description":"The current step of the approval process has been rejected, inform the previous approver","requestBody":{"content":{"application/json":{"schema":{"title":"ApprovalRejectedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/ApprovalRejected"}},"description":"ApprovalRejected webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"ApprovalStarted":{"/receiver/url":{"post":{"summary":"PE.Mk2.Accounting.V1.ApprovalStarted","description":"Approval started event","requestBody":{"content":{"application/json":{"schema":{"title":"ApprovalStartedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/ApprovalStarted"}},"description":"ApprovalStarted webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"ApprovalUpdated":{"/receiver/url":{"post":{"summary":"PE.Mk2.Accounting.V1.ApprovalUpdated","description":"An approval decision has been made for one of the steps\n            The current approval step has been approved, move it to the next approver","requestBody":{"content":{"application/json":{"schema":{"title":"ApprovalUpdatedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/ApprovalUpdated"}},"description":"ApprovalUpdated webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"ApprovalResumed":{"/receiver/url":{"post":{"summary":"PE.Mk2.Accounting.V1.ApprovalResumed","description":"When the approval process is resumed after rejection","requestBody":{"content":{"application/json":{"schema":{"title":"ApprovalResumedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/ApprovalResumed"}},"description":"ApprovalResumed webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"ApprovalCancelled":{"/receiver/url":{"post":{"summary":"PE.Mk2.Accounting.V1.ApprovalCancelled","description":"The approval process has been stopped permanently","requestBody":{"content":{"application/json":{"schema":{"title":"ApprovalCancelledEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/ApprovalCancelled"}},"description":"ApprovalCancelled webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"DivisionCreated":{"/receiver/url":{"post":{"summary":"PE.Mk2.Accounting.V1.DivisionCreated","description":"Division created","requestBody":{"content":{"application/json":{"schema":{"title":"DivisionCreatedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/DivisionCreated"}},"description":"DivisionCreated webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"DivisionUpdated":{"/receiver/url":{"post":{"summary":"PE.Mk2.Accounting.V1.DivisionUpdated","description":"Division updated","requestBody":{"content":{"application/json":{"schema":{"title":"DivisionUpdatedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/DivisionUpdated"}},"description":"DivisionUpdated webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"DocumentCreated":{"/receiver/url":{"post":{"summary":"PE.Mk2.Documents.V1.DocumentCreated","requestBody":{"content":{"application/json":{"schema":{"title":"DocumentCreatedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/DocumentCreated"}},"description":"DocumentCreated webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"DocumentCheckedIn":{"/receiver/url":{"post":{"summary":"PE.Mk2.Documents.V1.DocumentCheckedIn","requestBody":{"content":{"application/json":{"schema":{"title":"DocumentCheckedInEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/DocumentCheckedIn"}},"description":"DocumentCheckedIn webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"ImportStarted":{"/receiver/url":{"post":{"summary":"PE.Mk2.Core.V1.ImportStarted","description":"Signals that an import session has started for a tenant.","requestBody":{"content":{"application/json":{"schema":{"title":"ImportStartedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/ImportStarted"}},"description":"ImportStarted webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"ImportProgressed":{"/receiver/url":{"post":{"summary":"PE.Mk2.Core.V1.ImportProgressed","description":"Periodic import progress snapshot emitted during an active import.","requestBody":{"content":{"application/json":{"schema":{"title":"ImportProgressedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/ImportProgressed"}},"description":"ImportProgressed webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"ImportFinished":{"/receiver/url":{"post":{"summary":"PE.Mk2.Core.V1.ImportFinished","description":"Signals that an import session has finished for a tenant.","requestBody":{"content":{"application/json":{"schema":{"title":"ImportFinishedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/ImportFinished"}},"description":"ImportFinished webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}},"SettingsValidationRequested":{"/receiver/url":{"post":{"summary":"PE.Mk2.Core.V1.SettingsValidationRequested","description":"Validate application settings within a tenant context, optionally scoped further to a user or other adhoc scope","requestBody":{"content":{"application/json":{"schema":{"title":"SettingsValidationRequestedEvent","properties":{"Type":{"type":"string","description":"The webhook event type"},"Data":{"$ref":"#/components/schemas/PESettingsValidationRequested"}},"description":"SettingsValidationRequested webhook message envelope"}}},"required":true},"responses":{"200":{"description":"Webhook received successfully"}}}}}}},"get":{"tags":["Webhooks"],"summary":"List Webhooks","description":"Returns webhook registrations owned by the caller application (`AppId`) for the current tenant.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEFindWebhooksResult"}}}}}}},"/api/v1/webhooks/{id}":{"delete":{"tags":["Webhooks"],"summary":"Delete Webhook","description":"Removes a webhook registration for the current tenant and application owner.\nQueued invocation history remains queryable through invocation endpoints.","parameters":[{"name":"id","in":"path","description":"Webhook identifier.","required":true,"schema":{"type":"string","description":"e.g. webhook_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEUnregisterWebhookResult"}}}}}},"get":{"tags":["Webhooks"],"summary":"Get Webhook","description":"Returns a single webhook registration by identifier.","parameters":[{"name":"id","in":"path","description":"Webhook identifier.","required":true,"schema":{"type":"string","description":"e.g. webhook_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEGetWebhookResult"}}}}}}},"/api/v1/webhooks/{id}/invocations":{"get":{"tags":["Webhooks"],"summary":"List Webhook Invocations","description":"Returns paged invocation history for a webhook, filtered by period, keywords, and completion status.\nDefault period is the last 3 days when `from` and `to` are omitted.","parameters":[{"name":"id","in":"path","description":"Webhook identifier.","required":true,"schema":{"type":"string","description":"e.g. webhook_c0645dc026a74ae99ec436df63d77d2c"}},{"name":"pageIndex","in":"query","description":"Zero-based page index.","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"Page size.","schema":{"type":"integer","format":"int32","default":20}},{"name":"from","in":"query","description":"Start date (inclusive).","schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","description":"End date (inclusive).","schema":{"type":"string","format":"date-time"}},{"name":"keywords","in":"query","description":"Optional keyword filter applied to invocation metadata.","schema":{"type":"string"}},{"name":"isCompleted","in":"query","description":"Optional completion-state filter.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PE.Mk2.App.WebApi.Webhooks.FindWebhookInvocationsResult"}}}}}}},"/api/v1/webhooks/{id}/invocations/{offset}":{"get":{"tags":["Webhooks"],"summary":"Get Webhook Invocation","description":"Returns a single invocation record by webhook id and persisted offset.","parameters":[{"name":"id","in":"path","description":"Webhook identifier.","required":true,"schema":{"type":"string","description":"e.g. webhook_c0645dc026a74ae99ec436df63d77d2c"}},{"name":"offset","in":"path","description":"Invocation offset in the webhook invocation stream.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PE.Mk2.App.WebApi.Webhooks.GetWebhookInvocationResult"}}}}}}},"/api/v1/webhooks/{id}/replay":{"post":{"tags":["Webhooks"],"summary":"Replay Webhook Invocation","description":"Replays one previously recorded invocation at the specified offset.\nThis is useful for receiver retry/debug scenarios without re-emitting source domain events.","parameters":[{"name":"id","in":"path","description":"Webhook identifier.","required":true,"schema":{"type":"string","description":"e.g. webhook_c0645dc026a74ae99ec436df63d77d2c"}},{"name":"offset","in":"query","description":"Invocation offset to replay.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PE.Mk2.App.WebApi.Webhooks.ReplayWebhookInvocationResult"}}}}}}},"/api/v1/webhooks/{id}/replay-from":{"post":{"tags":["Webhooks"],"summary":"Replay Webhook From Offset","description":"Replays webhook subscription from the event after the specified offset.","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. webhook_c0645dc026a74ae99ec436df63d77d2c"}},{"name":"after","in":"query","description":"Exclusive offset.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PE.Mk2.App.WebApi.Webhooks.ReplayWebhookInvocationResult"}}}}}}},"/api/v1/webhooks/{id}/enable":{"post":{"tags":["Webhooks"],"summary":"Enable Webhook","description":"Enables delivery for the webhook. Queued invocations will resume being sent.","parameters":[{"name":"id","in":"path","description":"Webhook identifier.","required":true,"schema":{"type":"string","description":"e.g. webhook_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEEnableWebhookResult"}}}}}}},"/api/v1/webhooks/{id}/disable":{"post":{"tags":["Webhooks"],"summary":"Disable Webhook","description":"Disables delivery for the webhook but keeps queueing matching events for later replay or re-enable.","parameters":[{"name":"id","in":"path","description":"Webhook identifier.","required":true,"schema":{"type":"string","description":"e.g. webhook_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEDisableWebhookResult"}}}}}}},"/api/v1/workitems":{"get":{"tags":["WorkItems"],"summary":"Find work items","parameters":[{"name":"pageIndex","in":"query","description":"","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"","schema":{"type":"integer","format":"int32","default":100}},{"name":"matterId","in":"query","description":"","schema":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c"}},{"name":"employeeId","in":"query","description":"","schema":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResultOfWorkItemData"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]},"post":{"tags":["WorkItems"],"summary":"Create work item","parameters":[{"name":"id","in":"query","description":"If not specified, a new one is generated","schema":{"type":"string","description":"e.g. workitem_c0645dc026a74ae99ec436df63d77d2c"}},{"name":"finalised","in":"query","description":"Immediately attempt to finalise the work item","schema":{"type":"boolean","default":false}}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PEWorkItem"}]}},"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PEWorkItem"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PEWorkItem"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultOfWorkItemData"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/workitems/{id}":{"get":{"tags":["WorkItems"],"summary":"Get work item","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. workitem_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultOfWorkItemData"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.read"]}]},"put":{"tags":["WorkItems"],"summary":"Update work item","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. workitem_c0645dc026a74ae99ec436df63d77d2c"}}],"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PEWorkItem"}]}},"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PEWorkItem"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PEWorkItem"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultOfWorkItemData"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]},"delete":{"tags":["WorkItems"],"summary":"Delete unfinalised work item","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. workitem_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEDeleteWorkItemResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/workitems/{id}/finalise":{"post":{"tags":["WorkItems"],"summary":"Finalise work item","description":"Marks the work item as ready for billing.","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. workitem_c0645dc026a74ae99ec436df63d77d2c"}},{"name":"postingDate","in":"query","description":"If specified, the date this work item is recognised in WIP movement","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEFinaliseWorkItemResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/workitems/{id}/unfinalise":{"post":{"tags":["WorkItems"],"summary":"Unfinalise work item","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. workitem_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEUnfinaliseWorkItemResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}},"/api/v1/workitems/{id}/restore":{"post":{"tags":["WorkItems"],"summary":"Restore work item","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string","description":"e.g. workitem_c0645dc026a74ae99ec436df63d77d2c"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PEDeleteWorkItemResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"OAuth2":["policy.write"]}]}}},"components":{"schemas":{"ApprovalAccepted":{"type":"object","properties":{"id":{"type":"string","description":"e.g. approval_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true},"subjectId":{"type":"string","nullable":true},"log":{"allOf":[{"$ref":"#/components/schemas/PEApprovalLog"}],"description":"Represents a decision made by a specific user for an approval step","nullable":true}},"additionalProperties":false,"description":"All the approval steps have been accepted, approval considered accepted"},"ApprovalAsserted":{"type":"object","properties":{"id":{"type":"string","description":"e.g. approval_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true},"subjectId":{"type":"string","nullable":true},"log":{"allOf":[{"$ref":"#/components/schemas/PEApprovalLog"}],"description":"Represents a decision made by a specific user for an approval step","nullable":true}},"additionalProperties":false,"description":"Directly approved by the responsible person."},"ApprovalCancelled":{"type":"object","properties":{"id":{"type":"string","description":"e.g. approval_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true},"subjectId":{"type":"string","nullable":true},"userId":{"type":"string","nullable":true}},"additionalProperties":false,"description":"The approval process has been stopped permanently"},"ApprovalRejected":{"type":"object","properties":{"id":{"type":"string","description":"e.g. approval_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true},"subjectId":{"type":"string","nullable":true},"log":{"allOf":[{"$ref":"#/components/schemas/PEApprovalLog"}],"description":"Represents a decision made by a specific user for an approval step","nullable":true},"previous":{"allOf":[{"$ref":"#/components/schemas/PEApprovalUserOrGroup"}],"nullable":true}},"additionalProperties":false,"description":"The current step of the approval process has been rejected, inform the previous approver"},"ApprovalResumed":{"type":"object","properties":{"id":{"type":"string","description":"e.g. approval_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"When the approval process is resumed after rejection"},"ApprovalStarted":{"type":"object","properties":{"id":{"type":"string","description":"e.g. approval_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"data":{"allOf":[{"$ref":"#/components/schemas/PEApprovalData"}],"nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true},"flow":{"allOf":[{"$ref":"#/components/schemas/PEApprovalFlow"}],"description":"Defines an approval process consisting of one or more steps","nullable":true}},"additionalProperties":false,"description":"Approval started event"},"ApprovalUpdated":{"type":"object","properties":{"id":{"type":"string","description":"e.g. approval_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"data":{"allOf":[{"$ref":"#/components/schemas/PEApprovalLog"}],"description":"Represents a decision made by a specific user for an approval step","nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true},"next":{"allOf":[{"$ref":"#/components/schemas/PEApprovalUserOrGroup"}],"nullable":true}},"additionalProperties":false,"description":"An approval decision has been made for one of the steps\nThe current approval step has been approved, move it to the next approver"},"Client":{"type":"object","properties":{"entityId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"billingContactId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"billingChannel":{"allOf":[{"$ref":"#/components/schemas/PEContactChannel"}],"description":"How do client likes to receive invoices"}},"additionalProperties":false},"ClientCreated":{"type":"object","properties":{"id":{"type":"string","description":"e.g. client_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"data":{"allOf":[{"$ref":"#/components/schemas/ClientData"}],"nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Client moved into a state where it's gathering required data before work can be done for it."},"ClientData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. client_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"entityId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"state":{"allOf":[{"$ref":"#/components/schemas/PEClientState"}]},"clientNumber":{"type":"string","nullable":true},"sortName":{"type":"string","nullable":true},"currency":{"type":"string","description":"Currency this client deals in (inherited from Entity)","nullable":true},"taxCode":{"type":"string","description":"The default tax code applicable to this client","nullable":true},"billingContactId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"billingChannel":{"allOf":[{"$ref":"#/components/schemas/PEContactChannel"}],"description":"How do client likes to receive invoices"},"minutesPerUnit":{"type":"integer","description":"Minutes per unit for workitme duration calcuation. If blank fall back to settings at firm level","format":"int32","nullable":true},"statementOfAccountAtMatterLevel":{"type":"boolean","description":"Whether to create statement of accounts on a per matter level for this client"},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"}},"additionalProperties":false},"ClientId":{"type":"string","properties":{"value":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"e.g. client_c0645dc026a74ae99ec436df63d77d2c"},"ClientUpdated":{"type":"object","properties":{"id":{"type":"string","description":"e.g. client_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"data":{"allOf":[{"$ref":"#/components/schemas/ClientData"}],"nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Client details updated"},"Disbursement":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"reference":{"type":"string","description":"Firm-issued reference number","nullable":true},"supplierReference":{"type":"string","description":"Supplier-issued reference number","nullable":true},"description":{"type":"string","nullable":true},"memo":{"type":"string","description":"Internal notes","nullable":true},"matterId":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"isBillable":{"type":"boolean","description":"Whether this disbursement will be billable or not (affects whether it will be added to an invoice or not), only Cost Recovery can be non-billable - default true"},"billingAmount":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Money type that supports foreign and base currency"},"billingTaxCode":{"type":"string","description":"The tax code to use to bill to the client","nullable":true},"billingTax":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Money type that supports foreign and base currency"},"rate":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"The rate of the disbursement (ex tax) in supplier currency, (used to calculate the Amount)","nullable":true},"units":{"type":"number","description":"The quantity of the disbursement (used to calculate the Amount)","format":"double","nullable":true},"amount":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Money type that supports foreign and base currency"},"taxCode":{"type":"string","description":"Tax code as specified by the supplier","nullable":true},"tax":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Money type that supports foreign and base currency"},"utbmsExpenseCode":{"type":"string","description":"LEDES disbursement code","nullable":true}},"additionalProperties":false},"DisbursementData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. disbursement_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"type":{"allOf":[{"$ref":"#/components/schemas/PEDisbursementType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/PEDisbursementState"}]},"code":{"type":"string","description":"Code used to classify this disbursement internal to the firm (e.g. scan, print)","nullable":true},"date":{"type":"string","description":"The date the disbursement incurred, anticipated, or posting date in the case of cost recovery","format":"date-time"},"reference":{"type":"string","description":"Firm-issued reference number","nullable":true},"supplierReference":{"type":"string","description":"Supplier-issued reference number","nullable":true},"description":{"type":"string","nullable":true},"memo":{"type":"string","description":"Internal notes","nullable":true},"matterId":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"supplierId":{"type":"string","description":"e.g. supplier_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"isBillable":{"type":"boolean","description":"Whether this disbursement will be billable or not (affects whether it will be added to an invoice or not), only Cost Recovery can be non-billable - default true"},"billingAmount":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Money type that supports foreign and base currency"},"billingTaxCode":{"type":"string","description":"The tax code to use to bill to the client","nullable":true},"billingTax":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Money type that supports foreign and base currency"},"clientBalanceAmount":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Money type that supports foreign and base currency"},"clientBalanceTax":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Money type that supports foreign and base currency"},"rate":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"The rate of the disbursement (ex tax) in supplier currency, (used to calculate the Amount)","nullable":true},"units":{"type":"number","description":"The quantity of the disbursement (used to calculate the Amount)","format":"double","nullable":true},"amount":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Money type that supports foreign and base currency"},"taxCode":{"type":"string","description":"Tax code as specified by the supplier","nullable":true},"tax":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Money type that supports foreign and base currency"},"supplierBalanceAmount":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Money type that supports foreign and base currency"},"supplierBalanceTax":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Money type that supports foreign and base currency"},"utbmsExpenseCode":{"type":"string","description":"LEDES disbursement code","nullable":true},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"}},"additionalProperties":false},"DivisionCreated":{"type":"object","properties":{"id":{"type":"string","description":"e.g. division_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"data":{"allOf":[{"$ref":"#/components/schemas/DivisionData"}],"nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Division created"},"DivisionData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. division_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"name":{"type":"string","nullable":true},"state":{"allOf":[{"$ref":"#/components/schemas/PEDivisionState"}]},"description":{"type":"string","description":"Describes how this division classifies concepts","nullable":true},"isDefault":{"type":"boolean","description":"Flag to indicate if this division is the default for the firm"},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"}},"additionalProperties":false},"DivisionId":{"type":"string","properties":{"value":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"e.g. division_c0645dc026a74ae99ec436df63d77d2c"},"DivisionUpdated":{"type":"object","properties":{"id":{"type":"string","description":"e.g. division_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"data":{"allOf":[{"$ref":"#/components/schemas/DivisionData"}],"nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Division updated"},"DocumentCheckedIn":{"type":"object","properties":{"id":{"type":"string","description":"e.g. document_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"DocumentCollectionData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. documentcollection_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"name":{"type":"string","description":"Name of the document collection","nullable":true},"externalId":{"type":"string","description":"External identifier for the document collection","nullable":true},"subjectId":{"type":"string","description":"Internal identifier for the document collection (mapping to a PE2 object e.g. Matter)","nullable":true},"state":{"allOf":[{"$ref":"#/components/schemas/PEDocumentCollectionState"}]},"documentCount":{"type":"integer","description":"Number of documents in this library","format":"int32"},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"}},"additionalProperties":false},"DocumentCreated":{"type":"object","properties":{"id":{"type":"string","description":"e.g. document_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"data":{"allOf":[{"$ref":"#/components/schemas/PEDocumentData"}],"nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"Employee":{"type":"object","properties":{"entityId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true}},"additionalProperties":false},"EmployeeCreated":{"type":"object","properties":{"id":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"data":{"allOf":[{"$ref":"#/components/schemas/EmployeeData"}],"nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Employee record created."},"EmployeeData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"entityId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"teamId":{"type":"string","description":"e.g. team_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"jobTitleId":{"type":"string","description":"e.g. jobtitle_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"billingGradeId":{"type":"string","description":"e.g. billinggrade_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"employeeNumber":{"type":"string","description":"Firm-issued identifier for this employee","nullable":true},"teamName":{"type":"string","description":"Team display name","nullable":true},"teamL1":{"type":"string","nullable":true},"teamL2":{"type":"string","nullable":true},"email":{"type":"string","description":"Email address from the entity record","nullable":true},"state":{"allOf":[{"$ref":"#/components/schemas/PEEmployeeState"}]},"sortName":{"type":"string","nullable":true},"currency":{"type":"string","description":"Currency this employee works in (inherited from Entity)","nullable":true},"initials":{"type":"string","nullable":true},"jobTitle":{"type":"string","nullable":true},"billingGrade":{"type":"string","description":"Billing grade display name","nullable":true},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"}},"additionalProperties":false},"EmployeeId":{"type":"string","properties":{"value":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c"},"EmployeeUpdated":{"type":"object","properties":{"id":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"data":{"allOf":[{"$ref":"#/components/schemas/EmployeeData"}],"nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Employee details updated"},"Entity":{"type":"object","properties":{"entityType":{"allOf":[{"$ref":"#/components/schemas/PEEntityType"}]},"firstName":{"type":"string","description":"Required if EntityType is Individual","nullable":true},"middleNames":{"type":"string","nullable":true},"lastName":{"type":"string","description":"Required if EntityType is Individual","nullable":true},"initials":{"type":"string","nullable":true},"organisationName":{"type":"string","description":"Required if EntityType is not Individual","nullable":true},"organisationNumber":{"type":"string","description":"ABN in AU, VAT number in UK","nullable":true},"organisationNumber2":{"type":"string","description":"ACN in AU, optional in UK","nullable":true},"organisationType":{"type":"string","description":"e.g. Joint Party, Company, Unlimited Liability Company","nullable":true},"organisationContact":{"type":"string","description":"The point of contact of an organisation, e.g. Office Manager, The Owner, The Secretary","nullable":true},"preferredName":{"type":"string","description":"Nick name which the person/company prefers to be identified by colloquially. e.g. Bob","nullable":true},"title":{"type":"string","description":"e.g. Mr Mrs Miss Dr","nullable":true},"email":{"type":"string","nullable":true},"addresses":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/PEAddress"},"nullable":true},"numbers":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/PENumber"},"description":"Phone/Fax and other numbers","nullable":true},"preferredContact":{"allOf":[{"$ref":"#/components/schemas/PEContactChannel"}],"description":"Preferred contact method for this entity. This is used to determine how to send invoices and other correspondence to this entity. If not specified, the default is email."}},"additionalProperties":false},"EntityData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"entityType":{"allOf":[{"$ref":"#/components/schemas/PEEntityType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/PEEntityState"}]},"isVerified":{"type":"boolean","description":"Has this entity been identified/verified"},"clientId":{"type":"string","description":"e.g. client_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"employeeId":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"supplierId":{"type":"string","description":"e.g. supplier_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"salutation":{"type":"string","description":"e.g. 'To whom it may concern', 'Dear Mr Smith'","nullable":true},"firstName":{"type":"string","description":"Required if EntityType is Individual","nullable":true},"middleNames":{"type":"string","nullable":true},"lastName":{"type":"string","description":"Required if EntityType is Individual","nullable":true},"initials":{"type":"string","nullable":true},"organisationName":{"type":"string","description":"Required if EntityType is not Individual","nullable":true},"organisationNumber":{"type":"string","description":"ABN in AU, VAT number in UK","nullable":true},"organisationNumber2":{"type":"string","description":"ACN in AU, optional in UK","nullable":true},"organisationType":{"type":"string","description":"e.g. Joint Party, Company, Unlimited Liability Company","nullable":true},"organisationContact":{"type":"string","description":"The point of contact of an organisation, e.g. Office Manager, The Owner, The Secretary","nullable":true},"preferredName":{"type":"string","description":"Nick name which the person/company prefers to be identified by colloquially. e.g. Bob","nullable":true},"title":{"type":"string","description":"e.g. Mr Mrs Miss Dr","nullable":true},"entityNumber":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"currency":{"type":"string","description":"The currency that the accounting system should use when dealing with this entity. Defaults to the firm's base currency.","nullable":true},"addresses":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/PEAddress"},"nullable":true},"numbers":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/PENumber"},"description":"Phone/Fax and other numbers","nullable":true},"preferredContact":{"allOf":[{"$ref":"#/components/schemas/PEContactChannel"}],"description":"Preferred contact method for this entity. This is used to determine how to send invoices and other correspondence to this entity. If not specified, the default is email."},"documentCollectionId":{"type":"string","description":"e.g. documentcollection_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"paymentMethodId":{"type":"string","description":"e.g. paymentmethod_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"sortName":{"type":"string","description":"For Individual entities concatenated name fields [Last, First]. For all others the organisation name.","nullable":true},"fullName":{"type":"string","description":"For Individual entities concatenated name fields [First Middle Last]. For all others the organisation name.","nullable":true},"streetAddress":{"type":"string","description":"Address of type Street, or null if none found. Used as part of the entity's identity.","nullable":true},"billingAddress":{"type":"string","description":"Address of type Billing, or null if none found","nullable":true},"postalAddress":{"type":"string","description":"Address of type Postal, or null if none found","nullable":true},"primaryContactEntityId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"formTemplateId":{"type":"string","description":"e.g. formtemplate_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"}},"additionalProperties":false},"EntityEdit":{"type":"object","properties":{"entityType":{"$ref":"#/components/schemas/PEEntityType"},"firstName":{"type":"string"},"middleNames":{"type":"string"},"lastName":{"type":"string"},"initials":{"type":"string"},"organisationName":{"type":"string"},"organisationNumber":{"type":"string"},"organisationNumber2":{"type":"string"},"organisationType":{"type":"string"},"organisationContact":{"type":"string"},"preferredName":{"type":"string"},"title":{"type":"string"},"email":{"type":"string"},"addresses":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/PEAddress"}},"numbers":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/PENumber"}},"preferredContact":{"$ref":"#/components/schemas/PEContactChannel"}},"additionalProperties":false},"EntityId":{"type":"string","properties":{"value":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c"},"FindDisbursementCodesResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PagedListOfPEDisbursementCode"}],"description":"Paged list of something","nullable":true},"success":{"type":"boolean"},"reason":{"type":"string","nullable":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed."}},"additionalProperties":false},"FindTaskTypesResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PagedListOfPETaskType"}],"description":"Paged list of something","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"FindTaxCodesResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PagedListOfPETaxCode"}],"description":"Paged list of something","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"FxAmount":{"type":"object","properties":{"b":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"Value in base or base currency","readOnly":true},"f":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"Value in foreign currency, or null if only base currency set","nullable":true,"readOnly":true},"r":{"type":"number","description":"The exchange rate used to take base currency to foreign currency. When F is null, R should be 0.","format":"double","readOnly":true}},"additionalProperties":false,"description":"Money type that supports foreign and base currency"},"IPagedListOfPE.Mk2.App.WebApi.Webhooks.WebhookInvocationData":{"type":"object","properties":{"totalCount":{"type":"integer","description":"Total number of items in the list","format":"int32","readOnly":true},"pageIndex":{"type":"integer","description":"Index of the page","format":"int32","readOnly":true},"pageSize":{"type":"integer","description":"Size of each page","format":"int32","readOnly":true},"rows":{"type":"array","items":{"$ref":"#/components/schemas/PE.Mk2.App.WebApi.Webhooks.WebhookInvocationData"},"nullable":true,"readOnly":true}},"additionalProperties":false},"ImportFinished":{"type":"object","properties":{"sourceId":{"type":"string","nullable":true},"reason":{"type":"string","nullable":true},"startedOn":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Signals that an import session has finished for a tenant."},"ImportProgressed":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid"},"startedOn":{"type":"string","format":"date-time"},"progressUpdatedOn":{"type":"string","format":"date-time"},"totalEvents":{"type":"integer","format":"int64","nullable":true},"eventsSeen":{"type":"integer","format":"int64"},"status":{"type":"string","nullable":true},"reason":{"type":"string","nullable":true},"sourceId":{"type":"string","nullable":true}},"additionalProperties":false,"description":"Periodic import progress snapshot emitted during an active import."},"ImportStarted":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid"},"startedOn":{"type":"string","format":"date-time"},"sourceId":{"type":"string","nullable":true},"totalEvents":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false,"description":"Signals that an import session has started for a tenant."},"Invoice":{"type":"object","properties":{"matterId":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"invoiceDate":{"type":"string","format":"date-time"},"title":{"type":"string","description":"Description of the invoice, e.g. Fees and Disbursements for January","nullable":true},"retainedAmount":{"type":"number","description":"When queried, all non-released allotments against this invoice are summed. It may be freely changed until finalised, when a single allotment will be created/consolidated.","format":"double","nullable":true}},"additionalProperties":false},"InvoiceData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. invoice_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"matterId":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"invoiceNumber":{"type":"string","nullable":true},"invoiceDate":{"type":"string","format":"date-time"},"sentDate":{"type":"string","description":"The date the invoice was sent to the customer","format":"date-time","nullable":true},"currency":{"type":"string","description":"Invoice currency, as shown to the recipient. If not specified, assumes base currency","nullable":true},"baseCurrency":{"type":"string","description":"Base currency, the currency the firm operates in.","nullable":true},"exchangeRate":{"type":"number","description":"Exchange rate used to take base currency to transaction currency (i.e. Amount = ExchangeRate * AmountB or AmountB = Amount / ExchangeRate). It is used to calculate base value of fees line items, not disbursements, which is fixed to the exchange rate on creation.","format":"double"},"state":{"allOf":[{"$ref":"#/components/schemas/PEInvoiceState"}]},"type":{"allOf":[{"$ref":"#/components/schemas/PEInvoiceType"}],"description":"What type of invoice this is, standard or split"},"templateId":{"type":"string","description":"e.g. reporttemplate_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"billToEntityId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"billToSortName":{"type":"string","description":"Billing entity sort name. Used for free text entity creation","nullable":true},"billingAddress":{"type":"string","description":"Address of the entity to bill","nullable":true},"title":{"type":"string","description":"Description of the invoice, e.g. Fees and Disbursements for January","nullable":true},"retainedAmount":{"type":"number","description":"When queried, all non-released allotments against this invoice are summed. It may be freely changed until finalised, when a single allotment will be created/consolidated.","format":"double","nullable":true},"totalAmount":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Money type that supports foreign and base currency"},"totalTax":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Money type that supports foreign and base currency"},"balance":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Money type that supports foreign and base currency"},"unpaidDisbursement":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Money type that supports foreign and base currency"},"parentId":{"type":"string","description":"e.g. invoice_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"splitPercentage":{"type":"number","description":"For invoice splits, the percentage of the parent invoice","format":"double","nullable":true},"originalInvoiceId":{"type":"string","description":"e.g. invoice_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"formTemplateId":{"type":"string","description":"e.g. formtemplate_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"}},"additionalProperties":false},"InvoiceIssued":{"type":"object","properties":{"id":{"type":"string","description":"e.g. invoice_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true},"invoice":{"allOf":[{"$ref":"#/components/schemas/InvoiceData"}],"nullable":true}},"additionalProperties":false,"description":"Invoice has been approved, accounting entries posted, and issued"},"InvoiceUnfinalised":{"type":"object","properties":{"id":{"type":"string","description":"e.g. invoice_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true},"matterId":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"cancelDate":{"type":"string","format":"date-time"},"reason":{"type":"string","nullable":true},"transactionId":{"type":"string","description":"e.g. transaction_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"originalTransactionId":{"type":"string","description":"e.g. transaction_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"originalInvoiceNumber":{"type":"string","nullable":true}},"additionalProperties":false,"description":"An Issued or Closed invoice has been put back into Draft state"},"JournalPosted":{"type":"object","properties":{"id":{"type":"string","description":"e.g. transaction_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"data":{"allOf":[{"$ref":"#/components/schemas/PETransactionData"}],"nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"A General Journal transaction has been posted"},"LedgerEntryData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. ledgerentry_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"date":{"type":"string","format":"date-time"},"ledgerId":{"type":"string","description":"e.g. ledger_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"transactionId":{"type":"string","description":"e.g. transaction_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"isDebit":{"type":"boolean"},"amount":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Money type that supports foreign and base currency"},"tax":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Money type that supports foreign and base currency"},"type":{"allOf":[{"$ref":"#/components/schemas/PELedgerEntryType"}]},"invoiceId":{"type":"string","description":"e.g. invoice_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"documentReference":{"type":"string","description":"The invoice number from the supplier on the purchase or the disbursement supplier reference","nullable":true},"purchaseId":{"type":"string","description":"e.g. purchase_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"supplierId":{"type":"string","description":"e.g. supplier_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"isReversed":{"type":"boolean","description":"Indicates if this is a reversed or a reversal entry"},"matterId":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"disbursementId":{"type":"string","description":"e.g. disbursement_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"paymentMethodDetail":{"type":"string","description":"Description of the payment method used for reporting","nullable":true},"otherPartyId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"otherPartySortName":{"type":"string","description":"Other Party name","nullable":true},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"}},"additionalProperties":false},"Matter":{"type":"object","properties":{"divisionId":{"type":"string","description":"e.g. division_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"clientId":{"type":"string","description":"e.g. client_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"responsiblePersonId":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"actingPersonId":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"assistingPersonId":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"matterTypeId":{"type":"string","description":"e.g. mattertype_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"matterNumber":{"type":"string","description":"User facing unique identifier for the matter","nullable":true},"title":{"type":"string","description":"One-line description of the matter","nullable":true},"dateOpened":{"type":"string","description":"The date on which the matter was opened.","format":"date-time","nullable":true},"billingContactId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"feeEstimate":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"Estimated fee target for the matter","nullable":true},"disbursementEstimate":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"Estimated disbursement target for the matter","nullable":true},"introducerId":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c","nullable":true}},"additionalProperties":false},"MatterData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"state":{"allOf":[{"$ref":"#/components/schemas/PEMatterState"}]},"aclId":{"type":"string","description":"ACL Identifier to control the access permissions to this matter","nullable":true},"divisionId":{"type":"string","description":"e.g. division_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"clientId":{"type":"string","description":"e.g. client_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"clientEntityId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"officeLedgerId":{"type":"string","description":"e.g. ledger_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"responsiblePersonId":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"actingPersonId":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"assistingPersonId":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"matterTypeId":{"type":"string","description":"e.g. mattertype_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"matterNumber":{"type":"string","description":"User facing unique identifier for the matter","nullable":true},"title":{"type":"string","description":"One-line description of the matter","nullable":true},"dateOpened":{"type":"string","description":"The date on which the matter was opened.","format":"date-time","nullable":true},"dateClosed":{"type":"string","description":"The date on which the matter was closed.","format":"date-time","nullable":true},"dateArchived":{"type":"string","description":"The date on which the matter was archived.","format":"date-time","nullable":true},"billingContactId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"currency":{"type":"string","description":"Currency code this matter deals in. Office Ledger entries will always have a home currency value, and if this property is set, always have a foreign currency value. Trust ledger entries will only have a base currency value, but the currency code may be different depending on which bank account was used to transact.","nullable":true},"exchangeRate":{"type":"number","description":"If matter currency is different to firm's base currency, the exchange rate to take firm currency to matter currency. If not specified, uses spot rate from data provider.","format":"double","nullable":true},"invoiceTemplateId":{"type":"string","description":"e.g. reporttemplate_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"draftInvoiceId":{"type":"string","description":"e.g. invoice_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"feeEstimate":{"type":"number","description":"Estimated fee target for the matter","format":"double","nullable":true},"disbursementEstimate":{"type":"number","description":"Estimated disbursement target for the matter","format":"double","nullable":true},"creditNoteBalance":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"Represents Money, an amount defined in a specific Currency."},"officeFundsBalance":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"Represents Money, an amount defined in a specific Currency."},"divisionName":{"type":"string","nullable":true},"matterType":{"type":"string","nullable":true},"matterTypeL1":{"type":"string","nullable":true},"matterTypeL2":{"type":"string","nullable":true},"clientSortName":{"type":"string","nullable":true},"billingContactSortName":{"type":"string","nullable":true},"documentCollectionId":{"type":"string","description":"e.g. documentcollection_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"actingPerson":{"allOf":[{"$ref":"#/components/schemas/PEEmployeeRef"}],"nullable":true},"responsiblePerson":{"allOf":[{"$ref":"#/components/schemas/PEEmployeeRef"}],"nullable":true},"assistingPerson":{"allOf":[{"$ref":"#/components/schemas/PEEmployeeRef"}],"nullable":true},"introducerId":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"formTemplateId":{"type":"string","description":"e.g. formtemplate_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"minutesPerUnit":{"type":"integer","description":"Minutes per unit for workitme duration calcuation. If blank fall back to settings at client level","format":"int32","nullable":true},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"}},"additionalProperties":false},"MatterEdit":{"type":"object","properties":{"divisionId":{"$ref":"#/components/schemas/DivisionId"},"clientId":{"$ref":"#/components/schemas/ClientId"},"responsiblePersonId":{"$ref":"#/components/schemas/EmployeeId"},"actingPersonId":{"$ref":"#/components/schemas/EmployeeId"},"assistingPersonId":{"$ref":"#/components/schemas/EmployeeId"},"matterTypeId":{"$ref":"#/components/schemas/MatterTypeId"},"matterNumber":{"type":"string"},"title":{"type":"string"},"dateOpened":{"type":"string","format":"date-time","nullable":true},"billingContactId":{"$ref":"#/components/schemas/EntityId"},"feeEstimate":{"type":"number","format":"double","nullable":true},"disbursementEstimate":{"type":"number","format":"double","nullable":true},"introducerId":{"$ref":"#/components/schemas/EmployeeId"}},"additionalProperties":false},"MatterId":{"type":"string","properties":{"value":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c"},"MatterType":{"type":"object","properties":{"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"parentId":{"type":"string","description":"e.g. mattertype_c0645dc026a74ae99ec436df63d77d2c","nullable":true}},"additionalProperties":false},"MatterTypeData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. mattertype_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"parentId":{"type":"string","description":"e.g. mattertype_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"state":{"allOf":[{"$ref":"#/components/schemas/PEMatterTypeState"}]},"openingChecklistId":{"type":"string","description":"e.g. checklist_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"closingChecklistId":{"type":"string","description":"e.g. checklist_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"tagCode":{"type":"integer","description":"Short unique identifier used for tagging, includes parent code, e.g. 1-1. If a matter type is moved to another parent, it is recalculated.","format":"int64"},"formTemplateId":{"type":"string","description":"e.g. formtemplate_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"}},"additionalProperties":false},"MatterTypeId":{"type":"string","properties":{"value":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"e.g. mattertype_c0645dc026a74ae99ec436df63d77d2c"},"MatterUpdated":{"type":"object","properties":{"id":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"data":{"allOf":[{"$ref":"#/components/schemas/MatterData"}],"nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Matter details updated"},"NodaMoney.Money":{"type":"object","properties":{"Amount":{"type":"number","description":"The amount of money","format":"decimal"},"Currency":{"type":"string","description":"The currency (e.g. AUD, GBP)"}},"additionalProperties":false,"description":"Represents Money, an amount defined in a specific Currency."},"PE.Identity.DataTypes.RoleDetails":{"type":"object","properties":{"roleId":{"type":"string","nullable":true},"roleName":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"entitlements":{"type":"string","nullable":true},"isSystem":{"type":"boolean"},"userIds":{"type":"array","items":{"type":"string"},"nullable":true},"createdBy":{"type":"string","nullable":true},"lastUpdatedBy":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"lastUpdatedOn":{"type":"string","format":"date-time"}},"additionalProperties":false,"description":"Role data from database"},"PE.Identity.Messages.FindRolesResult":{"type":"object","properties":{"reason":{"type":"string","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"data":{"allOf":[{"$ref":"#/components/schemas/PagedListOfPE.Identity.DataTypes.RoleDetails"}],"description":"Paged list of something","nullable":true,"readOnly":true}},"additionalProperties":false},"PE.Identity.Messages.GetRoleResult":{"type":"object","properties":{"reason":{"type":"string","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"role":{"allOf":[{"$ref":"#/components/schemas/PE.Identity.DataTypes.RoleDetails"}],"description":"Role data from database","nullable":true,"readOnly":true}},"additionalProperties":false},"PE.Mk2.App.WebApi.DataTypes.EntityRelationRequest":{"type":"object","properties":{"targetEntityId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"role":{"type":"string","description":"The nature of the relationship between the parent entity and the target entity.","nullable":true},"memo":{"type":"string","description":"An optional memo or note that provides additional context about the relationship.","nullable":true}},"additionalProperties":false,"description":"Request to create a relation between entities"},"PE.Mk2.App.WebApi.DataTypes.MatterPermissionsRequest":{"type":"object","properties":{"aclOverride":{"type":"boolean","nullable":true},"accessEntries":{"type":"array","items":{"$ref":"#/components/schemas/PEAccessEntry"},"nullable":true}},"additionalProperties":false},"PE.Mk2.App.WebApi.Webhooks.FindWebhookInvocationsResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/IPagedListOfPE.Mk2.App.WebApi.Webhooks.WebhookInvocationData"}],"nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PE.Mk2.App.WebApi.Webhooks.GetWebhookInvocationResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PE.Mk2.App.WebApi.Webhooks.WebhookInvocationDataWithPayload"}],"nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PE.Mk2.App.WebApi.Webhooks.ReplayWebhookInvocationResult":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PE.Mk2.App.WebApi.Webhooks.WebhookInvocationData":{"type":"object","properties":{"offset":{"type":"integer","format":"int64"},"webhookId":{"type":"string","description":"e.g. webhook_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"log":{"type":"array","items":{"$ref":"#/components/schemas/PE.Mk2.App.WebApi.Webhooks.WebhookInvocationLogData"},"nullable":true},"eventType":{"type":"string","nullable":true}},"additionalProperties":false},"PE.Mk2.App.WebApi.Webhooks.WebhookInvocationDataWithPayload":{"type":"object","properties":{"offset":{"type":"integer","format":"int64"},"webhookId":{"type":"string","description":"e.g. webhook_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"log":{"type":"array","items":{"$ref":"#/components/schemas/PE.Mk2.App.WebApi.Webhooks.WebhookInvocationLogData"},"nullable":true},"eventType":{"type":"string","nullable":true}},"additionalProperties":false},"PE.Mk2.App.WebApi.Webhooks.WebhookInvocationLogData":{"type":"object","properties":{"endPoint":{"type":"string","nullable":true},"invokedAt":{"type":"string","format":"date-time"},"message":{"type":"string","nullable":true},"statusCode":{"type":"integer","format":"int32"}},"additionalProperties":false},"PE.ServiceBus.CQRS.Core.ResultCode":{"enum":[0,100,101,102,103,104,105,106,107,108,109,110],"type":"integer","description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","format":"int32","x-enum-varnames":["None","Ok","NotFound","AlreadyExists","InvalidState","ValidationFailed","Unauthorized","Conflict","PreconditionFailed","Unavailable","Timeout","NotImplemented"],"x-enum-descriptions":["","","","","","","","","","","",""],"x-enumDescriptions":{"0:None":"","1:Ok":"","2:NotFound":"","3:AlreadyExists":"","4:InvalidState":"","5:ValidationFailed":"","6:Unauthorized":"","7:Conflict":"","8:PreconditionFailed":"","9:Unavailable":"","10:Timeout":"","11:NotImplemented":""}},"PEAccessEntry":{"type":"object","properties":{"employeeId":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"teamId":{"type":"string","description":"e.g. team_c0645dc026a74ae99ec436df63d77d2c","nullable":true}},"additionalProperties":false,"description":"Defines an access control entry for a matter, granting access to either an employee or a team.\nExactly one of PE.Mk2.Accounting.V1.AccessEntry.EmployeeId or PE.Mk2.Accounting.V1.AccessEntry.TeamId should be specified (mutually exclusive).\nNote: EmployeeId and TeamId are domain aggregate identifiers, not identity-service UserId/GroupId values.\nThe system resolves these to the corresponding UserId and GroupId at ACL creation time."},"PEAccountType":{"enum":[0,1,2],"type":"integer","format":"int32","x-enum-varnames":["Standard","Bank","InterJournalTransfer"],"x-enum-descriptions":["Standard GL account with no special behaviour","A GL account that mirrors a bank account and may participate in cashbook operations","For accounts used for inter-journal transfers"],"x-enumDescriptions":{"0:Standard":"Standard GL account with no special behaviour","1:Bank":"A GL account that mirrors a bank account and may participate in cashbook operations","2:InterJournalTransfer":"For accounts used for inter-journal transfers"}},"PEActivateClientResult":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEActivateEmployeeResult":{"type":"object","properties":{"data":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEActivateEntityResult":{"type":"object","properties":{"data":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEActivateMatterResult":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEActivateSupplierResult":{"type":"object","properties":{"data":{"type":"string","description":"e.g. supplier_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEAddress":{"type":"object","properties":{"attentionOf":{"type":"string","nullable":true},"addressType":{"allOf":[{"$ref":"#/components/schemas/PEAddressType"}]},"street":{"type":"string","nullable":true},"locality":{"type":"string","nullable":true},"suburb":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"postCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"default":{"type":"boolean"},"note":{"type":"string","nullable":true}},"additionalProperties":false},"PEAddressType":{"enum":[0,1,2],"type":"integer","format":"int32","x-enum-varnames":["Billing","Postal","Street"],"x-enum-descriptions":["","",""],"x-enumDescriptions":{"0:Billing":"","1:Postal":"","2:Street":""}},"PEApplicableRate":{"type":"object","properties":{"id":{"type":"string","description":"e.g. rate_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"name":{"type":"string","nullable":true},"rateSetId":{"type":"string","description":"e.g. rateset_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"isOverride":{"type":"boolean","description":"True means it's a client/matter override rate set. False means it's a global rate set"},"rateSetName":{"type":"string","description":"The name of the rate set this rate belongs to","nullable":true},"matterTypeId":{"type":"string","description":"e.g. mattertype_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"taskTypeId":{"type":"string","description":"e.g. tasktype_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"jobTitleId":{"type":"string","description":"e.g. jobtitle_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"billingGradeId":{"type":"string","description":"e.g. billinggrade_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"employeeId":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"effectivePeriod":{"allOf":[{"$ref":"#/components/schemas/RangeOfDateTime"}],"nullable":true},"itemType":{"allOf":[{"$ref":"#/components/schemas/PEWorkItemType"}],"description":"PE.Mk2.Accounting.V1.Rate.ItemType"},"value":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"The rate including any forex calculations using rules applied on the matter"}},"additionalProperties":false,"description":"Describes an applicable rate"},"PEApprovalData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. approval_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"state":{"allOf":[{"$ref":"#/components/schemas/PEApprovalState"}]},"type":{"type":"string","description":"Only Requisition is supported at the moment","nullable":true},"requestedOn":{"type":"string","description":"The date this request was requested on","format":"date-time"},"requesterId":{"type":"string","description":"Requester who created this approval","nullable":true},"requesterSortName":{"type":"string","description":"Requester sort name","nullable":true},"subjectId":{"type":"string","description":"Unique identifier, usually IIdentity, of the aggregate being approved","nullable":true},"requiredOn":{"type":"string","description":"Required on","format":"date-time","nullable":true},"title":{"type":"string","description":"Short title of the approval request","nullable":true},"explanation":{"type":"string","description":"Detailed explanation of why it should be approved","nullable":true},"rejectReason":{"type":"string","description":"Reason the approval was rejected","nullable":true},"currentStep":{"type":"integer","description":"Where is it up to in the approval flow","format":"int32"},"assignedOn":{"type":"string","description":"Current step was assigned to the approver(s) at this time","format":"date-time","nullable":true},"approverUserId":{"type":"string","description":"Current step approver user id","nullable":true},"approverSortName":{"type":"string","description":"Current step approver user name","nullable":true},"approverGroupId":{"type":"string","description":"Current step approver group id","nullable":true},"approverGroupName":{"type":"string","description":"Current step approver group name","nullable":true},"decidedOn":{"type":"string","description":"Approve or reject decision made on","format":"date-time","nullable":true},"processedOn":{"type":"string","description":"When the approved job was actioned","format":"date-time","nullable":true},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"}},"additionalProperties":false},"PEApprovalFlow":{"type":"object","properties":{"name":{"type":"string","description":"Name of this template","nullable":true},"description":{"type":"string","nullable":true},"type":{"type":"string","description":"What this approval flow applies to. Only Requisition is supported at the moment","nullable":true},"steps":{"type":"array","items":{"$ref":"#/components/schemas/PEApprovalStep"},"description":"The ordered list of steps","nullable":true}},"additionalProperties":false,"description":"Defines an approval process consisting of one or more steps"},"PEApprovalLog":{"type":"object","properties":{"step":{"type":"integer","description":"Zero-based index of which step","format":"int32","readOnly":true},"decidedOn":{"type":"string","description":"When was the decision made","format":"date-time","readOnly":true},"userId":{"type":"string","description":"Decided by this user","nullable":true,"readOnly":true},"reason":{"type":"string","description":"Reason","nullable":true,"readOnly":true},"rejected":{"type":"boolean","description":"Rejected or Accepted","readOnly":true}},"additionalProperties":false,"description":"Represents a decision made by a specific user for an approval step"},"PEApprovalState":{"enum":[0,1,2,3],"type":"integer","format":"int32","x-enum-varnames":["Pending","Accepted","Rejected","Cancelled"],"x-enum-descriptions":["Approval process started on the first step, or it has passed a previous approval step, awaiting the next step","Approval process completed with each step accepted","The previous approval step has been rejected, process moved back one step awaiting for revision and acceptance","Approval process permanently cancelled"],"x-enumDescriptions":{"0:Pending":"Approval process started on the first step, or it has passed a previous approval step, awaiting the next step","1:Accepted":"Approval process completed with each step accepted","2:Rejected":"The previous approval step has been rejected, process moved back one step awaiting for revision and acceptance","3:Cancelled":"Approval process permanently cancelled"}},"PEApprovalStep":{"type":"object","properties":{"userId":{"type":"string","description":"The user ID of the","nullable":true},"groupId":{"type":"string","description":"Group ID","nullable":true},"subjectRole":{"type":"string","description":"In the event that this approval step is assignable to a context-specific role (e.g. a matter's responsible person), \nthe role name. The meaning of this role name is as interpreted by ApprovalFlow.Subject by the subject (e.g. MatterAggregate) \nwhen the workflow is started, and translated into UserId and GroupId","nullable":true},"name":{"type":"string","description":"Short name of this approval step","nullable":true,"example":"Validate Budget"},"description":{"type":"string","description":"Detailed instruction of what this approval step means","nullable":true,"example":"Confirm there is sufficient budget for this GL and if the purchase is beneficial for the firm"}},"additionalProperties":false,"description":"Defines a step in an approval process"},"PEApprovalUserOrGroup":{"type":"object","properties":{"step":{"type":"integer","format":"int32","readOnly":true},"userId":{"type":"string","nullable":true,"readOnly":true},"sortName":{"type":"string","nullable":true,"readOnly":true},"groupId":{"type":"string","nullable":true,"readOnly":true},"groupName":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEAvailableTrustBalance":{"type":"object","properties":{"accountId":{"type":"string","description":"e.g. account_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"totalBalance":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"Represents Money, an amount defined in a specific Currency."},"totalAlloted":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"Represents Money, an amount defined in a specific Currency."},"availableBalance":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"Represents Money, an amount defined in a specific Currency."}},"additionalProperties":false},"PEBankAccountDetails":{"type":"object","properties":{"routingCode":{"type":"string","description":"The unique identifier used by the banking system at large to identify international transfer accounts IBAN/Swift","nullable":true},"branchCode":{"type":"string","description":"The Branch code of the bank","nullable":true},"number":{"type":"string","description":"Account number issued by the bank","nullable":true},"name":{"type":"string","description":"Account name known by the bank","nullable":true},"bankName":{"type":"string","description":"Financial institution name","nullable":true},"branchName":{"type":"string","description":"Branch name","nullable":true}},"additionalProperties":false,"description":"Standardised bank account identifier used by the wider world used to take money"},"PEBillingBasis":{"enum":[0,1,2,3],"type":"integer","format":"int32","x-enum-varnames":["AdHoc","Periodic","ProBono","NonBillable"],"x-enum-descriptions":["Matter has to be marked as billing for it to be included in the automated billing run","Matter will be billed periodically according to the firm default billing schedule","Matters marked as pro bono work. Any invoices generated will automatically be adjusted to $0 (including fees and disbursements)","Matter will not be included in any billing, and marked as internal admin matter. This can never be changed after the matter is active"],"x-enumDescriptions":{"0:AdHoc":"Matter has to be marked as billing for it to be included in the automated billing run","1:Periodic":"Matter will be billed periodically according to the firm default billing schedule","2:ProBono":"Matters marked as pro bono work. Any invoices generated will automatically be adjusted to $0 (including fees and disbursements)","3:NonBillable":"Matter will not be included in any billing, and marked as internal admin matter. This can never be changed after the matter is active"}},"PEBillingCycleStats":{"type":"object","properties":{"billable":{"type":"number","description":"The increase/decrease in value that has been included on issued invoices, before any adjustments, and exclusive of tax","format":"double"},"billed":{"type":"number","description":"The increase/decrease in value that has been included on issued invoices, after any adjustments, and exclusive of tax","format":"double"},"billedUnits":{"type":"number","description":"The increase/decrease in units that has been included on issued invoices, after any adjustments, and exclusive of tax","format":"double"},"collected":{"type":"number","description":"The increase/decrease in value received from client, tax exclusive","format":"double"},"discounted":{"type":"number","description":"The increase/decrease in value discounted (firm offering discount) after the invoice is issued, by applying credit notes. Tax exclusive.","format":"double"},"writtenOff":{"type":"number","description":"The increase/decrease in value written-off (client non-payment) after the invoice is issued, by writing it off. Tax exclusive.","format":"double"}},"additionalProperties":false,"description":"Billing cycle tuple"},"PECanTransitionResult":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true},"id":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c","nullable":true}},"additionalProperties":false},"PECancelDisbursementResult":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PECashDetail":{"type":"object","properties":{"amountInNotes":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"Represents Money, an amount defined in a specific Currency."},"amountInCoins":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"Represents Money, an amount defined in a specific Currency."}},"additionalProperties":false},"PECheckInDocumentResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PEDocumentData"}],"nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PECheckOutDocumentResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PEDownloadDocumentData"}],"nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEClientHeader":{"type":"object","properties":{"id":{"type":"string","description":"e.g. client_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"sortName":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"streetAddress":{"type":"string","nullable":true},"clientNumber":{"type":"string","nullable":true},"entityId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"state":{"allOf":[{"$ref":"#/components/schemas/PEClientState"}]}},"additionalProperties":false,"description":"Client in search results"},"PEClientState":{"enum":[0,1,2,3,4],"type":"integer","format":"int32","x-enum-varnames":["Draft","Active","Held","Closing","Closed"],"x-enum-descriptions":["In the process of being creating, some operations may not be allowed","Currently acting for the client with no restrictions","No work can be done for this client","In the process of being closed","Zero balance, and no more activity against the client is allowed"],"x-enumDescriptions":{"0:Draft":"In the process of being creating, some operations may not be allowed","1:Active":"Currently acting for the client with no restrictions","2:Held":"No work can be done for this client","3:Closing":"In the process of being closed","4:Closed":"Zero balance, and no more activity against the client is allowed"}},"PECloseClientResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PEClientState"}],"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PECloseMatterResult":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PECloseSupplierResult":{"type":"object","properties":{"data":{"type":"string","description":"e.g. supplier_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEConfigureMatterPermissionsResult":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Result payload used by the public matter permissions endpoint."},"PEContactChannel":{"enum":[0,1,2,3],"type":"integer","format":"int32","x-enum-varnames":["Email","Post","SMS","Phone"],"x-enum-descriptions":["","","",""],"x-enumDescriptions":{"0:Email":"","1:Post":"","2:SMS":"","3:Phone":""}},"PECreateClientResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PEClientHeader"}],"description":"Client in search results","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true},"rollbackCmd":{"allOf":[{"$ref":"#/components/schemas/PEDeleteClient"}],"description":"Delete, also known as archive client","nullable":true,"readOnly":true}},"additionalProperties":false},"PECreateDocumentResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PEDocumentData"}],"nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PECreateEmployeeResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PEEmployeeHeader"}],"description":"Client in search results","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PECreateEntityResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PEEntityHeader"}],"description":"Entity in search results","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEDeleteClient":{"type":"object","properties":{"aggregateId":{"type":"string","description":"e.g. client_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"sourceId":{"type":"string","description":"Original source id of this command. \nNote this command may have been spawen from another command.","nullable":true,"readOnly":true},"commandId":{"type":"string","description":"Unique Identifier for the command","format":"uuid","readOnly":true}},"additionalProperties":false,"description":"Delete, also known as archive client"},"PEDeleteClientResult":{"type":"object","properties":{"data":{"type":"string","description":"e.g. client_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEDeleteEmployeeResult":{"type":"object","properties":{"data":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEDeleteEntityResult":{"type":"object","properties":{"data":{"type":"boolean","readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Result from delete entity. False data indicates entity has moved to deleting state, when \nit is still a client, supplier or employee, and a delete request has been sent. True \nmeans it is marked deleted immediately as it is not a client, supplier or employee."},"PEDeleteMatterResult":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEDeleteRelationLinksResult":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEDeleteSupplierResult":{"type":"object","properties":{"data":{"type":"string","description":"e.g. supplier_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEDeleteWorkItemResult":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEDisableWebhookResult":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEDisbursementCode":{"type":"object","properties":{"id":{"type":"string","description":"e.g. disbursementcode_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"name":{"type":"string","description":"Display name of the disbursement code","nullable":true},"code":{"type":"string","description":"Code used by firm to identify this disbursment template","nullable":true},"description":{"type":"string","description":"As it will appear on invoices issued to the client","nullable":true},"type":{"allOf":[{"$ref":"#/components/schemas/PEDisbursementType"}],"description":"Cost Recovery, Incurred, and Anticipated"},"taxCode":{"type":"string","description":"Supplier tax code","nullable":true},"isBillable":{"type":"boolean","description":"Whether or not the disbursement is billable by default"},"utbmsExpenseCode":{"type":"string","description":"LEDES disbursement code if applicable","nullable":true},"rate":{"type":"number","description":"Unit price (ex tax). When applicable only to disbursements. in supplier currency; When applicable for cost recovery, in firm currency","format":"double","nullable":true},"tag":{"allOf":[{"$ref":"#/components/schemas/PETag"}],"description":"Defines an instance of a tag","nullable":true},"journalId":{"type":"string","description":"e.g. journal_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"glAccountId":{"type":"string","description":"e.g. account_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"incurredType":{"allOf":[{"$ref":"#/components/schemas/PEIncurredType"}],"description":"If specified, only applicable to Purchase/Payment or General Ledger","nullable":true},"supplierId":{"type":"string","description":"e.g. supplier_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"entityId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"entityName":{"type":"string","description":"Used for free text entity creation","nullable":true}},"additionalProperties":false,"description":"Disbursement Code used to prefill a disbursment"},"PEDisbursementState":{"enum":[0,1,2],"type":"integer","format":"int32","x-enum-varnames":["Open","Closed","Cancelled"],"x-enum-descriptions":["Open means disbursement is going through its lifecycle","Closed means it has been billed/receipted/written-off or otherwise dealt with","Disbursement has been cancelled"],"x-enumDescriptions":{"0:Open":"Open means disbursement is going through its lifecycle","1:Closed":"Closed means it has been billed/receipted/written-off or otherwise dealt with","2:Cancelled":"Disbursement has been cancelled"}},"PEDisbursementType":{"enum":[0,1,2],"type":"integer","format":"int32","x-enum-varnames":["CostRecovery","Anticipated","Incurred"],"x-enum-descriptions":["Recovering office expenses","Anticipated disbursement, no invoice from supplier, no payment to supplier, but want to create it for billing","Immediately paid out of the bank already"],"x-enumDescriptions":{"0:CostRecovery":"Recovering office expenses","1:Anticipated":"Anticipated disbursement, no invoice from supplier, no payment to supplier, but want to create it for billing","2:Incurred":"Immediately paid out of the bank already"}},"PEDivisionState":{"enum":[0,1,2],"type":"integer","format":"int32","x-enum-varnames":["Active","Inactive","Closed"],"x-enum-descriptions":["Active","In the process of setting up or winding down, no new matters can be created in the division","Closed"],"x-enumDescriptions":{"0:Active":"Active","1:Inactive":"In the process of setting up or winding down, no new matters can be created in the division","2:Closed":"Closed"}},"PEDocumentCollectionState":{"enum":[0,1,2,3],"type":"integer","format":"int32","x-enum-varnames":["Active","Locked","Archived","Deleted"],"x-enum-descriptions":["","","",""],"x-enumDescriptions":{"0:Active":"","1:Locked":"","2:Archived":"","3:Deleted":""}},"PEDocumentData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. document_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"externalId":{"type":"string","description":"External identifier","nullable":true},"path":{"type":"string","description":"Path of the current document, e.g. Collection1/Folder1/.../Folder(n)/file.ext. If FolderId is null, folders will be automatically created from this path","nullable":true},"fileName":{"type":"string","description":"Filename of the document","nullable":true},"fileSizeInBytes":{"type":"integer","description":"Size of the document in bytes","format":"int64"},"state":{"allOf":[{"$ref":"#/components/schemas/PEDocumentState"}]},"latestVersionNumber":{"type":"integer","description":"Stores the latest version","format":"int32"},"checkedOutByUserId":{"type":"string","description":"User who checked out the file","nullable":true},"checkedOutDate":{"type":"string","description":"User who checked out the file","format":"date-time","nullable":true},"documentCollectionId":{"type":"string","description":"e.g. documentcollection_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"folderId":{"type":"string","description":"e.g. documentfolder_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"versionId":{"type":"string","description":"e.g. version_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"previewUri":{"type":"string","description":"Url for document preview","nullable":true},"downloadUri":{"type":"string","description":"Url to download document","nullable":true},"integrationEditUri":{"type":"string","description":"Url to download document","nullable":true},"metaData":{"type":"object","additionalProperties":{},"description":"Meta data of the document","nullable":true},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"}},"additionalProperties":false},"PEDocumentState":{"enum":[0,1,2,3,4],"type":"integer","format":"int32","x-enum-varnames":["Available","CheckedOut","Locked","Archived","Deleted"],"x-enum-descriptions":["Document is checked in","Document is checked out by a user","Document is locked by a user","Document is archived","Document is Deleted"],"x-enumDescriptions":{"0:Available":"Document is checked in","1:CheckedOut":"Document is checked out by a user","2:Locked":"Document is locked by a user","3:Archived":"Document is archived","4:Deleted":"Document is Deleted"}},"PEDownloadDocumentData":{"type":"object","properties":{"url":{"type":"string","description":"A short-lived URL that can be used to download the file","nullable":true,"readOnly":true},"fileName":{"type":"string","description":"The file name of this data","nullable":true,"readOnly":true}},"additionalProperties":false},"PEDownloadDocumentResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PEDownloadDocumentData"}],"nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEEmployeeHeader":{"type":"object","properties":{"id":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"userId":{"type":"string","nullable":true},"sortName":{"type":"string","nullable":true},"initials":{"type":"string","nullable":true},"entityId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"jobTitle":{"type":"string","nullable":true},"teamId":{"type":"string","description":"e.g. team_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"teamName":{"type":"string","nullable":true},"employeeNumber":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"middleNames":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"streetAddress":{"type":"string","nullable":true},"streetAddressSuburb":{"type":"string","nullable":true},"streetAddressState":{"type":"string","nullable":true},"streetAddressCountry":{"type":"string","nullable":true},"state":{"allOf":[{"$ref":"#/components/schemas/PEEmployeeState"}]},"tagCode":{"type":"integer","format":"int64"}},"additionalProperties":false,"description":"Client in search results"},"PEEmployeeRef":{"type":"object","properties":{"teamId":{"type":"string","description":"e.g. team_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"tagCode":{"type":"integer","format":"int64"},"teamName":{"type":"string","nullable":true},"teamL1":{"type":"string","nullable":true},"teamL2":{"type":"string","nullable":true},"teamTagCode":{"type":"integer","format":"int64"},"sortName":{"type":"string","nullable":true},"initials":{"type":"string","nullable":true},"jobTitle":{"type":"string","nullable":true},"billingGrade":{"type":"string","nullable":true}},"additionalProperties":false},"PEEmployeeState":{"enum":[0,1,2],"type":"integer","format":"int32","x-enum-varnames":["Active","Closed","Draft"],"x-enum-descriptions":["Active employee","No longer working for the firm, or on extended leave","In the process of being setup"],"x-enumDescriptions":{"0:Active":"Active employee","1:Closed":"No longer working for the firm, or on extended leave","2:Draft":"In the process of being setup"}},"PEEnableWebhookResult":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEEntityHeader":{"type":"object","properties":{"id":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"clientId":{"type":"string","description":"e.g. client_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"employeeId":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"supplierId":{"type":"string","description":"e.g. supplier_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"entityType":{"allOf":[{"$ref":"#/components/schemas/PEEntityType"}]},"sortName":{"type":"string","nullable":true},"address":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"defaultNumber":{"type":"string","nullable":true},"organisationNumber":{"type":"string","nullable":true},"userId":{"type":"string","nullable":true},"displayAddress":{"type":"string","nullable":true},"currency":{"type":"string","nullable":true},"supplierState":{"allOf":[{"$ref":"#/components/schemas/PESupplierState"}],"nullable":true},"clientState":{"allOf":[{"$ref":"#/components/schemas/PEClientState"}],"nullable":true},"employeeState":{"allOf":[{"$ref":"#/components/schemas/PEEmployeeState"}],"nullable":true},"state":{"allOf":[{"$ref":"#/components/schemas/PEEntityState"}]},"involvementCount":{"type":"integer","format":"int32"},"hasPinnedComment":{"type":"boolean"},"isDeleted":{"type":"boolean"},"isVerified":{"type":"boolean"},"clientNumber":{"type":"string","nullable":true},"employeeNumber":{"type":"string","nullable":true},"supplierNumber":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"}},"additionalProperties":false,"description":"Entity in search results"},"PEEntityState":{"enum":[0,1,2,3],"type":"integer","format":"int32","x-enum-varnames":["Draft","Active","Deleting","Deleted"],"x-enum-descriptions":["In the process of being created, some operations are restricted","Supports all operations","In the process of being deleted. Cannot be deleted until any dependent client/supplier/employee have been deleted.","In the process of being deleted. Cannot be deleted until any dependent client/supplier/employee have been archived."],"x-enumDescriptions":{"0:Draft":"In the process of being created, some operations are restricted","1:Active":"Supports all operations","2:Deleting":"In the process of being deleted. Cannot be deleted until any dependent client/supplier/employee have been deleted.","3:Deleted":"In the process of being deleted. Cannot be deleted until any dependent client/supplier/employee have been archived."}},"PEEntityType":{"enum":[0,1,2,3],"type":"integer","format":"int32","x-enum-varnames":["Individual","Organisation","Group","Unspecified"],"x-enum-descriptions":["","","",""],"x-enumDescriptions":{"0:Individual":"","1:Organisation":"","2:Group":"","3:Unspecified":""}},"PEFileNoteData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. filenote_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"memo":{"type":"string","description":"User recorded memo for the file note","nullable":true},"matterId":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"invoiceId":{"type":"string","description":"e.g. invoice_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"entityId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"pinned":{"type":"boolean","description":"If this note has been pinned. Only one note can be pinned for a matter/invoice"},"workItemId":{"type":"string","description":"e.g. workitem_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"}},"additionalProperties":false},"PEFinaliseWorkItemResult":{"type":"object","properties":{"data":{"type":"string","description":"e.g. workitem_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEFindApplicableRatesResult":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PEApplicableRate"},"nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEFindClientsResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PagedListOfPEClientHeader"}],"description":"Paged list of something","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEFindEmployeesResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PagedListOfPEEmployeeHeader"}],"description":"Paged list of something","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEFindEntityRelationsResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PagedListOfPERelationData"}],"description":"Paged list of something","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEFindLedgersResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PagedListOfPELedgerData"}],"description":"Paged list of something","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEFindRateSetsResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PagedListOfPERateSet"}],"description":"Paged list of something","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEFindWebhooksResult":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PEWebhookData"},"nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEFundsClearanceMethod":{"enum":[0,1,2],"type":"integer","format":"int32","x-enum-varnames":["AfterSpecifiedDays","MarkedForReconciliation","AfterReconciliation"],"x-enum-descriptions":["Funds will be deemed as cleared after specified clearance days been banked.","Funds will be deemed as cleared after the relevant cashbook entry is Marked for Reconciliation.","Funds will be deemed as cleared after the relevant cashbook entry is included in a bank reconciliation."],"x-enumDescriptions":{"0:AfterSpecifiedDays":"Funds will be deemed as cleared after specified clearance days been banked.","1:MarkedForReconciliation":"Funds will be deemed as cleared after the relevant cashbook entry is Marked for Reconciliation.","2:AfterReconciliation":"Funds will be deemed as cleared after the relevant cashbook entry is included in a bank reconciliation."}},"PEGeneralDetail":{"type":"object","properties":{"name":{"type":"string","description":"Name given to the payment method","nullable":true},"details":{"type":"string","nullable":true}},"additionalProperties":false},"PEGetDocumentResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PEDocumentData"}],"nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEGetEntityRelationResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PERelationData"}],"nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEGetMatterSummaryResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PEMatterSummaryData"}],"nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEGetWebhookResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PEWebhookData"}],"nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEIncurredType":{"enum":[0,1,2],"type":"integer","description":"Type of the Incurred Disbursement Code, not applicable to other types.","format":"int32","x-enum-varnames":["Purchase","Payment","GeneralLedger"],"x-enum-descriptions":["Received an invoice from the supplier","Will be paid out of the bank immediately when created","Will be paid out of the GL Account"],"x-enumDescriptions":{"0:Purchase":"Received an invoice from the supplier","1:Payment":"Will be paid out of the bank immediately when created","2:GeneralLedger":"Will be paid out of the GL Account"}},"PEInvoiceAllocation":{"type":"object","properties":{"id":{"type":"string","description":"e.g. invoiceallocation_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"date":{"type":"string","format":"date-time"},"periodDate":{"type":"string","format":"date-time"},"transactionId":{"type":"string","description":"e.g. transaction_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"type":{"allOf":[{"$ref":"#/components/schemas/PEInvoiceAllocationType"}]},"itemType":{"allOf":[{"$ref":"#/components/schemas/PEInvoiceItemType"}]},"accountId":{"type":"string","description":"e.g. account_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"billerId":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"disbursementId":{"type":"string","description":"e.g. disbursement_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"amount":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"The amount allocated, exclusive of tax. Original invoice exchange rate"},"tax":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"The tax allocated"},"taxCode":{"type":"string","description":"Need to populate this for cash-basis accounting","nullable":true}},"additionalProperties":false},"PEInvoiceAllocationType":{"enum":[0,1,2,3],"type":"integer","format":"int32","x-enum-varnames":["Collection","WriteOff","ClientPayment","CreditNote"],"x-enum-descriptions":["Regular receipt","Write-off, loss caused by client","When client makes a direct payment to third party, reducing invoice balance","Loss caused by the firm"],"x-enumDescriptions":{"0:Collection":"Regular receipt","1:WriteOff":"Write-off, loss caused by client","2:ClientPayment":"When client makes a direct payment to third party, reducing invoice balance","3:CreditNote":"Loss caused by the firm"}},"PEInvoiceItemType":{"enum":[0,1,2,3,4,5,6],"type":"integer","format":"int32","x-enum-varnames":["GroupHeader","Fees","CostRecovery","Disbursement","AnticipatedDisbursement","Account","Discount"],"x-enum-descriptions":["Group header that includes other child items","Post to fees. If negative, it's a discount","Post to cost recovery","Post to disbursement","Post to anticipated disbursement","Post to the specified account","Discount applied to the invoice"],"x-enumDescriptions":{"0:GroupHeader":"Group header that includes other child items","1:Fees":"Post to fees. If negative, it's a discount","2:CostRecovery":"Post to cost recovery","3:Disbursement":"Post to disbursement","4:AnticipatedDisbursement":"Post to anticipated disbursement","5:Account":"Post to the specified account","6:Discount":"Discount applied to the invoice"}},"PEInvoicePostReceipt":{"type":"object","properties":{"accountId":{"type":"string","description":"e.g. account_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"transactionId":{"type":"string","description":"e.g. transaction_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"date":{"type":"string","format":"date-time"},"amountExTax":{"type":"number","format":"double"},"tax":{"type":"number","format":"double"},"paymentMethodDetail":{"allOf":[{"$ref":"#/components/schemas/PEReceiptPaymentMethodDetail"}],"nullable":true},"reason":{"type":"string","nullable":true}},"additionalProperties":false},"PEInvoiceState":{"enum":[0,1,2,3,4,5,6],"type":"integer","format":"int32","x-enum-varnames":["Draft","Pending","Approved","Issued","Closed","Cancelled","CreditNote"],"x-enum-descriptions":["Invoice has been created, but not yet submitted for approval","Invoice is in the approval process","Invoice has been approved, or does not require approval, pending issue","Invoice has been issued, and has been posted to accounts","No longer outstanding, either paid and/or written off","Cancelled and inactive, nothing can be done to it, kept for historical records","Credit note invoice, nothing can be done to it"],"x-enumDescriptions":{"0:Draft":"Invoice has been created, but not yet submitted for approval","1:Pending":"Invoice is in the approval process","2:Approved":"Invoice has been approved, or does not require approval, pending issue","3:Issued":"Invoice has been issued, and has been posted to accounts","4:Closed":"No longer outstanding, either paid and/or written off","5:Cancelled":"Cancelled and inactive, nothing can be done to it, kept for historical records","6:CreditNote":"Credit note invoice, nothing can be done to it"}},"PEInvoiceType":{"enum":[0,1,2],"type":"integer","format":"int32","x-enum-varnames":["Standard","SplitParent","Split"],"x-enum-descriptions":["Regular standard invoice","An invoice that has been split","An invoice split that's part of the full invoice"],"x-enumDescriptions":{"0:Standard":"Regular standard invoice","1:SplitParent":"An invoice that has been split","2:Split":"An invoice split that's part of the full invoice"}},"PEJournalEntryData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. journalentry_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"accountId":{"type":"string","description":"e.g. account_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"accountName":{"type":"string","nullable":true},"accountCode":{"type":"string","nullable":true},"accountType":{"allOf":[{"$ref":"#/components/schemas/PEAccountType"}],"description":"Bank or Standard. Allows banking projector to decide if it is a cashbook entry or not."},"transactionId":{"type":"string","description":"e.g. transaction_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"timingBasis":{"allOf":[{"$ref":"#/components/schemas/PETimingBasis"}],"description":"Specifies if this transaction is a accrual, cash, or applicable to both timing basis"},"isDebit":{"type":"boolean"},"memo":{"type":"string","nullable":true},"amount":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Amount in both base and foreign currency"},"isHistorical":{"type":"boolean","description":"If this was imported as part of a migration, then it is considered historical, and some actions may not be able to be performed"},"isOpeningBalance":{"type":"boolean","description":"Indicate if this is an opening balance transaction posted after migration."},"historicalAmount":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Imported journal entry amount, does not part impact account balance"},"runningBalance_B":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"Running balance based Date and includes all transactions. Calculated near-realtime.","nullable":true},"runningBalance_F":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"nullable":true},"taxCode":{"type":"string","nullable":true},"tax":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Tax in both base and foreign currency"},"taxType":{"allOf":[{"$ref":"#/components/schemas/PETaxAppliesTo"}],"description":"Denotes if the tax in this transaction applies to Sales or Purchase"},"tags":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/PETag"},"description":"Tags applicable to the journal entry, e.g. cost centre","nullable":true},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"},"ledgerEntries":{"type":"array","items":{"$ref":"#/components/schemas/PELedgerEntryData"},"description":"Gets associated ledger entries. Note this is omitted when returning transaction list.","nullable":true},"relatedMatters":{"type":"array","items":{"$ref":"#/components/schemas/MatterId"},"nullable":true},"transaction":{"allOf":[{"$ref":"#/components/schemas/PETransactionData"}],"nullable":true},"runningBalance":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"nullable":true,"readOnly":true}},"additionalProperties":false},"PEJournalType":{"enum":[0,1,2],"type":"integer","format":"int32","x-enum-varnames":["Office","Trust","Other"],"x-enum-descriptions":["Office Journal Type","Trust Journal Type","Other Journal Type"],"x-enumDescriptions":{"0:Office":"Office Journal Type","1:Trust":"Trust Journal Type","2:Other":"Other Journal Type"}},"PELedgerData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. ledger_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"name":{"type":"string","nullable":true},"type":{"allOf":[{"$ref":"#/components/schemas/PELedgerType"}]},"matterId":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"cashAccountId":{"type":"string","description":"e.g. account_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"supplierId":{"type":"string","description":"e.g. supplier_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"journalId":{"type":"string","description":"e.g. journal_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"balance":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Balance of the ledger, debit positive."},"interestLastPostedOn":{"type":"string","description":"Date on which client interest was posted for this matter. Used by client interest calculator.","format":"date-time","nullable":true},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"},"trustAccountName":{"type":"string","nullable":true}},"additionalProperties":false},"PELedgerEntryData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. ledgerentry_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"date":{"type":"string","format":"date-time"},"periodDate":{"type":"string","format":"date-time"},"ledgerId":{"type":"string","description":"e.g. ledger_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"journalEntryId":{"type":"string","description":"e.g. journalentry_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"transactionId":{"type":"string","description":"e.g. transaction_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"isDebit":{"type":"boolean"},"memo":{"type":"string","nullable":true},"amount":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"For invoices, amount inclusive of tax; for disbursements, exclusive of tax"},"isHistorical":{"type":"boolean","description":"If this was imported as part of a migration, then it is considered historical, and some actions may not be able to be performed"},"historicalAmount":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"For imported history, does not part take in current balance calculation. For invoices, amount inclusive of tax; for disbursements, exclusive of tax."},"runningBalance":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Running balance based Date and includes all transactions. Calculated near-realtime.","nullable":true},"tax":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Applies mostly to disbursements, where it is important to show the tax component"},"type":{"allOf":[{"$ref":"#/components/schemas/PELedgerEntryType"}]},"invoiceId":{"type":"string","description":"e.g. invoice_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"documentReference":{"type":"string","description":"The invoice number from the supplier on the purchase or the disbursement supplier reference","nullable":true},"purchaseId":{"type":"string","description":"e.g. purchase_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"supplierId":{"type":"string","description":"e.g. supplier_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"isReversed":{"type":"boolean","description":"Indicates if this is a reversed or a reversal entry"},"matterId":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"disbursementId":{"type":"string","description":"e.g. disbursement_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"paymentMethodDetail":{"type":"string","description":"Description of the payment method used for reporting","nullable":true},"cashAccountId":{"type":"string","description":"e.g. account_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"cashAccountName":{"type":"string","description":"If this ledger entry relates to a bank account, the account name","nullable":true},"otherPartyId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"otherPartySortName":{"type":"string","description":"Other Party name","nullable":true},"originalDate":{"type":"string","description":"See TransactionData.OriginalDate","format":"date-time"},"reconciliationDate":{"type":"string","description":"When is this request made","format":"date-time","nullable":true},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"},"commandType":{"type":"string","description":"Command type of the relevant transaction, i.e. PostPayment etc.","nullable":true},"reference":{"type":"string","description":"Journal reference on the transaction","nullable":true},"journalType":{"allOf":[{"$ref":"#/components/schemas/PEJournalType"}],"description":"Type of journal the transaction is in"},"ledgerType":{"allOf":[{"$ref":"#/components/schemas/PELedgerType"}],"description":"Type of ledger the transaction is (Office or Trust)"}},"additionalProperties":false},"PELedgerEntryType":{"enum":[0,1,2,3,4,5],"type":"integer","format":"int32","x-enum-varnames":["Invoicing","CreditFunds","Disbursement","CreditNote","General","Historical"],"x-enum-descriptions":["Debtor or creditor related","Cash credits, such as receipts from clients, or supplier pre-payments","Disbursements","Credit Note","Other unclassified entries","Migrated historical ledger entries"],"x-enumDescriptions":{"0:Invoicing":"Debtor or creditor related","1:CreditFunds":"Cash credits, such as receipts from clients, or supplier pre-payments","2:Disbursement":"Disbursements","3:CreditNote":"Credit Note","4:General":"Other unclassified entries","5:Historical":"Migrated historical ledger entries"}},"PELedgerType":{"enum":[0,1,2,3],"type":"integer","format":"int32","x-enum-varnames":["Office","Trust","Supplier","Other"],"x-enum-descriptions":["","","",""],"x-enumDescriptions":{"0:Office":"","1:Trust":"","2:Supplier":"","3:Other":""}},"PEMatterState":{"enum":[0,1,2,3,4,5],"type":"integer","format":"int32","x-enum-varnames":["Draft","Active","OnHold","Closing","Closed","Archived"],"x-enum-descriptions":["In the process of being opened, some operations may not be allowed yet","Currently running matter","No work to be done on it","In the process of closing, only tasks moving towards closing is allowed","Matter is inactive, accounts closed","Matter has moved to storage"],"x-enumDescriptions":{"0:Draft":"In the process of being opened, some operations may not be allowed yet","1:Active":"Currently running matter","2:OnHold":"No work to be done on it","3:Closing":"In the process of closing, only tasks moving towards closing is allowed","4:Closed":"Matter is inactive, accounts closed","5:Archived":"Matter has moved to storage"}},"PEMatterSummaryData":{"type":"object","properties":{"matterTitle":{"type":"string","nullable":true},"clientSortName":{"type":"string","nullable":true},"matterNumber":{"type":"string","nullable":true},"rateSetName":{"type":"string","nullable":true},"nextInvoiceFixedFeeAmount":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"Fix the fees in next invoice to a specified amount. This will limit the fees in next invoice amount regardless how much work is done.","nullable":true},"pinnedFileNote":{"allOf":[{"$ref":"#/components/schemas/PEFileNoteData"}],"nullable":true},"feeThreshold":{"type":"number","description":"Fee threshold set at a firm level, but applies to this matter.","format":"double","nullable":true},"disbursementThreshold":{"type":"number","description":"Disbursement threshold set at a firm level, but applies to this matter.","format":"double","nullable":true},"id":{"type":"string","description":"e.g. mattersummary_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"state":{"allOf":[{"$ref":"#/components/schemas/PEMatterState"}]},"divisionId":{"type":"string","description":"e.g. division_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"clientId":{"type":"string","description":"e.g. client_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"matterId":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"aclId":{"type":"string","nullable":true},"currency":{"type":"string","description":"Client or matter currency","nullable":true},"workItem":{"allOf":[{"$ref":"#/components/schemas/PEWorkItemStats"}],"description":"Statistics on WorkItem, including chargeable, billable, write-off and billed, in firm currency, relates to WorkItemF using matter forex rate at the time of creation.","nullable":true},"workItemF":{"allOf":[{"$ref":"#/components/schemas/PEWorkItemStats"}],"description":"Statistics on WorkItem, including chargeable, billable, write-off and billed, in matter currency, relates to WorkItem using matter forex rate at the time of creation.","nullable":true},"fees":{"allOf":[{"$ref":"#/components/schemas/PEBillingCycleStats"}],"description":"Fee stats in firm currency, Billable denotes amount of work items awaiting billing, which excludes written-off work items. Billed refers the amount of work item as it appeared on finalised invoices, inclusive of discount line items and write-downs. Collected denotes amount of work item received from clients by paying off invoices. Discount refers to credit notes applied against the fee components of invoices. WrittenOff denotes the fee component of invoices written off. Total fees incurred on this matter is given by: Billable + Billed - Discounted - WrittenOff.","nullable":true},"feesF":{"allOf":[{"$ref":"#/components/schemas/PEBillingCycleStats"}],"description":"Fee stats in client currency, with the same semantics as the Fees property.","nullable":true},"disbursement":{"allOf":[{"$ref":"#/components/schemas/PEBillingCycleStats"}],"description":"Disbursement stats in firm currency, inclusive of cost recovery, incurred and anticipated disbursements. Billable denotes amount remaining to be paid by the client. Billed denotes amount invoiced to clients, plus amount they paid the firm without first invoicing it. Collected denotes amount collected as part of debtor collection, plus amount they paid the firm without an invoice. Discounted denotes disbursement amount with a credit note applied that are part of an invoice or directly.  WriteOff denotes disbursement amount written off that was part of an invoice or directly. Note that third party direct payment of disbursements can only be made to billed disbursements. Total disbursement incurred on the matter is given by: Billable + Billed - Discounted - WrittenOff.","nullable":true},"disbursementTax":{"allOf":[{"$ref":"#/components/schemas/PEBillingCycleStats"}],"description":"Total value of all disbursement billable tax amounts in base, including ones on drafted invoices","nullable":true},"disbursementF":{"allOf":[{"$ref":"#/components/schemas/PEBillingCycleStats"}],"description":"Disbursement stats in client currency, with the same semantics as the Fees property. Including ones on drafted invoices","nullable":true},"disbursementFTax":{"allOf":[{"$ref":"#/components/schemas/PEBillingCycleStats"}],"description":"Total value of all disbursement billable tax in foreign, including ones on drafted invoices","nullable":true},"anticipatedDisbursement":{"allOf":[{"$ref":"#/components/schemas/PEBillingCycleStats"}],"description":"Anticipated disbursement stats in firm currency","nullable":true},"anticipatedDisbursementTax":{"allOf":[{"$ref":"#/components/schemas/PEBillingCycleStats"}],"description":"Total value of all anticipated disbursement billable tax amounts in base, including ones on drafted invoices","nullable":true},"anticipatedDisbursementF":{"allOf":[{"$ref":"#/components/schemas/PEBillingCycleStats"}],"description":"Anticipated disbursement stats in client currency, with the same semantics as the Fees property. Including ones on drafted invoices","nullable":true},"anticipatedDisbursementFTax":{"allOf":[{"$ref":"#/components/schemas/PEBillingCycleStats"}],"description":"Total value of all anticipated disbursement billable tax in foreign, including ones on drafted invoices","nullable":true},"incurredDisbursement":{"allOf":[{"$ref":"#/components/schemas/PEBillingCycleStats"}],"description":"Incurred disbursement stats in firm currency","nullable":true},"incurredDisbursementTax":{"allOf":[{"$ref":"#/components/schemas/PEBillingCycleStats"}],"description":"Total value of all incurred disbursement billable tax amounts in base, including ones on drafted invoices","nullable":true},"incurredDisbursementF":{"allOf":[{"$ref":"#/components/schemas/PEBillingCycleStats"}],"description":"Incurred disbursement stats in client currency, with the same semantics as the Fees property. Including ones on drafted invoices","nullable":true},"incurredDisbursementFTax":{"allOf":[{"$ref":"#/components/schemas/PEBillingCycleStats"}],"description":"Total value of all incurred disbursement billable tax in foreign, including ones on drafted invoices","nullable":true},"costRecovery":{"allOf":[{"$ref":"#/components/schemas/PEBillingCycleStats"}],"description":"Cost recovery stats in firm currency","nullable":true},"costRecoveryTax":{"allOf":[{"$ref":"#/components/schemas/PEBillingCycleStats"}],"description":"Total value of all cost recovery billable tax amounts in base, including ones on drafted invoices","nullable":true},"costRecoveryF":{"allOf":[{"$ref":"#/components/schemas/PEBillingCycleStats"}],"description":"Cost recovery stats in client currency, with the same semantics as the Fees property. Including ones on drafted invoices","nullable":true},"costRecoveryFTax":{"allOf":[{"$ref":"#/components/schemas/PEBillingCycleStats"}],"description":"Total value of all cost recovery billable tax in foreign, including ones on drafted invoices","nullable":true},"feesDrafted":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Total fees on a draft or pending invoice"},"disbursementsDrafted":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Total disbursements on a draft or pending invoice"},"disbursementsDraftedTax":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Total disbursements tax on a draft or pending invoice"},"anticipatedDisbursementsDrafted":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Total anticipated disbursements on a draft or pending invoice"},"anticipatedDisbursementsDraftedTax":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Total anticipated disbursements tax on a draft or pending invoice"},"incurredDisbursementsDrafted":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Total incurred disbursements on a draft or pending invoice"},"incurredDisbursementsDraftedTax":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Total incurred disbursements tax on a draft or pending invoice"},"costRecoveriesDrafted":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Total cost recoveries on a draft or pending invoice"},"costRecoveriesDraftedTax":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Total cost recoveries tax on a draft or pending invoice"},"invoiceTotalAmount":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Total value of all non-cancelled invoice, exclusive of tax"},"invoiceTotalTax":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Total value of all non-cancelled invoice"},"invoiceTotalBalance":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Total balance of all finalised invoices"},"trustBalance":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"Trust balance that are in the matter's currency. Positive means client has money on account. A matter may have trust money in other currencies."},"officeBalance":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"Office balance that are in the matter's currency."},"allottedTrustFunds":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"Total trust funds across all trust accounts that have been retained or protected for a purpose"},"clearedTrustFunds":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"Total trust funds across all trust accounts that cleared in the bank"},"cmaBalance":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"CMA balance that are in the matter's currency. Positive means client has money on account. A matter may have CMA money in other currencies."},"billedButUnpaidAnticipatedDisbursements":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"The total balance of anticipated disbursements that have been billed but not paid. This should match with the billed anticipated disbursement on the Matter Balances report"},"unbilledButPaidDisbursements":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"The total balance of disbursements that have not been billed but have been paid. This should match with the unbilled incurred disbursement on the Matter Balances report"},"lastOfficeReceiptOn":{"type":"string","description":"When the last office receipt happened","format":"date-time","nullable":true},"lastTrustLedgerActivity":{"type":"string","description":"When the last trust ledger activity happened.","format":"date-time","nullable":true},"lastWorkedOn":{"type":"string","description":"This matter was last worked on in terms of work items created/updated","format":"date-time","nullable":true},"dateOpened":{"type":"string","description":"Official instruction date","format":"date-time","nullable":true},"dateClosed":{"type":"string","description":"Official closed or completion date","format":"date-time","nullable":true},"feeEstimate":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"Fee estimate on the matter","nullable":true},"disbursementEstimate":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"Disbursement estimate on the matter","nullable":true},"divisionName":{"type":"string","description":"Name of the division for the matter","nullable":true},"matterType":{"type":"string","description":"Name of the type of the matter","nullable":true},"billingBasis":{"allOf":[{"$ref":"#/components/schemas/PEBillingBasis"}],"description":"Billing basis of the matter","nullable":true},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"},"availableTrustBalances":{"type":"array","items":{"$ref":"#/components/schemas/PEAvailableTrustBalance"},"nullable":true}},"additionalProperties":false},"PEMatterTypeState":{"enum":[0,1],"type":"integer","format":"int32","x-enum-varnames":["Enabled","Disabled"],"x-enum-descriptions":["",""],"x-enumDescriptions":{"0:Enabled":"","1:Disabled":""}},"PENumber":{"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/PENumberType"}]},"value":{"type":"string","nullable":true},"default":{"type":"boolean"},"note":{"type":"string","nullable":true}},"additionalProperties":false},"PENumberType":{"enum":[0,1,2,3,4],"type":"integer","format":"int32","x-enum-varnames":["Home","Mobile","Work","Fax","Other"],"x-enum-descriptions":["","","","",""],"x-enumDescriptions":{"0:Home":"","1:Mobile":"","2:Work":"","3:Fax":"","4:Other":""}},"PEPaymentMethodType":{"enum":[0,1,2,3,4],"type":"integer","format":"int32","x-enum-varnames":["General","Cheque","EFT","CreditCard","Cash"],"x-enum-descriptions":["","","","",""],"x-enumDescriptions":{"0:General":"","1:Cheque":"","2:EFT":"","3:CreditCard":"","4:Cash":""}},"PEPaymentPaymentMethodDetail":{"type":"object","properties":{"paymentMethodId":{"type":"string","description":"e.g. paymentmethod_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"general":{"allOf":[{"$ref":"#/components/schemas/PEGeneralDetail"}],"nullable":true},"cash":{"allOf":[{"$ref":"#/components/schemas/PECashDetail"}],"nullable":true},"eft":{"allOf":[{"$ref":"#/components/schemas/PEPaymentPaymentMethodDetailPaymentEFTDetail"}],"nullable":true},"cheque":{"allOf":[{"$ref":"#/components/schemas/PEPaymentPaymentMethodDetailPaymentChequeDetail"}],"nullable":true},"creditCard":{"allOf":[{"$ref":"#/components/schemas/PEPaymentPaymentMethodDetailPaymentCreditCardDetail"}],"nullable":true},"type":{"allOf":[{"$ref":"#/components/schemas/PEPaymentMethodType"}],"readOnly":true}},"additionalProperties":false},"PEPaymentPaymentMethodDetailPaymentChequeDetail":{"type":"object","properties":{"name":{"type":"string","description":"Name given to the payment method","nullable":true},"paidTo":{"type":"string","nullable":true},"number":{"type":"string","nullable":true},"issueDate":{"type":"string","format":"date-time","nullable":true},"branch":{"type":"string","nullable":true},"institution":{"type":"string","nullable":true}},"additionalProperties":false},"PEPaymentPaymentMethodDetailPaymentCreditCardDetail":{"type":"object","properties":{"cardHolder":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"name":{"type":"string","nullable":true}},"additionalProperties":false},"PEPaymentPaymentMethodDetailPaymentEFTDetail":{"type":"object","properties":{"name":{"type":"string","description":"Name given to the payment method","nullable":true},"bankAccount":{"allOf":[{"$ref":"#/components/schemas/PEBankAccountDetails"}],"description":"Recipient bank account"},"reference":{"type":"string","description":"The reference that appears on the other side's bank statement","nullable":true},"sequenceNumber":{"type":"string","description":"System-generated sequential number","nullable":true},"bankReference":{"type":"string","description":"Bank-issued transaction reference number","nullable":true},"includeInABA":{"type":"boolean","description":"Whether this payment entry should be included in ABA export."}},"additionalProperties":false},"PEPostReceiptResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PEReceiptData"}],"nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEPurchaseAllocationData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. purchaseallocation_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"purchaseId":{"type":"string","description":"e.g. purchase_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"date":{"type":"string","description":"Date the payment/debit was allocated or write off was dated","format":"date-time"},"periodDate":{"type":"string","description":"Accounting period date","format":"date-time"},"eventId":{"type":"string","description":"The committed event id that caused this allocation, e.g. PaymentPosted, PurchaseCredited","format":"uuid"},"transactionId":{"type":"string","description":"e.g. transaction_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"disbursementId":{"type":"string","description":"e.g. disbursement_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"type":{"allOf":[{"$ref":"#/components/schemas/PEPurchaseAllocationType"}]},"itemId":{"type":"string","description":"e.g. purchaseitem_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"itemType":{"allOf":[{"$ref":"#/components/schemas/PEPurchaseItemType"}]},"amount":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"The amount allocated, exclusive of tax. Storing base currency value allows for management reporting."},"tax":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"The tax allocated"},"taxCode":{"type":"string","description":"Need to populate this for cash-basis accounting","nullable":true},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"}},"additionalProperties":false},"PEPurchaseAllocationType":{"enum":[0,1,2],"type":"integer","format":"int32","x-enum-varnames":["Payment","CreditNote","ThirdParty"],"x-enum-descriptions":["Cash or prepayment allocation","Applying discounts given by supplier",""],"x-enumDescriptions":{"0:Payment":"Cash or prepayment allocation","1:CreditNote":"Applying discounts given by supplier","2:ThirdParty":""}},"PEPurchaseAttachmentData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. document_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"transactionId":{"type":"string","description":"e.g. transaction_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"}},"additionalProperties":false},"PEPurchaseData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. purchase_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"journalId":{"type":"string","description":"e.g. journal_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"transactionId":{"type":"string","description":"e.g. transaction_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"purchaseNumber":{"type":"string","description":"The identifying number issued by the firm, to allow supplier to refer to this purchase (this is auto-generated from the PurchaseSequenceId in the Journal)","nullable":true},"invoiceNumber":{"type":"string","description":"Supplier's invoice number for this purchase, to allow the firm to refer to this purchase when communicating with the supplier.","nullable":true},"paymentReference":{"type":"string","description":"Supplier issued payment reference number to include in a payment (e.g. EFT), so the recipient can identify it in their system.","nullable":true},"date":{"type":"string","description":"Date to use for posting to Journals and Ledgers","format":"date-time","nullable":true},"dueDate":{"type":"string","description":"Date the the purchase is due","format":"date-time","nullable":true},"originalDate":{"type":"string","description":"As shown on supplier invoice","format":"date-time","nullable":true},"orderDate":{"type":"string","description":"Date the purchase order was created","format":"date-time","nullable":true},"supplierId":{"type":"string","description":"e.g. supplier_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"supplierComments":{"type":"string","description":"Comments sent to the supplier when the purchase is approved to help them fulfill this order.","nullable":true},"supplierNumber":{"type":"string","nullable":true},"supplierSortName":{"type":"string","nullable":true},"state":{"allOf":[{"$ref":"#/components/schemas/PEPurchaseState"}]},"issuedEventId":{"type":"string","format":"uuid","nullable":true},"totalAmount":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"The total amount (ex tax), in supplier and base currency"},"totalTax":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"The total tax in supplier and base currency"},"recogniseTaxOnPayment":{"type":"boolean","description":"Specifies that when payment is made to this purchase, also transfer tax components from AccountRole.TaxSuspense to AccountRole.TaxPaid"},"balance":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"How much left to pay the supplier (inclusive of tax)"},"description":{"type":"string","description":"Additional details about the supplier invoice. This will be added to the transaction description when posted","nullable":true},"hasPurchaseRequest":{"type":"boolean","description":"If the purchase originated from a purchase request (Note, the purchase request id is the same as the purchase id)"},"requestedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"isHeld":{"type":"boolean","description":"If the purchase is being held for payments"},"approvedOn":{"type":"string","description":"When was this request was approved","format":"date-time","nullable":true},"approvalId":{"type":"string","description":"e.g. approval_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"isHistorical":{"type":"boolean","description":"If this was imported as part of a migration, then it is considered historical, and some actions may not be able to be performed"},"isTaxInclusive":{"type":"boolean","description":"Used to toggle the view for purchase items showing amount as tax inclusive or not"},"createdFromScan":{"type":"boolean","description":"Whether this purchase was created from a scan"},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/PEPurchaseItemData"},"description":"Line items of the purchase","nullable":true},"allocations":{"type":"array","items":{"$ref":"#/components/schemas/PEPurchaseAllocationData"},"description":"How payments to this purchase is allocated to its line items","nullable":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/PEPurchaseAttachmentData"},"description":"Document attachments to give evidence to this purchase","nullable":true},"proposedPaymentMethod":{"allOf":[{"$ref":"#/components/schemas/PEPaymentPaymentMethodDetail"}],"description":"Supplier's payment preference (computed if requested)","nullable":true},"canApplySupplierCredit":{"type":"boolean","description":"Whether the supplier has credits to apply to this purchase (computed)"}},"additionalProperties":false},"PEPurchaseItemData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. purchaseitem_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"purchaseId":{"type":"string","description":"e.g. purchase_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"type":{"allOf":[{"$ref":"#/components/schemas/PEPurchaseItemType"}],"description":"What type of line item this is, e.g. disbursement, account, purchase, matter credits, matter funds"},"disbursementId":{"type":"string","description":"e.g. disbursement_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"disbursementCodeId":{"type":"string","description":"e.g. disbursementcode_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"matterId":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"accountId":{"type":"string","description":"e.g. account_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"tags":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/PETag"},"description":"List of tags to apply on the journal posting (aka cost centres)","nullable":true},"reference":{"type":"string","description":"A user-friendly unique identifier for this line item","nullable":true},"sku":{"type":"string","description":"A number assigned by the supplier that uniquely identifies the item being ordered. Optional.","nullable":true},"title":{"type":"string","description":"One-liner describing what the line item is","nullable":true},"description":{"type":"string","description":"Lengthy description of what the line item is","nullable":true},"amount":{"type":"number","description":"Amount in supplier currency, exclusive of tax","format":"double"},"amountB":{"type":"number","description":"Amount in supplier currency, exclusive of tax","format":"double"},"tax":{"type":"number","description":"Tax in supplier currency","format":"double"},"taxB":{"type":"number","description":"Amount in supplier currency, exclusive of tax","format":"double"},"taxCode":{"type":"string","description":"The supply tax code applicable to this item","nullable":true},"billingTaxCode":{"type":"string","description":"If known at the time of posting. This can be overriden by client/matter specific rules, e.g. overseas clients may have a specific tax code upon creation of disbursement.","nullable":true},"billingAmount":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Amount exclusive of tax in client and base currency when it is billed. If not specified, it is calculated using client configuration.","nullable":true},"billingTax":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Tax in client and base currency when it is billed. If not specified, it is calculated using client configuration.","nullable":true},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"}},"additionalProperties":false},"PEPurchaseItemType":{"enum":[0,1,2],"type":"integer","format":"int32","x-enum-varnames":["Account","Disbursement","AnticipatedDisbursement"],"x-enum-descriptions":["If it is related to a general ledger account code only, and not a disbursement","If it is related to a disbursement; ensure MatterId is specified, This will result in a new Incurred Disbursement being created","If it is related to a anticipated disbursement; ensure DisbursementId is specified"],"x-enumDescriptions":{"0:Account":"If it is related to a general ledger account code only, and not a disbursement","1:Disbursement":"If it is related to a disbursement; ensure MatterId is specified, This will result in a new Incurred Disbursement being created","2:AnticipatedDisbursement":"If it is related to a anticipated disbursement; ensure DisbursementId is specified"}},"PEPurchaseState":{"enum":[0,1,2,3,4,5],"type":"integer","format":"int32","x-enum-varnames":["PurchaseOrder","Open","Closed","Cancelled","Requested","RequestCancelled"],"x-enum-descriptions":["Purchase order created","When the firm is liable to pay the supplier for this purchase","When the purchase has been fully paid or credited, no more liability to the supplier","When the item cancelled or payment is irrelevant","A purchase request has been created.","The purchase request has been cancelled."],"x-enumDescriptions":{"0:PurchaseOrder":"Purchase order created","1:Open":"When the firm is liable to pay the supplier for this purchase","2:Closed":"When the purchase has been fully paid or credited, no more liability to the supplier","3:Cancelled":"When the item cancelled or payment is irrelevant","4:Requested":"A purchase request has been created.","5:RequestCancelled":"The purchase request has been cancelled."}},"PERate":{"type":"object","properties":{"id":{"type":"string","description":"e.g. rate_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"name":{"type":"string","nullable":true},"matterTypeId":{"type":"string","description":"e.g. mattertype_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"taskTypeId":{"type":"string","description":"e.g. tasktype_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"jobTitleId":{"type":"string","description":"e.g. jobtitle_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"billingGradeId":{"type":"string","description":"e.g. billinggrade_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"employeeId":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"effectivePeriod":{"allOf":[{"$ref":"#/components/schemas/RangeOfDateTime"}],"nullable":true},"itemType":{"allOf":[{"$ref":"#/components/schemas/PEWorkItemType"}],"description":"Specifies if this rate is selected, what work item type (timed or itemised) should apply"},"value":{"type":"number","description":"Per unit rate for itemised, and hourly rate for timed, in the currency of the PE.Mk2.Accounting.V1.RateSet","format":"double"}},"additionalProperties":false},"PERateSet":{"type":"object","properties":{"id":{"type":"string","description":"e.g. rateset_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"private":{"type":"boolean","description":"Private rate sets are specific to a matter/employee/client, and not visible to searches"},"name":{"type":"string","description":"Name","nullable":true},"applicablePeriodMin":{"type":"string","description":"Specify the matter-opening period this rate set is applicable from","format":"date-time","nullable":true},"applicablePeriodMax":{"type":"string","description":"Specify the matter-opening period this rate set is applicable to","format":"date-time","nullable":true},"disabled":{"type":"boolean","description":"Available for use"},"isFirmDefault":{"type":"boolean","description":"A flag indicating this rate set is used as the firm default rate set, and used when no other rate sets are applicable./\nOne and only one rate set can be firm default"},"currency":{"type":"string","description":"Currency the rates are all going to be in","nullable":true},"rates":{"type":"array","items":{"$ref":"#/components/schemas/PERate"},"description":"Rates contained within this set","nullable":true}},"additionalProperties":false,"description":"Represents a set of rates"},"PEReceiptAllocationItemData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. receiptallocationitem_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"type":{"allOf":[{"$ref":"#/components/schemas/PEReceiptAllocationType"}]},"invoiceId":{"type":"string","description":"e.g. invoice_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"invoiceAllocations":{"type":"array","items":{"$ref":"#/components/schemas/PEInvoiceAllocation"},"description":"Allows specification of how the receipt is allocated to the different components of the invoice. If not specified, the system will use the default allocation order.","nullable":true},"supplierId":{"type":"string","description":"e.g. supplier_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"disbursementId":{"type":"string","description":"e.g. disbursement_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"matterId":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"journalId":{"type":"string","description":"e.g. journal_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"accountId":{"type":"string","description":"e.g. account_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"tags":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/PETag"},"description":"List of tags to apply on the journal posting (aka cost centres)","nullable":true},"description":{"type":"string","description":"Lengthy description of what the line item is","nullable":true},"applyAmount":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"The amount (ex tax) to allocate"},"tax":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"Tax in base currency, unrounded"},"taxCode":{"type":"string","description":"The tax code applicable to this item","nullable":true},"asAllotment":{"type":"boolean","description":"NOT IMPLEMENTED. For trust receipts only, create an allotment to reserve this amount","nullable":true},"allotmentDisbursementId":{"type":"string","description":"e.g. disbursement_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"allotmentInvoiceId":{"type":"string","description":"e.g. invoice_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"allotmentEntityId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"allotmentEntityName":{"type":"string","description":"Allotment Entity name when using free text","nullable":true},"allotmentMemo":{"type":"string","description":"Memo of attached allotment","nullable":true},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"}},"additionalProperties":false},"PEReceiptAllocationType":{"enum":[0,1,2,3,4,5,6],"type":"integer","format":"int32","x-enum-varnames":["Invoice","ExistingDisbursement","MatterCreditFunds","SupplierCreditFunds","Account","StatutoryDeposit","OtherRevenue"],"x-enum-descriptions":["Receipt against a specific debtor invoice","NOT IMPLEMENTED. Received funds to reimburse the firm for a disbursement owed by client (not commonly used, clients normally expect an invoice)","Received funds against specific matter","NOT IMPLEMENTED. Received funds from supplier, allocate it against the supplier ledger","Allocate the receipt against a specific GL code","Applicable only to some juristiction, transferring to trust account from statutory deposit account","Miscellaneous revenue item that is not part of regular business of providing legal services (e.g. leasing out a conference room to clients)"],"x-enumDescriptions":{"0:Invoice":"Receipt against a specific debtor invoice","1:ExistingDisbursement":"NOT IMPLEMENTED. Received funds to reimburse the firm for a disbursement owed by client (not commonly used, clients normally expect an invoice)","2:MatterCreditFunds":"Received funds against specific matter","3:SupplierCreditFunds":"NOT IMPLEMENTED. Received funds from supplier, allocate it against the supplier ledger","4:Account":"Allocate the receipt against a specific GL code","5:StatutoryDeposit":"Applicable only to some juristiction, transferring to trust account from statutory deposit account","6:OtherRevenue":"Miscellaneous revenue item that is not part of regular business of providing legal services (e.g. leasing out a conference room to clients)"}},"PEReceiptData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. transaction_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"reference":{"type":"string","description":"Reference for the receipt","nullable":true},"accountId":{"type":"string","description":"e.g. account_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"journalId":{"type":"string","description":"e.g. journal_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"fromEntityId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"from":{"type":"string","description":"Textual name of the person from whom the money came from","nullable":true},"address":{"type":"string","description":"The address of the person paying the money","nullable":true},"date":{"type":"string","format":"date-time"},"originalDate":{"type":"string","format":"date-time"},"amount":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Money type that supports foreign and base currency"},"reason":{"type":"string","description":"Short one-liner explaining why money was taken. Appears on transaction listing reports, such as the general ledger and cashbook report.","nullable":true},"memo":{"type":"string","description":"Further details on this receipt","nullable":true},"bankEntryId":{"type":"string","description":"e.g. bankentry_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"originalCommandType":{"type":"string","description":"The name of the command that caused this receipt. e.g. PostReceipt, or PostTrustOfficeTransfer. Used to atomically reverse accounting events that includes multiple transactions.","nullable":true},"originalAggregateId":{"type":"string","description":"The accounting event aggregate id. e.g. TransactionId, TrustOfficeTransferId. Used to atomically reverse accounting events that includes multiple transactions.","format":"uuid","nullable":true},"receiptPaymentMethodDetail":{"allOf":[{"$ref":"#/components/schemas/PEReceiptPaymentMethodDetail"}],"description":"Payment method details for RECEIPT","nullable":true},"paymentMethodDetail":{"type":"string","description":"Description of the payment method used for reporting","nullable":true},"requiresBanking":{"type":"boolean","description":"System will determine if this receipt requires banking"},"depositSlipId":{"type":"string","description":"e.g. depositslip_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"depositDate":{"type":"string","description":"If the receipt has been deposited, then this will record the deposit date","format":"date-time","nullable":true},"isTaxInclusive":{"type":"boolean","description":"Used to toggle the view for receipt items showing amount as tax inclusive or not"},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/PEReceiptAllocationItemData"},"nullable":true},"fundsClearanceMethod":{"allOf":[{"$ref":"#/components/schemas/PEFundsClearanceMethod"}]}},"additionalProperties":false},"PEReceiptPaymentMethodDetail":{"type":"object","properties":{"paymentMethodId":{"type":"string","description":"e.g. paymentmethod_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"general":{"allOf":[{"$ref":"#/components/schemas/PEGeneralDetail"}],"nullable":true},"cheque":{"allOf":[{"$ref":"#/components/schemas/PEReceiptPaymentMethodDetailReceiptChequeDetail"}],"nullable":true},"cash":{"allOf":[{"$ref":"#/components/schemas/PECashDetail"}],"nullable":true},"eft":{"allOf":[{"$ref":"#/components/schemas/PEReceiptPaymentMethodDetailReceiptEFTDetail"}],"nullable":true},"creditCard":{"allOf":[{"$ref":"#/components/schemas/PEReceiptPaymentMethodDetailReceiptCreditCardDetail"}],"nullable":true},"type":{"allOf":[{"$ref":"#/components/schemas/PEPaymentMethodType"}],"readOnly":true}},"additionalProperties":false},"PEReceiptPaymentMethodDetailReceiptChequeDetail":{"type":"object","properties":{"number":{"type":"string","nullable":true},"drawer":{"type":"string","nullable":true},"branch":{"type":"string","nullable":true},"institution":{"type":"string","nullable":true},"issuedOnDate":{"type":"string","format":"date-time","nullable":true},"clearsOnDate":{"type":"string","format":"date-time","nullable":true},"clearanceDays":{"type":"integer","format":"int32","nullable":true},"memo":{"type":"string","nullable":true}},"additionalProperties":false},"PEReceiptPaymentMethodDetailReceiptCreditCardDetail":{"type":"object","properties":{"type":{"type":"string","nullable":true},"cardHolderName":{"type":"string","nullable":true}},"additionalProperties":false},"PEReceiptPaymentMethodDetailReceiptEFTDetail":{"type":"object","properties":{"reference":{"type":"string","nullable":true},"clearsOnDate":{"type":"string","format":"date-time","nullable":true},"clearanceDays":{"type":"integer","format":"int32","nullable":true}},"additionalProperties":false},"PERegisterWebhookResult":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PERelationData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. relation_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"role":{"type":"string","description":"the name of the role such that in a matter-entity relationship, [target entity] is acting as [role] on [matter] representing [source entity]; or in the case of an entity-entity relationship, [target entity] is [role] of [source entity]","nullable":true},"memo":{"type":"string","description":"additional notes about this relationship, when the role does not sufficiently describe it","nullable":true},"validFrom":{"type":"string","description":"Time from which this relation is effective. Null means from beginning of time.","format":"date-time","nullable":true},"validTo":{"type":"string","description":"Time at which this relation expired. Null means not yet known","format":"date-time","nullable":true},"sourceEntityId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"sourceEntityDeleted":{"type":"boolean","description":"Support source entity soft delete."},"matterId":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"matterDeleted":{"type":"boolean","description":"Support matter soft delete."},"targetEntityId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"targetEntityDeleted":{"type":"boolean","description":"Support target entity soft delete."},"reference":{"type":"string","description":"Applicable only to a matter relationship, the identifier the target entity uses to refer to the matter, e.g. matter number used by the opposing law firm","nullable":true},"subject":{"type":"string","description":"Applicable only to a matter relationship, the display name the target entity uses to describe the matter, e.g. matter title used by the opposing law firm","nullable":true},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"}},"additionalProperties":false},"PESetEntityRelationResult":{"type":"object","properties":{"data":{"type":"string","description":"e.g. relation_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PESettingsValidationRequested":{"type":"object","properties":{"settingsId":{"type":"string","nullable":true,"readOnly":true},"scoped":{"type":"boolean","readOnly":true},"scopeId":{"type":"string","nullable":true,"readOnly":true},"configData":{"type":"string","nullable":true,"readOnly":true},"userId":{"type":"string","nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true},"commandId":{"type":"string","format":"uuid","readOnly":true}},"additionalProperties":false,"description":"Validate application settings within a tenant context, optionally scoped further to a user or other adhoc scope"},"PESupplierState":{"enum":[0,1,2,3,4],"type":"integer","format":"int32","x-enum-varnames":["Draft","Active","Held","Closing","Closed"],"x-enum-descriptions":["In the process of being created","Normal Supplier","No work can be done with this supplier","In the process of being closed, no new purchases can be posted","No more purchases can be posted"],"x-enumDescriptions":{"0:Draft":"In the process of being created","1:Active":"Normal Supplier","2:Held":"No work can be done with this supplier","3:Closing":"In the process of being closed, no new purchases can be posted","4:Closed":"No more purchases can be posted"}},"PESuspendSupplierResult":{"type":"object","properties":{"data":{"type":"string","description":"e.g. supplier_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PETag":{"type":"object","properties":{"fullValue":{"type":"string","description":"Canonical value","nullable":true,"readOnly":true},"fullDisplayValue":{"type":"string","description":"Display value (e.g. Matter Type>Conveyancing>Sale)","nullable":true,"readOnly":true},"isDeleted":{"type":"boolean","description":"Indicate if this tag has been deleted in the database. Used in custom tags only.","readOnly":true},"name":{"type":"string","description":"Display name of the Code","nullable":true,"readOnly":true},"code":{"type":"string","description":"Spec code and prefix of the tag identifying the TagSpec that defines this tag (e.g. MT)","nullable":true,"readOnly":true},"levelValues":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Level values at each depth of the hierarchy","nullable":true,"readOnly":true},"levelDisplays":{"type":"array","items":{"type":"string"},"description":"Level display value at each depth of the hierarchy","nullable":true,"readOnly":true},"value":{"type":"string","description":"Tag code values without the code, e.g. 1-2","nullable":true,"readOnly":true},"displayValue":{"type":"string","description":"Tag display value without the name, e.g. Conveyancing > Sale","nullable":true,"readOnly":true},"unspecified":{"type":"boolean","description":"Indicate if this tag is an unspecified SingleValue or Hierarchical tag (e.g. MT-0, meaning an unspecified matter type)","readOnly":true}},"additionalProperties":false,"description":"Defines an instance of a tag"},"PETaskType":{"type":"object","properties":{"name":{"type":"string","description":"Descriptive title to help user choose the correct task type to use","nullable":true},"code":{"type":"string","description":"Short identifier of this task type used only in reports","nullable":true},"itemType":{"allOf":[{"$ref":"#/components/schemas/PEWorkItemType"}],"description":"Pre-select the work item type","nullable":true},"narration":{"type":"string","description":"Pre-populate the narration on work item","nullable":true},"id":{"type":"string","description":"e.g. tasktype_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true}},"additionalProperties":false},"PETaxAppliesTo":{"enum":[0,1,2],"type":"integer","format":"int32","x-enum-varnames":["None","Sales","Purchases"],"x-enum-descriptions":["Tax is not applicable","Sales (will go to Tax Collected account)","Purchase (will go to Tax Paid account)"],"x-enumDescriptions":{"0:None":"Tax is not applicable","1:Sales":"Sales (will go to Tax Collected account)","2:Purchases":"Purchase (will go to Tax Paid account)"}},"PETaxCode":{"type":"object","properties":{"code":{"type":"string","description":"Tax code unique identifier","nullable":true},"rate":{"type":"number","description":"Tax rate","format":"double"},"appliesTo":{"allOf":[{"$ref":"#/components/schemas/PETaxAppliesTo"}],"description":"Specifies if tax applies to"},"role":{"allOf":[{"$ref":"#/components/schemas/PETaxCodeRole"}],"description":"The role that this tax code plays within the system","nullable":true}},"additionalProperties":false},"PETaxCodeRole":{"enum":[0,1,2,3,4],"type":"integer","format":"int32","x-enum-varnames":["DefaultNontaxable","DefaultTaxableSale","DefaultTaxFreeSale","DefaultTaxablePurchase","DefaultTaxFreePurchase"],"x-enum-descriptions":["","","","",""],"x-enumDescriptions":{"0:DefaultNontaxable":"","1:DefaultTaxableSale":"","2:DefaultTaxFreeSale":"","3:DefaultTaxablePurchase":"","4:DefaultTaxFreePurchase":""}},"PETimingBasis":{"enum":[0,1,2],"type":"integer","format":"int32","x-enum-varnames":["Neutral","Accrual","Cash"],"x-enum-descriptions":["Transaction is applicable in both cash and accrual basis","Relevant in accrual basis only","Relevant in cash basis only"],"x-enumDescriptions":{"0:Neutral":"Transaction is applicable in both cash and accrual basis","1:Accrual":"Relevant in accrual basis only","2:Cash":"Relevant in cash basis only"}},"PETransactionAttachmentData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. document_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"transactionId":{"type":"string","description":"e.g. transaction_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"}},"additionalProperties":false},"PETransactionData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. transaction_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"journalId":{"type":"string","description":"e.g. journal_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"bankEntryId":{"type":"string","description":"e.g. bankentry_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"state":{"allOf":[{"$ref":"#/components/schemas/PETransactionState"}]},"date":{"type":"string","description":"Posting date as it appears on the general ledger","format":"date-time"},"periodDate":{"type":"string","description":"Posting period to which this transaction was posted to","format":"date-time"},"approvalId":{"type":"string","description":"e.g. approval_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"journalType":{"allOf":[{"$ref":"#/components/schemas/PEJournalType"}]},"eventType":{"type":"string","description":"The event type that caused this transaction to be posted","nullable":true},"commandType":{"type":"string","description":"The command type that caused this transaction to be posted","nullable":true},"commandAggregateId":{"type":"string","description":"The identifier of the event that created this transaction","format":"uuid"},"referenceNumber":{"type":"string","description":"Transaction reference number, used by users to identify this transaction (issued by the firm - internal sequence number)","nullable":true},"originalDate":{"type":"string","description":"Date as specified on the source accounting event or document, such as bank transaction date, or supplier invoice date, which may be different to the day it is posted on the journal.","format":"date-time"},"otherPartyId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"otherPartySortName":{"type":"string","nullable":true},"otherPartyAddress":{"type":"string","description":"Used mainly for printing purposes, should populate when an entity is selected","nullable":true},"paymentMethodDetail":{"type":"string","description":"Description of the payment method used for reporting","nullable":true},"reversesId":{"type":"string","description":"e.g. transaction_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"isReversed":{"type":"boolean","description":"Indicates if this is a reversed or a reversal transaction"},"reversalId":{"type":"string","description":"e.g. transaction_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"isHistorical":{"type":"boolean","description":"Indicate if this is a historical transaction. Reflected in State, usually means it cannot be changed or reversed."},"isOpeningBalance":{"type":"boolean","description":"Indicate if this is an opening balance transaction posted after migration."},"reason":{"type":"string","description":"Shows on reports that lists transactions","nullable":true},"memo":{"type":"string","description":"Shows when inspecting the transaction for extra information","nullable":true},"amount":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"The total of debits (or credit) in base currency"},"postTaxJournal":{"type":"boolean","description":"False specifies tax journal entry is specified as part of the journal entries command, True specifies tax journal entry should be added based on TaxAppliesTo value on each journal entry."},"depositSlipId":{"type":"string","description":"e.g. depositslip_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"timingBasis":{"allOf":[{"$ref":"#/components/schemas/PETimingBasis"}],"description":"Specifies whether this transaction is Accrual Only or Cash Only or Both (Neutral)"},"cashAccountId":{"type":"string","description":"e.g. account_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"cashAccountName":{"type":"string","description":"The Cash Account used for a trust transaction.","nullable":true},"isTaxInclusive":{"type":"boolean","description":"Used to toggle the view for transaction items showing amount as tax inclusive or not"},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"},"journalEntries":{"type":"array","items":{"$ref":"#/components/schemas/PEJournalEntryData"},"nullable":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/PETransactionAttachmentData"},"nullable":true},"hasAttachments":{"type":"boolean"}},"additionalProperties":false},"PETransactionState":{"enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19],"type":"integer","format":"int32","x-enum-varnames":["ReceiptPosted","ReceiptDeposited","ReceiptReversed","PaymentRequested","PaymentApproved","PaymentCancelled","PaymentPosted","PaymentReversed","JournalPosted","JournalReversed","LedgerTransferRequested","LedgerTransferApproved","LedgerTransferCancelled","LedgerTransferPosted","LedgerTransferReversed","ClientPaymentPosted","ClientPaymentReversed","LodgementRequested","LodgementReceived","LodgementCancelled"],"x-enum-descriptions":["","","","","","Permanently cancelled state","","","","","","","","","","","","","",""],"x-enumDescriptions":{"0:ReceiptPosted":"","1:ReceiptDeposited":"","2:ReceiptReversed":"","3:PaymentRequested":"","4:PaymentApproved":"","5:PaymentCancelled":"Permanently cancelled state","6:PaymentPosted":"","7:PaymentReversed":"","8:JournalPosted":"","9:JournalReversed":"","10:LedgerTransferRequested":"","11:LedgerTransferApproved":"","12:LedgerTransferCancelled":"","13:LedgerTransferPosted":"","14:LedgerTransferReversed":"","15:ClientPaymentPosted":"","16:ClientPaymentReversed":"","17:LodgementRequested":"","18:LodgementReceived":"","19:LodgementCancelled":""}},"PEUnfinaliseWorkItemResult":{"type":"object","properties":{"data":{"type":"string","description":"e.g. workitem_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEUnregisterWebhookResult":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEUpdateClientResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PEClientHeader"}],"description":"Client in search results","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEUpdateEmployeeResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PEEmployeeHeader"}],"description":"Client in search results","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEUpdateEntityResult":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PEEntityHeader"}],"description":"Entity in search results","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEUpdateMatterResult":{"type":"object","properties":{"data":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PEWebhookData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. webhook_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"enabled":{"type":"boolean","description":"Is this webhook active"},"url":{"type":"string","description":"Receiver endpoint of this webhook, specific to this tenant this webhook belongs to","nullable":true},"secret":{"type":"string","description":"Secret used to sign payload, so the receiver can validate it in X-PE2-WEBHOOK-SIGNATURE header, using SHA256 algorithm on the JSON payload","format":"uuid"},"events":{"type":"array","items":{"type":"string"},"description":"Events of interest: MatterCreated, MatterUpdated, MatterDeleted","nullable":true},"integrationId":{"type":"string","description":"Identifies the integration","format":"uuid"}},"additionalProperties":false},"PEWebhookSpec":{"type":"object","properties":{"id":{"type":"string","description":"e.g. webhook_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"enabled":{"type":"boolean","description":"Is this webhook active"},"url":{"type":"string","description":"Receiver endpoint of this webhook, specific to this tenant this webhook belongs to","nullable":true},"secret":{"type":"string","description":"Secret used to sign payload, so the receiver can validate it in X-PE2-WEBHOOK-SIGNATURE header, using SHA256 algorithm on the JSON payload","format":"uuid"},"events":{"type":"array","items":{"type":"string"},"description":"Events of interest: MatterCreated, MatterUpdated, MatterDeleted","nullable":true}},"additionalProperties":false},"PEWorkItem":{"type":"object","properties":{"title":{"type":"string","description":"Title as it will appear by default on invoice","nullable":true},"itemType":{"allOf":[{"$ref":"#/components/schemas/PEWorkItemType"}],"description":"Timed, Itemised, or Leave"},"fileNote":{"type":"string","description":"File note taken against this work item, not visible to the client of the firm","nullable":true},"taskTypeId":{"type":"string","description":"e.g. tasktype_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"employeeId":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"employeeTeamId":{"type":"string","description":"e.g. team_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"matterId":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"billingStageId":{"type":"string","description":"e.g. matterbillingstage_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"invoiceId":{"type":"string","description":"e.g. invoice_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"entryDate":{"type":"string","description":"When was the work done","format":"date-time"},"durationTicks":{"type":"integer","description":"Duration of this work item. Actual value billed is rounded up to the nearest Unit. There are 10 million ticks in a second.","format":"int64","nullable":true},"units":{"type":"number","description":"Quantity of work. Each unit translates to a number of minutes depending on the firm's policy and agreement with the client.","format":"double","nullable":true},"rate":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"Rate per unit (Itemised) or hours (Timed) in client currency","nullable":true},"parts":{"type":"array","items":{"$ref":"#/components/schemas/PEWorkItemPart"},"description":"Optional. When specified, the Unit is calculated by summing up all parts that are flagged with SumToParent.","nullable":true}},"additionalProperties":false},"PEWorkItemPart":{"type":"object","properties":{"id":{"type":"string","description":"e.g. workitempart_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"narration":{"type":"string","description":"Narrative of this work item part","nullable":true},"units":{"type":"number","description":"Number of units of this work item","format":"double","nullable":true},"durationTicks":{"type":"integer","description":"Number of ticks of this work item","format":"int64","nullable":true},"sumToParent":{"type":"boolean","description":"Whether or not this part's units are added to the parent's units"}},"additionalProperties":false},"PEWorkItemState":{"enum":[0,1,2,3,4,5,6],"type":"integer","format":"int32","x-enum-varnames":["Pending","Finalised","Drafted","Billed","WrittenOff","NonBillable","Deleted"],"x-enum-descriptions":["","Ready for billing","Included on a draft or pending invoice","Made its way to a finalised invoice","Professional service in nature, but the firm absorbs the cost","Administrative or non-professional service in nature, such as internal training",""],"x-enumDescriptions":{"0:Pending":"","1:Finalised":"Ready for billing","2:Drafted":"Included on a draft or pending invoice","3:Billed":"Made its way to a finalised invoice","4:WrittenOff":"Professional service in nature, but the firm absorbs the cost","5:NonBillable":"Administrative or non-professional service in nature, such as internal training","6:Deleted":""}},"PEWorkItemStats":{"type":"object","properties":{"finalised":{"type":"number","description":"Value of WorkItem moved into a Finalised or Drafted state, in base currency","format":"double"},"finalisedUnits":{"type":"number","description":"Units of WorkItem moved into a Finalised state","format":"double"},"finalisedHours":{"type":"number","description":"Hours (converted from units) of WorkItem moved into a Finalised state","format":"double"},"finalisedUnitDuration":{"type":"number","description":"Units of WorkItem moved into a Finalised state multiplied by minutes per unit","format":"double"},"drafted":{"type":"number","description":"Value of WorkItem moved into a Drafted state, in base currency, using creation forex rate","format":"double"},"draftedUnits":{"type":"number","description":"Units of WorkItem moved into a Drafted state","format":"double"},"draftedHours":{"type":"number","description":"Hours (converted from units ) of WorkItem moved into a Drafted state","format":"double"},"draftedUnitDuration":{"type":"number","description":"Units of WorkItem moved into a Drafted state multiplied by minutes per unit","format":"double"},"billed":{"type":"number","description":"Value of WorkItem moved into a Billed state, in base currency, using creation forex rate","format":"double"},"billedUnits":{"type":"number","description":"Units of WorkItem moved into a Billed state","format":"double"},"billedHours":{"type":"number","description":"Hours (converted from units) of WorkItem moved into a Billed state","format":"double"},"billedUnitDuration":{"type":"number","description":"Units of WorkItem moved into a Billed state multiplied by minutes per unit","format":"double"},"writtenOff":{"type":"number","description":"Value of WorkItem moved into a WrittenOff state in base currency","format":"double"},"writtenOffUnits":{"type":"number","description":"Units of WorkItem moved into a WrittenOff state","format":"double"},"writtenOffHours":{"type":"number","description":"Hours (converted from units) of WorkItem moved into a WrittenOff state","format":"double"},"writtenOffUnitDuration":{"type":"number","description":"Units of WorkItem moved into a WrittenOff state multiplied by minutes per unit","format":"double"},"nonBillable":{"type":"number","description":"Value of WorkItem moved into a NonBillable state in base currency","format":"double"},"nonBillableUnits":{"type":"number","description":"Units of WorkItem moved into a NonBillable state","format":"double"},"nonBillableHours":{"type":"number","description":"Hours (converted from units) of WorkItem moved into a NonBillable state","format":"double"},"nonBillableUnitDuration":{"type":"number","description":"Units of WorkItem moved into a NonBillable state multiplied by minutes per unit","format":"double"}},"additionalProperties":false},"PEWorkItemType":{"enum":[0,1,2],"type":"integer","format":"int32","x-enum-varnames":["TimedFee","ItemisedFee","Leave"],"x-enum-descriptions":["","",""],"x-enumDescriptions":{"0:TimedFee":"","1:ItemisedFee":"","2:Leave":""}},"PagedListOfDisbursementData":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/DisbursementData"},"nullable":true,"readOnly":true},"totalCount":{"type":"integer","format":"int32","readOnly":true},"pageIndex":{"type":"integer","format":"int32","readOnly":true},"pageSize":{"type":"integer","format":"int32","readOnly":true}},"additionalProperties":false,"description":"Paged list of something"},"PagedListOfDivisionData":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/DivisionData"},"nullable":true,"readOnly":true},"totalCount":{"type":"integer","format":"int32","readOnly":true},"pageIndex":{"type":"integer","format":"int32","readOnly":true},"pageSize":{"type":"integer","format":"int32","readOnly":true}},"additionalProperties":false,"description":"Paged list of something"},"PagedListOfEntityData":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/EntityData"},"nullable":true,"readOnly":true},"totalCount":{"type":"integer","format":"int32","readOnly":true},"pageIndex":{"type":"integer","format":"int32","readOnly":true},"pageSize":{"type":"integer","format":"int32","readOnly":true}},"additionalProperties":false,"description":"Paged list of something"},"PagedListOfInvoiceData":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceData"},"nullable":true,"readOnly":true},"totalCount":{"type":"integer","format":"int32","readOnly":true},"pageIndex":{"type":"integer","format":"int32","readOnly":true},"pageSize":{"type":"integer","format":"int32","readOnly":true}},"additionalProperties":false,"description":"Paged list of something"},"PagedListOfLedgerEntryData":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/LedgerEntryData"},"nullable":true,"readOnly":true},"totalCount":{"type":"integer","format":"int32","readOnly":true},"pageIndex":{"type":"integer","format":"int32","readOnly":true},"pageSize":{"type":"integer","format":"int32","readOnly":true}},"additionalProperties":false,"description":"Paged list of something"},"PagedListOfMatterData":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/MatterData"},"nullable":true,"readOnly":true},"totalCount":{"type":"integer","format":"int32","readOnly":true},"pageIndex":{"type":"integer","format":"int32","readOnly":true},"pageSize":{"type":"integer","format":"int32","readOnly":true}},"additionalProperties":false,"description":"Paged list of something"},"PagedListOfMatterTypeData":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/MatterTypeData"},"nullable":true,"readOnly":true},"totalCount":{"type":"integer","format":"int32","readOnly":true},"pageIndex":{"type":"integer","format":"int32","readOnly":true},"pageSize":{"type":"integer","format":"int32","readOnly":true}},"additionalProperties":false,"description":"Paged list of something"},"PagedListOfPE.Identity.DataTypes.RoleDetails":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/PE.Identity.DataTypes.RoleDetails"},"nullable":true,"readOnly":true},"totalCount":{"type":"integer","format":"int32","readOnly":true},"pageIndex":{"type":"integer","format":"int32","readOnly":true},"pageSize":{"type":"integer","format":"int32","readOnly":true}},"additionalProperties":false,"description":"Paged list of something"},"PagedListOfPEClientHeader":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/PEClientHeader"},"nullable":true,"readOnly":true},"totalCount":{"type":"integer","format":"int32","readOnly":true},"pageIndex":{"type":"integer","format":"int32","readOnly":true},"pageSize":{"type":"integer","format":"int32","readOnly":true}},"additionalProperties":false,"description":"Paged list of something"},"PagedListOfPEDisbursementCode":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/PEDisbursementCode"},"nullable":true,"readOnly":true},"totalCount":{"type":"integer","format":"int32","readOnly":true},"pageIndex":{"type":"integer","format":"int32","readOnly":true},"pageSize":{"type":"integer","format":"int32","readOnly":true}},"additionalProperties":false,"description":"Paged list of something"},"PagedListOfPEEmployeeHeader":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/PEEmployeeHeader"},"nullable":true,"readOnly":true},"totalCount":{"type":"integer","format":"int32","readOnly":true},"pageIndex":{"type":"integer","format":"int32","readOnly":true},"pageSize":{"type":"integer","format":"int32","readOnly":true}},"additionalProperties":false,"description":"Paged list of something"},"PagedListOfPELedgerData":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/PELedgerData"},"nullable":true,"readOnly":true},"totalCount":{"type":"integer","format":"int32","readOnly":true},"pageIndex":{"type":"integer","format":"int32","readOnly":true},"pageSize":{"type":"integer","format":"int32","readOnly":true}},"additionalProperties":false,"description":"Paged list of something"},"PagedListOfPERateSet":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/PERateSet"},"nullable":true,"readOnly":true},"totalCount":{"type":"integer","format":"int32","readOnly":true},"pageIndex":{"type":"integer","format":"int32","readOnly":true},"pageSize":{"type":"integer","format":"int32","readOnly":true}},"additionalProperties":false,"description":"Paged list of something"},"PagedListOfPERelationData":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/PERelationData"},"nullable":true,"readOnly":true},"totalCount":{"type":"integer","format":"int32","readOnly":true},"pageIndex":{"type":"integer","format":"int32","readOnly":true},"pageSize":{"type":"integer","format":"int32","readOnly":true}},"additionalProperties":false,"description":"Paged list of something"},"PagedListOfPETaskType":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/PETaskType"},"nullable":true,"readOnly":true},"totalCount":{"type":"integer","format":"int32","readOnly":true},"pageIndex":{"type":"integer","format":"int32","readOnly":true},"pageSize":{"type":"integer","format":"int32","readOnly":true}},"additionalProperties":false,"description":"Paged list of something"},"PagedListOfPETaxCode":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/PETaxCode"},"nullable":true,"readOnly":true},"totalCount":{"type":"integer","format":"int32","readOnly":true},"pageIndex":{"type":"integer","format":"int32","readOnly":true},"pageSize":{"type":"integer","format":"int32","readOnly":true}},"additionalProperties":false,"description":"Paged list of something"},"PagedListOfSupplierData":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/SupplierData"},"nullable":true,"readOnly":true},"totalCount":{"type":"integer","format":"int32","readOnly":true},"pageIndex":{"type":"integer","format":"int32","readOnly":true},"pageSize":{"type":"integer","format":"int32","readOnly":true}},"additionalProperties":false,"description":"Paged list of something"},"PagedListOfWorkItemData":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/WorkItemData"},"nullable":true,"readOnly":true},"totalCount":{"type":"integer","format":"int32","readOnly":true},"pageIndex":{"type":"integer","format":"int32","readOnly":true},"pageSize":{"type":"integer","format":"int32","readOnly":true}},"additionalProperties":false,"description":"Paged list of something"},"PagedResultOfDisbursementData":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PagedListOfDisbursementData"}],"description":"Paged list of something","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PagedResultOfEntityData":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PagedListOfEntityData"}],"description":"Paged list of something","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PagedResultOfInvoiceData":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PagedListOfInvoiceData"}],"description":"Paged list of something","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PagedResultOfLedgerEntryData":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PagedListOfLedgerEntryData"}],"description":"Paged list of something","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PagedResultOfMatterData":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PagedListOfMatterData"}],"description":"Paged list of something","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PagedResultOfMatterTypeData":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PagedListOfMatterTypeData"}],"description":"Paged list of something","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PagedResultOfSupplierData":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PagedListOfSupplierData"}],"description":"Paged list of something","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PagedResultOfWorkItemData":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PagedListOfWorkItemData"}],"description":"Paged list of something","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"PurchaseFinalised":{"type":"object","properties":{"id":{"type":"string","description":"e.g. purchase_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"data":{"allOf":[{"$ref":"#/components/schemas/PEPurchaseData"}],"nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"When a purchase order has been accepted an turned into a purchase"},"PurchaseUnfinalised":{"type":"object","properties":{"id":{"type":"string","description":"e.g. purchase_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true},"date":{"type":"string","format":"date-time"},"reason":{"type":"string","nullable":true},"transactionId":{"type":"string","description":"e.g. transaction_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"originalTransactionId":{"type":"string","description":"e.g. transaction_c0645dc026a74ae99ec436df63d77d2c","nullable":true}},"additionalProperties":false,"description":"If a purchase was created from a purchase order this will turn it back into a purchase order"},"RangeOfDateTime":{"type":"object","properties":{"min":{"type":"string","format":"date-time"},"max":{"type":"string","format":"date-time"}},"additionalProperties":false},"ResultOfClientData":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/ClientData"}],"nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"ResultOfDisbursementData":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/DisbursementData"}],"nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"ResultOfDivisionData":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/DivisionData"}],"nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"ResultOfDocumentCollectionData":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/DocumentCollectionData"}],"nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"ResultOfEmployeeData":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/EmployeeData"}],"nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"ResultOfEntityData":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/EntityData"}],"nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"ResultOfInvoice":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/Invoice"}],"nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"ResultOfInvoiceData":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/InvoiceData"}],"nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"ResultOfMatterData":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/MatterData"}],"nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"ResultOfMatterTypeData":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/MatterTypeData"}],"nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"ResultOfPagedListOfDivisionData":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/PagedListOfDivisionData"}],"description":"Paged list of something","nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"ResultOfSupplierData":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/SupplierData"}],"nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"ResultOfWorkItemData":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/WorkItemData"}],"nullable":true,"readOnly":true},"success":{"type":"boolean","readOnly":true},"reason":{"type":"string","nullable":true,"readOnly":true},"resultCode":{"allOf":[{"$ref":"#/components/schemas/PE.ServiceBus.CQRS.Core.ResultCode"}],"description":"Represents the outcome of a command execution.\nUsed to indicate success or the reason for failure when a command does not succeed.","readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"Supplier":{"type":"object","properties":{"entityId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"supplierNumber":{"type":"string","nullable":true},"billingContactId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"defaultPaymentTerm":{"type":"integer","description":"Number of days from supplier invoice date the supplier invoice will fall due by default.","format":"int64","nullable":true},"taxCode":{"type":"string","description":"The tax code applicable to this supplier","nullable":true},"recogniseTaxOnPayment":{"type":"boolean","description":"Specifies that purchases to this supplier posts to AccountRole.TaxSuspense rather than AccountRole.TaxPaid"},"notes":{"type":"string","nullable":true}},"additionalProperties":false},"SupplierCreated":{"type":"object","properties":{"id":{"type":"string","description":"e.g. supplier_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"data":{"allOf":[{"$ref":"#/components/schemas/SupplierData"}],"nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Supplier moved into a state where it's gathering required data before work can be done for it."},"SupplierData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. supplier_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"entityId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"state":{"allOf":[{"$ref":"#/components/schemas/PESupplierState"}]},"supplierNumber":{"type":"string","nullable":true},"billingContactId":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"sortName":{"type":"string","nullable":true},"streetAddress":{"type":"string","nullable":true},"currency":{"type":"string","description":"Currency that the firm pays this supplier in, this will get used by the journal and accounts. If the supplier needs to have multiple currencies then a new supplier record should be created","nullable":true},"defaultPaymentTerm":{"type":"integer","description":"Number of days from supplier invoice date the supplier invoice will fall due by default.","format":"int64","nullable":true},"taxCode":{"type":"string","description":"The tax code applicable to this supplier","nullable":true},"recogniseTaxOnPayment":{"type":"boolean","description":"Specifies that purchases to this supplier posts to AccountRole.TaxSuspense rather than AccountRole.TaxPaid"},"notes":{"type":"string","nullable":true},"entityType":{"allOf":[{"$ref":"#/components/schemas/PEEntityType"}]},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"}},"additionalProperties":false},"SupplierUpdated":{"type":"object","properties":{"id":{"type":"string","description":"e.g. supplier_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"data":{"allOf":[{"$ref":"#/components/schemas/SupplierData"}],"nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Supplier details updated"},"WorkItemData":{"type":"object","properties":{"id":{"type":"string","description":"e.g. workitem_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"title":{"type":"string","description":"Title as it will appear by default on invoice","nullable":true},"itemType":{"allOf":[{"$ref":"#/components/schemas/PEWorkItemType"}],"description":"Timed, Itemised, or Leave"},"taskTypeId":{"type":"string","description":"e.g. tasktype_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"taskTypeName":{"type":"string","description":"Name of the task type","nullable":true},"employeeId":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"employeeTeamId":{"type":"string","description":"e.g. team_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"matterId":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"invoiceId":{"type":"string","description":"e.g. invoice_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"entryDate":{"type":"string","description":"When was the work done","format":"date-time"},"durationTicks":{"type":"integer","description":"Duration of this work item. Actual value billed is rounded up to the nearest Unit. There are 10 million ticks in a second.","format":"int64","nullable":true},"units":{"type":"number","description":"Quantity of work. Each unit translates to a number of minutes depending on the firm's policy and agreement with the client.","format":"double","nullable":true},"rate":{"allOf":[{"$ref":"#/components/schemas/NodaMoney.Money"}],"description":"Rate per unit (Itemised) or hours (Timed) in client currency","nullable":true},"total":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"FxAmount to provide a base currency for standardised management reporting","nullable":true},"state":{"allOf":[{"$ref":"#/components/schemas/PEWorkItemState"}]},"employeeSortName":{"type":"string","description":"The fee earner who performed the work","nullable":true},"createdBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"createdBySortName":{"type":"string","nullable":true},"createdOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","description":"e.g. entity_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"updatedBySortName":{"type":"string","nullable":true},"updatedOn":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"}},"additionalProperties":false},"WorkItemFinalised":{"type":"object","properties":{"id":{"type":"string","description":"e.g. workitem_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true},"workedTotal":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Money type that supports foreign and base currency"},"matterId":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"feeEarnerId":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"entryDate":{"type":"string","format":"date-time"},"nonBillable":{"type":"boolean"}},"additionalProperties":false,"description":"A pending work item has been turned into finalised"},"WorkItemUnfinalised":{"type":"object","properties":{"id":{"type":"string","description":"e.g. workitem_c0645dc026a74ae99ec436df63d77d2c","nullable":true,"readOnly":true},"sourceId":{"type":"string","nullable":true,"readOnly":true},"workedTotal":{"allOf":[{"$ref":"#/components/schemas/FxAmount"}],"description":"Money type that supports foreign and base currency"},"matterId":{"type":"string","description":"e.g. matter_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"feeEarnerId":{"type":"string","description":"e.g. employee_c0645dc026a74ae99ec436df63d77d2c","nullable":true},"entryDate":{"type":"string","format":"date-time"}},"additionalProperties":false,"description":"A finalised work item has been turned into pending"}},"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://id.efimis.com/pevolveextprod.onmicrosoft.com/b2c_1a_idp_aad_multi/oauth2/token","scopes":{"read":"Read-only operations","write":"Read and write operations"}},"authorizationCode":{"authorizationUrl":"https://id.efimis.com/pevolveextprod.onmicrosoft.com/b2c_1a_idp_aad_multi/oauth2/authorize","tokenUrl":"https://id.efimis.com/pevolveextprod.onmicrosoft.com/b2c_1a_idp_aad_multi/oauth2/token","scopes":{"read":"Read-only operations","write":"Read and write operations"}}}}}},"tags":[{"name":"ApplicableRates","description":"Lookup applicable rates when creating work items, based on criteria including the client, matter the work is done for, or the \nfee earner doing the work."},{"name":"Clients","description":"An individual, organisation, or group the law firm is acting for"},{"name":"CostRecoveries","description":"Cost Recoveries"},{"name":"DocumentCollections","description":"A collection of documents. It belongs to a subject such as a client, a matter, or a system container."},{"name":"Documents","description":"Document metadata, upload and download"},{"name":"Suppliers","description":"A supplier that the law firm purchases goods or services from"},{"name":"Webhooks","description":"Manage Webhooks"},{"name":"WorkItems","description":"Work items, also known as time entries"}]}