{"swagger":"2.0","info":{"description":"Api Documentation","version":"1.0","title":"Api Documentation","termsOfService":"urn:tos","contact":{},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0"}},"host":"service.chromeriver.com","basePath":"/","tags":[{"name":"allocation-api-controller-v-3","description":"V3 endpoints include better support and error handling for allocation user defined attributes (UDA)."},{"name":"allocation-api-controller-v-2"},{"name":"allocation-api-controller-v-1"}],"schemes":["https"],"paths":{"/v1/allocations":{"get":{"tags":["allocation-api-controller-v-1"],"summary":"Get list of allocation details","description":"This web service allows an external application to get list of allocation details","operationId":"getAllocationUsingGET","produces":["application/json"],"parameters":[{"name":"allocation-number","in":"query","description":"Unique allocation number","required":false,"type":"string","allowEmptyValue":false},{"name":"chain-id","in":"header","description":"Used for tracking the flow of the request","required":false,"type":"string"},{"name":"client-number","in":"query","description":"Unique Client number","required":false,"type":"string","allowEmptyValue":false},{"name":"closed","in":"query","description":"Allocation is closed","required":false,"type":"boolean","allowEmptyValue":false},{"name":"customer-code","in":"header","description":"Unique customer identifier provided by Chrome River","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Allocation is deleted","required":false,"type":"boolean","allowEmptyValue":false},{"name":"page","in":"query","description":"Starting page number for getting parts of results","required":false,"type":"integer","format":"int32","allowEmptyValue":false},{"name":"pageSize","in":"query","description":"Size of page for getting parts of results","required":false,"type":"integer","format":"int32","allowEmptyValue":false},{"name":"x-api-key","in":"header","description":"API key for Authentication","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MatterTO"}},"400":{"description":"Customer Code is invalid."},"401":{"description":"Customer Code is not authorized.  Cannot get allocation details."},"503":{"description":"Service unavailable."}},"deprecated":false},"post":{"tags":["allocation-api-controller-v-1"],"summary":"Create an allocation","description":"This web service allows an external application to create an allocation","operationId":"createAllocationV1UsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"chain-id","in":"header","description":"Used for tracking the flow of the request","required":false,"type":"string"},{"name":"customer-code","in":"header","description":"Unique customer identifier provided by Chrome River","required":true,"type":"string"},{"in":"body","name":"matterTO","description":"matterTO","required":true,"schema":{"$ref":"#/definitions/MatterTO"}},{"name":"x-api-key","in":"header","description":"API key for Authentication","required":true,"type":"string"}],"responses":{"200":{"description":"Allocation successfully created.","schema":{"$ref":"#/definitions/MatterTO"}},"400":{"description":"Bad request. See returned message."},"401":{"description":"Unauthorized."},"408":{"description":"Request Expired."},"503":{"description":"Service unavailable."}},"deprecated":false},"put":{"tags":["allocation-api-controller-v-1"],"summary":"Update an allocation","description":"This web service allows an external application to update an allocation","operationId":"updateAllocationV1UsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"chain-id","in":"header","description":"Used for tracking the flow of the request","required":false,"type":"string"},{"name":"customer-code","in":"header","description":"Unique customer identifier provided by Chrome River","required":true,"type":"string"},{"in":"body","name":"matterTO","description":"matterTO","required":true,"schema":{"$ref":"#/definitions/MatterTO"}},{"name":"x-api-key","in":"header","description":"API key for Authentication","required":true,"type":"string"}],"responses":{"200":{"description":"Allocation successfully updated.","schema":{"$ref":"#/definitions/MatterTO"}},"400":{"description":"Bad Request. See returned message."},"401":{"description":"Unauthorized."},"408":{"description":"Request Expired."},"503":{"description":"Service unavailable."}},"deprecated":false},"delete":{"tags":["allocation-api-controller-v-1"],"summary":"Delete an allocation","description":"This web service allows an external application to delete an allocation","operationId":"deleteAllocationV1UsingDELETE","produces":["application/json"],"parameters":[{"name":"allocationNumber","in":"query","description":"Unique Allocation Number","required":true,"type":"string","allowEmptyValue":false},{"name":"chain-id","in":"header","description":"Used for tracking the flow of the request","required":false,"type":"string"},{"name":"clientNumber","in":"query","description":"Unique Client Number","required":true,"type":"string","allowEmptyValue":false},{"name":"customer-code","in":"header","description":"Unique customer identifier provided by Chrome River","required":true,"type":"string"},{"name":"x-api-key","in":"header","description":"API key for Authentication","required":true,"type":"string"}],"responses":{"200":{"description":"Allocation successfully deleted.","schema":{"type":"object"}},"400":{"description":"Bad Request. See returned message."},"401":{"description":"Unauthorized."},"408":{"description":"Request Expired."},"503":{"description":"Service unavailable."}},"deprecated":false}},"/v2/allocations":{"get":{"tags":["allocation-api-controller-v-2"],"summary":"Get list of allocations","description":"This web service allows an external application to get list of allocation details","operationId":"getAllocationsUsingGET","produces":["application/json"],"parameters":[{"name":"allocation-number","in":"query","description":"Unique allocation number","required":false,"type":"string","allowEmptyValue":false},{"name":"chain-id","in":"header","description":"Used for tracking the flow of the request","required":false,"type":"string"},{"name":"client-number","in":"query","description":"Unique Client number","required":false,"type":"string","allowEmptyValue":false},{"name":"closed","in":"query","description":"Allocation is closed","required":false,"type":"boolean","allowEmptyValue":false},{"name":"customer-code","in":"header","description":"Unique customer identifier provided by Chrome River","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Allocation is deleted","required":false,"type":"boolean","allowEmptyValue":false},{"name":"page","in":"query","description":"Starting page number for getting parts of results","required":false,"type":"integer","format":"int32","allowEmptyValue":false},{"name":"pageSize","in":"query","description":"Size of page for getting parts of results","required":false,"type":"integer","format":"int32","allowEmptyValue":false},{"name":"x-api-key","in":"header","description":"API key for Authentication","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/AllocationView"}}},"400":{"description":"Customer Code is invalid."},"401":{"description":"Customer Code is not authorized.  Cannot get allocation details."},"503":{"description":"Service unavailable."}},"deprecated":false},"post":{"tags":["allocation-api-controller-v-2"],"summary":"Create/update list of allocations","description":"This web service allows an external application to create/update list of allocations.","operationId":"bulkUpsertAllocationsUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"allocations","description":"List of allocations","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/AllocationView"}}},{"name":"chain-id","in":"header","description":"Used for tracking the flow of the request","required":false,"type":"string"},{"name":"customer-code","in":"header","description":"Unique customer identifier provided by Chrome River","required":true,"type":"string"},{"name":"x-api-key","in":"header","description":"API key for Authentication","required":true,"type":"string"}],"responses":{"200":{"description":"Allocations are created/updated successfully.","schema":{"type":"array","items":{"$ref":"#/definitions/ApiResponse"}}},"207":{"description":"Some of the allocations are created/updated successfully and the remaining allocations are skipped due to error.","schema":{"type":"array","items":{"$ref":"#/definitions/ApiResponse"}}},"400":{"description":"Customer Code is invalid."},"401":{"description":"Customer Code is not authorized.  Cannot create/update allocations."},"422":{"description":"Allocations are skipped due to error.","schema":{"type":"array","items":{"$ref":"#/definitions/ApiResponse"}}},"503":{"description":"Service unavailable."}},"deprecated":false}},"/v3/allocations":{"get":{"tags":["allocation-api-controller-v-3"],"summary":"Get list of allocations","description":"This web service allows an external application to get list of allocation details","operationId":"getAllocationsUsingGET_1","produces":["application/json"],"parameters":[{"name":"allocation-number","in":"query","description":"Unique allocation number","required":false,"type":"string","allowEmptyValue":false},{"name":"chain-id","in":"header","description":"Used for tracking the flow of the request","required":false,"type":"string"},{"name":"client-number","in":"query","description":"Unique Client number","required":false,"type":"string","allowEmptyValue":false},{"name":"closed","in":"query","description":"Allocation is closed","required":false,"type":"boolean","allowEmptyValue":false},{"name":"customer-code","in":"header","description":"Unique customer identifier provided by Chrome River","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Allocation is deleted","required":false,"type":"boolean","allowEmptyValue":false},{"name":"page","in":"query","description":"Starting page number for getting parts of results","required":false,"type":"integer","format":"int32","allowEmptyValue":false},{"name":"pageSize","in":"query","description":"Size of page for getting parts of results","required":false,"type":"integer","format":"int32","allowEmptyValue":false},{"name":"x-api-key","in":"header","description":"API key for Authentication","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/AllocationView"}}},"400":{"description":"Customer Code is invalid."},"401":{"description":"Customer Code is not authorized.  Cannot get allocation details."},"503":{"description":"Service unavailable."}},"deprecated":false},"post":{"tags":["allocation-api-controller-v-3"],"summary":"Create/update list of allocations","description":"This web service allows an external application to create/update list of allocations.","operationId":"bulkUpsertAllocationsUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"allocations","description":"List of allocations","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/AllocationView"}}},{"name":"chain-id","in":"header","description":"Used for tracking the flow of the request","required":false,"type":"string"},{"name":"customer-code","in":"header","description":"Unique customer identifier provided by Chrome River","required":true,"type":"string"},{"name":"x-api-key","in":"header","description":"API key for Authentication","required":true,"type":"string"}],"responses":{"200":{"description":"Allocations are created/updated successfully.","schema":{"type":"array","items":{"$ref":"#/definitions/ApiResponse"}}},"207":{"description":"Some of the allocations are created/updated successfully and the remaining allocations are skipped due to error.","schema":{"type":"array","items":{"$ref":"#/definitions/ApiResponse"}}},"400":{"description":"Customer Code is invalid."},"401":{"description":"Customer Code is not authorized.  Cannot create/update allocations."},"422":{"description":"Allocations are skipped due to error.","schema":{"type":"array","items":{"$ref":"#/definitions/ApiResponse"}}},"503":{"description":"Service unavailable."}},"deprecated":false}},"/v3/allocations/entity":{"post":{"tags":["allocation-api-controller-v-3"],"summary":"Create matter on select","description":"This web service allows an external application to create a matter on select.","operationId":"createMatterOnSelectUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"customer-code","in":"header","description":"Unique customer identifier provided by Chrome River","required":true,"type":"string"},{"in":"body","name":"matterOnSelect","description":"matterOnSelect","required":true,"schema":{"$ref":"#/definitions/MatterOnSelect"}},{"name":"x-api-key","in":"header","description":"API key for Authentication","required":true,"type":"string"}],"responses":{"200":{"description":"Matter On Select Created","schema":{"type":"object"}},"404":{"description":"Matter Not Found"},"412":{"description":"Matter On Select Already Exists"}},"deprecated":false},"put":{"tags":["allocation-api-controller-v-3"],"summary":"Update matter on select","description":"This web service allows an external application to update a matter on select.","operationId":"updateMatterOnSelectUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"customer-code","in":"header","description":"Unique customer identifier provided by Chrome River","required":true,"type":"string"},{"in":"body","name":"matterOnSelect","description":"matterOnSelect","required":true,"schema":{"$ref":"#/definitions/MatterOnSelect"}},{"name":"x-api-key","in":"header","description":"API key for Authentication","required":true,"type":"string"}],"responses":{"200":{"description":"Matter On Select Updated","schema":{"type":"object"}},"404":{"description":"Matter Not Found"}},"deprecated":false}},"/v3/allocations/matterFilter":{"post":{"tags":["allocation-api-controller-v-3"],"summary":"Update matter filter","description":"This web service allows an external application to update a matter filter.","operationId":"updateMatterFilterUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"customer-code","in":"header","description":"Unique customer identifier provided by Chrome River","required":true,"type":"string"},{"in":"body","name":"matterFilter","description":"matterFilter","required":true,"schema":{"$ref":"#/definitions/MatterFilter"}},{"name":"x-api-key","in":"header","description":"API key for Authentication","required":true,"type":"string"}],"responses":{"200":{"description":"Matter Filter Updated","schema":{"$ref":"#/definitions/MatterTO"}},"404":{"description":"Matter Not Found"}},"deprecated":false}},"/v3/allocations/search":{"get":{"tags":["allocation-api-controller-v-3"],"summary":"Search for list of allocations","description":"This web service allows an external application to search for list of allocation details","operationId":"searchAllocationsUsingGET","produces":["application/json"],"parameters":[{"name":"chain-id","in":"header","description":"Used for tracking the flow of the request","required":false,"type":"string"},{"name":"customer-code","in":"header","description":"Unique customer identifier provided by Chrome River","required":true,"type":"string"},{"name":"pageNum","in":"query","description":"Starting record number for getting parts of results","required":false,"type":"integer","format":"int32","allowEmptyValue":false},{"name":"pageSize","in":"query","description":"Size of page for getting parts of results","required":false,"type":"integer","format":"int32","allowEmptyValue":false},{"name":"searchTerm","in":"query","description":"Search string for allocation search","required":false,"type":"string","allowEmptyValue":false},{"name":"x-api-key","in":"header","description":"API key for Authentication","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AllocationPaginationResponse"}},"400":{"description":"Customer Code is invalid."},"401":{"description":"Customer Code is not authorized.  Cannot get allocation details."},"404":{"description":"No allocation exists for the Allocation Number and Client Number as requested. Please try again."},"503":{"description":"Service unavailable."}},"deprecated":false}}},"definitions":{"AllocationEntity":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}},"title":"AllocationEntity"},"AllocationPaginationResponse":{"type":"object","properties":{"allocations":{"type":"array","description":"List of allocations.","items":{"$ref":"#/definitions/ResponseAllocationView"}},"meta":{"description":"Pagination metadata","$ref":"#/definitions/PaginationMetadata"}},"title":"AllocationPaginationResponse"},"AllocationUDA":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}},"title":"AllocationUDA"},"AllocationView":{"type":"object","properties":{"allocationEntities":{"type":"array","description":"List of allocation entities.","items":{"$ref":"#/definitions/AllocationEntity"}},"allocationName":{"type":"string","example":"AUTOAPPROVE (BY)","description":"Corresponding Allocation name."},"allocationNumber":{"type":"string","example":"1000-001","description":"Unique Allocation number."},"clientName":{"type":"string","example":"Autoapprove","description":"Corresponding Client name."},"clientNumber":{"type":"string","example":"cn1000","description":"Unique Client number."},"closedDate":{"type":"string","example":"2017-10-18T18:46:19Z","description":"Allocation is unavailable for selection after the closedDate."},"currency":{"type":"string","example":"USD","description":"Currency code of the Allocation. Format: ISO 4217 code (alpha)"},"extraLineItemData1LegalValues":{"type":"string","example":"00,10,20,30,40","description":"List of valid GLDept values that may be selected along with this specific allocation. Must map to customer's CodeType.  Values separated by commas"},"filterTerms1":{"type":"array","description":"List of search terms used for 1st allocation filter.","items":{"type":"string"}},"filterTerms2":{"type":"array","description":"List of search terms used for 2nd allocation filter.","items":{"type":"string"}},"glAccount":{"type":"string","example":"test GL","description":"General Ledger Account."},"locale":{"type":"string","example":"en","description":"Language of the Allocation. Format: ISO 639-1 (2-letter code)"},"onSelect1EntityTypeCode":{"type":"string","example":"OFF","description":"Entity Type that will be linked to the allocation On Select 1."},"onSelect2EntityTypeCode":{"type":"string","example":"DEP","description":"Entity Type that will be linked to the allocation On Select 2."},"parentClientNumber":{"type":"string","example":"cn1000","description":"Optional Parent Grouping Identifier."},"routeIndependent":{"type":"boolean","example":true,"description":"Assigns the status of an allocation to treat uniquely when it is considered billable."},"startDate":{"type":"string","example":"2017-10-18T18:46:19Z","description":"Allocation is available for selection from the startDate."},"type":{"type":"string","example":"B","description":"Allocation type."},"udaPersons":{"type":"array","description":"List of PersonUniqueIDs used for allocation assignment.","items":{"$ref":"#/definitions/UDAPerson"}},"udas":{"type":"array","description":"List of User Defined Attributes.","items":{"$ref":"#/definitions/AllocationUDA"}}},"title":"AllocationView"},"ApiResponse":{"type":"object","properties":{"allocationId":{"type":"string","example":"1000-001_cn1000","description":"Unique identifier for the allocation."},"errorMessage":{"type":"string","example":"Invalid entity1 specified.","description":"Error message for the failed allocation."},"result":{"type":"string","example":"SUCCESS","description":"Status of the allocation.","enum":["SUCCESS","FAIL"]}},"title":"ApiResponse"},"EntityTO":{"type":"object","properties":{"code":{"type":"string"},"entityId":{"type":"integer","format":"int32"},"entityType":{"$ref":"#/definitions/EntityTypeTO"},"extraData1":{"type":"string"},"extraData2":{"type":"string"},"extraData3":{"type":"string"},"extraData4":{"type":"string"},"extraData5":{"type":"string"},"name":{"type":"string"},"order":{"type":"integer","format":"int32"}},"title":"EntityTO"},"EntityTypeTO":{"type":"object","properties":{"code":{"type":"string"},"entityTypeId":{"type":"integer","format":"int32"},"name":{"type":"string"}},"title":"EntityTypeTO"},"Map«string,string»":{"type":"object","title":"Map«string,string»","additionalProperties":{"type":"string"}},"MatterFilter":{"type":"object","properties":{"matterUniqueID":{"type":"string"},"search1":{"type":"string"},"search2":{"type":"string"}},"title":"MatterFilter"},"MatterOnSelect":{"type":"object","properties":{"entityTypeCode":{"type":"string"},"matterUniqueID":{"type":"string"}},"title":"MatterOnSelect"},"MatterTO":{"type":"object","properties":{"action":{"type":"string","enum":["upsert","delete"]},"allocationEntities":{"type":"array","description":"List of allocation entities.","items":{"$ref":"#/definitions/EntityTO"}},"allocationId":{"type":"string","example":48008116,"description":"Unique identifier for the allocation."},"allocationName":{"type":"string","example":"Bank-NYC-Sales","description":"Corresponding Allocation name."},"allocationNumber":{"type":"string","example":"1000-20-50","description":"Unique Allocation number."},"clientName":{"type":"string","example":"TCC CHARGE","description":"Corresponding Client name."},"clientNumber":{"type":"string","example":"0001","description":"Unique Client number."},"closedDate":{"type":"string","example":"2016-09-28 18:46:19:000","description":"Allocation is unavailable for selection after the closedDate."},"createSource":{"type":"string"},"currency":{"type":"string","example":"USD","description":"Currency code of the Allocation. Format: ISO 4217 code (alpha)"},"currencyCode":{"type":"string"},"customerId":{"type":"integer","format":"int32"},"entity1":{"type":"string"},"entity2":{"type":"string"},"entity3":{"type":"string"},"extraLineItemData1LegalValues":{"type":"string"},"filterTerms1":{"type":"array","description":"List of search terms used for 1st allocation filter.","items":{"$ref":"#/definitions/Map«string,string»"}},"filterTerms2":{"type":"array","description":"List of search terms used for 2nd allocation filter.","items":{"$ref":"#/definitions/Map«string,string»"}},"glAccount":{"type":"string","example":"1000-20-50","description":"General Ledger Account."},"isBillable":{"type":"boolean"},"languageCode":{"type":"string"},"locale":{"type":"string","example":"en","description":"Language of the Allocation. Format: ISO 639-1 (2-letter code)"},"onSelect1EntityTypeCode":{"type":"string","example":"OFF","description":"Entity Type that will be linked to the allocation On Select 1."},"onSelect2EntityTypeCode":{"type":"string","example":"DEP","description":"Entity Type that will be linked to the allocation On Select 2."},"parentClientNumber":{"type":"string","example":10001,"description":"Optional Parent Grouping Identifier."},"project":{"type":"string","example":"XYZ","description":"Used for General Ledger Project Mapping."},"routeIndependent":{"type":"boolean","example":true,"description":"Assigns the status of a allocation to treat uniquely when it is considered billable."},"search1":{"type":"string"},"search2":{"type":"string"},"startDate":{"type":"string","example":"2016-09-28 18:46:19:000","description":"Allocation is available for selection from the startDate."},"type":{"type":"string","example":"GL","description":"Allocation type."},"udaPersons":{"type":"array","description":"List of PersonUniqueIDs used for allocation assignment.","items":{"$ref":"#/definitions/PersonTO"}},"udas":{"type":"array","description":"List of User Defined Attributes.","items":{"$ref":"#/definitions/MatterUDATO"}},"udf1":{"type":"string"},"udf1PersonUniqueID":{"type":"string"},"udf2":{"type":"string"},"udf2PersonUniqueID":{"type":"string"},"udf3":{"type":"string"},"udf3PersonUniqueID":{"type":"string"},"udf4":{"type":"string"}},"title":"MatterTO"},"MatterUDATO":{"type":"object","properties":{"action":{"type":"string","enum":["upsert","delete"]},"dataType":{"type":"string"},"name":{"type":"string"},"udaName":{"type":"string"},"udaValue":{"type":"string"},"value":{"type":"string"}},"title":"MatterUDATO"},"PaginationMetadata":{"type":"object","properties":{"pageNumber":{"type":"integer","format":"int32","example":1,"description":"Requested page number."},"pageSize":{"type":"integer","format":"int32","example":10,"description":"Actual page size."},"totalPages":{"type":"integer","format":"int32","example":1,"description":"Total pages (in actual size) in response."},"totalRecords":{"type":"integer","format":"int32","example":1,"description":"Total records of allocation in response"}},"title":"PaginationMetadata"},"PersonTO":{"type":"object","properties":{"name":{"type":"string"},"personId":{"type":"string"}},"title":"PersonTO"},"ResponseAllocationView":{"type":"object","properties":{"allocationId":{"type":"string","example":"1000-001_0222","description":"Unique Allocation ID."},"allocationName":{"type":"string","example":"AUTOAPPROVE (BY)","description":"Corresponding Allocation name."},"allocationNumber":{"type":"string","example":"1000-001","description":"Unique Allocation number."},"clientName":{"type":"string","example":"Autoapprove","description":"Corresponding Client name."},"entityTypeId1":{"type":"integer","format":"int32","example":100500,"description":"Corresponding OnSelect Entity1 ID."},"entityTypeId2":{"type":"integer","format":"int32","example":100500,"description":"Corresponding OnSelect Entity2 ID."},"isRecent":{"type":"boolean","example":true,"description":"Corresponding isRecent"}},"title":"ResponseAllocationView"},"UDAPerson":{"type":"object","properties":{"name":{"type":"string"},"personUniqueId":{"type":"string"}},"title":"UDAPerson"}}}