OAuth2 scheme
Security Scheme Type | OAuth2 |
---|---|
authorizationCode OAuth Flow | Authorization URL: /_oauth/v2/auth Token URL: /_oauth/v2/token Scopes:
|
Gets all customers if no ids are provided in the query
flow:readCustomers
ids | Array of strings Example: ids=E9996334F8134DBCBE18948284698BB2 UUIDs of the customers |
[- {
- "id": "E9996334F8134DBCBE18948284698BB2",
- "logoUrl": { },
- "customerNumber": "string",
- "defaultBillingType": null,
- "fileExportLanguage": 0,
- "isLocked": false,
- "isInternal": false,
- "name": "string",
- "requiresInternalCharge": false,
- "priceCategoryOverrides": { },
- "priceSurchargeOverrides": { },
- "showSignatureFieldInPdfTimeSheets": true
}
]
flow:writeCustomers
customerNumber | string <= 191 characters The customer number. |
null or EnumFlowPidBillingType (string) Default: null The preselected billing type for new work packages in the GUI if this customer is not internal or requires charge. | |
fileExportLanguage | integer Id of the language used in file exports such as time sheets. |
isLocked | boolean Default: false Locked customers cannot be selected for new projects anymore. |
isInternal | boolean Default: false Whether or not this is an internal customer. |
name required | string <= 191 characters The name of the customer. |
requiresInternalCharge | boolean Default: false If 'isInternal' is true, this flag controls whether or not the customer is charged. |
object Customer specific overrides to the price category settings. | |
object Customer specific overrides to the price surcharge settings. | |
showSignatureFieldInPdfTimeSheets | boolean Defaults to the system setting |
null or UploadedFileIdentSchema (string) |
{- "customerNumber": "string",
- "defaultBillingType": null,
- "fileExportLanguage": 0,
- "isLocked": false,
- "isInternal": false,
- "name": "string",
- "requiresInternalCharge": false,
- "priceCategoryOverrides": { },
- "priceSurchargeOverrides": { },
- "showSignatureFieldInPdfTimeSheets": true,
- "logoFile": { }
}
{- "id": "E9996334F8134DBCBE18948284698BB2"
}
flow:readCustomers
customerId required | string^[0-9A-F]{32}$ Example: E9996334F8134DBCBE18948284698BB2 UUID of the customer |
{- "id": "E9996334F8134DBCBE18948284698BB2",
- "logoUrl": { },
- "customerNumber": "string",
- "defaultBillingType": null,
- "fileExportLanguage": 0,
- "isLocked": false,
- "isInternal": false,
- "name": "string",
- "requiresInternalCharge": false,
- "priceCategoryOverrides": { },
- "priceSurchargeOverrides": { },
- "showSignatureFieldInPdfTimeSheets": true
}
flow:writeCustomers
customerId required | string^[0-9A-F]{32}$ Example: E9996334F8134DBCBE18948284698BB2 UUID of the customer |
customerNumber | string <= 191 characters The customer number. |
null or EnumFlowPidBillingType (string) Default: null The preselected billing type for new work packages in the GUI if this customer is not internal or requires charge. | |
fileExportLanguage | integer Id of the language used in file exports such as time sheets. |
isLocked | boolean Default: false Locked customers cannot be selected for new projects anymore. |
isInternal | boolean Default: false Whether or not this is an internal customer. |
name required | string <= 191 characters The name of the customer. |
requiresInternalCharge | boolean Default: false If 'isInternal' is true, this flag controls whether or not the customer is charged. |
object Customer specific overrides to the price category settings. | |
object Customer specific overrides to the price surcharge settings. | |
showSignatureFieldInPdfTimeSheets | boolean Defaults to the system setting |
null or UploadedFileIdentSchema (string) |
{- "customerNumber": "string",
- "defaultBillingType": null,
- "fileExportLanguage": 0,
- "isLocked": false,
- "isInternal": false,
- "name": "string",
- "requiresInternalCharge": false,
- "priceCategoryOverrides": { },
- "priceSurchargeOverrides": { },
- "showSignatureFieldInPdfTimeSheets": true,
- "logoFile": { }
}
flow:writeCustomers
customerId required | string^[0-9A-F]{32}$ Example: E9996334F8134DBCBE18948284698BB2 UUID of the customer |
customerNumber | string <= 191 characters The customer number. |
null or EnumFlowPidBillingType (string) Default: null The preselected billing type for new work packages in the GUI if this customer is not internal or requires charge. | |
fileExportLanguage | integer Id of the language used in file exports such as time sheets. |
isLocked | boolean Default: false Locked customers cannot be selected for new projects anymore. |
isInternal | boolean Default: false Whether or not this is an internal customer. |
name | string <= 191 characters The name of the customer. |
requiresInternalCharge | boolean Default: false If 'isInternal' is true, this flag controls whether or not the customer is charged. |
object Customer specific overrides to the price category settings. | |
object Customer specific overrides to the price surcharge settings. | |
showSignatureFieldInPdfTimeSheets | boolean Defaults to the system setting |
null or UploadedFileIdentSchema (string) |
{- "customerNumber": "string",
- "defaultBillingType": null,
- "fileExportLanguage": 0,
- "isLocked": false,
- "isInternal": false,
- "name": "string",
- "requiresInternalCharge": false,
- "priceCategoryOverrides": { },
- "priceSurchargeOverrides": { },
- "showSignatureFieldInPdfTimeSheets": true,
- "logoFile": { }
}
flow:writeCustomers
customerId required | string^[0-9A-F]{32}$ Example: E9996334F8134DBCBE18948284698BB2 UUID of the customer |
Use one ident/value pair to search for a list of customer ids.
See the request body section for a list of supported search idents.
flow:readCustomers
ident required | string |
value | string The content/format depends on the search ident. |
customerNumber | string non-empty |
isInternal | string Enum: "0" "1" |
isLocked | string Enum: "0" "1" |
name | string non-empty |
requiresInternalCharge | string Enum: "0" "1" Only finds internal customers |
[- "E9996334F8134DBCBE18948284698BB2"
]
Use "and"-, "or"- or "not"-objects to assemble the desired search query. E.g.:
{"and":[{"ident":"propertyA","value":"foo"},{"or":[{"ident":"isOfSomeKindX"},{"ident":"propertyB","value":"bar"}]},{"not":{"ident":"isOfSomeKindY"}}]}
See the simple search request for the supported search idents.
flow:readCustomers
ident required | string non-empty |
value | string |
{- "ident": "string",
- "value": "string"
}
[- "E9996334F8134DBCBE18948284698BB2"
]