{"openapi":"3.1.0","info":{"title":"Chift API","description":"The Chift API is a universal API giving you access to financial data from the software of your clients. It helps software companies to offer native integrations to their clients without the effort needed to maintain those native integrations. By using the APIs (Accounting, POS, eCommerce) of Chift, you connect once and allow your clients to use their software packages.","version":"1.0.0"},"servers":[{"url":"https://api.chift.eu","description":"Chift"}],"paths":{"/token":{"post":{"tags":["General"],"summary":"Get access token","description":"This endpoint allows you to get an access token that can be used as a BEARER token to access the protected endpoints of this APIs. The token is valid for 30 minutes. You can refresh the token by requesting a new token.","operationId":"generate_access_token_token_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthItem"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/mcp-token":{"post":{"tags":["MCP"],"summary":"Get MCP token","description":"This endpoint allows you to get an access token for the MCP server. This token is always linked with a consumer_id.","operationId":"generate_mcp_token_mcp_token_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MCPAuthItem"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers":{"get":{"tags":["Consumers"],"summary":"Get consumers","description":"Returns the list of consumers linked to your account.","operationId":"consumers_get_consumers","security":[{"mcp_auth":["consumers","consumers.read"]}],"parameters":[{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"internal_reference","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Reference"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConsumerItem"},"title":"Response Consumers Get Consumers"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Consumers"],"summary":"Create new consumer","description":"Create a new consumer that will have the possibility to use the enabled integrations","operationId":"consumers_create_consumer","security":[{"mcp_auth":["consumers"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostConsumerItem"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsumerItem"}}}},"400":{"content":{"application/json":{"example":{"message":"The specified name is not valid","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"content":{"application/json":{"example":{"message":"The specified redirect url is not valid","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Unprocessable Entity"}}}},"/consumers/{consumer_id}":{"get":{"tags":["Consumers"],"summary":"Get one consumer","description":"Returns the specified consumer","operationId":"consumers_get_consumer","security":[{"mcp_auth":["consumers","consumers.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsumerItem"}}}},"404":{"content":{"application/json":{"example":{"message":"The consumer does not exist","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Consumers"],"summary":"Update one consumer","description":"Update one consumer in Chift","operationId":"consumers_update_consumer","security":[{"mcp_auth":["consumers"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConsumerItem"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsumerItem"}}}},"404":{"content":{"application/json":{"example":{"message":"The consumer does not exist","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"content":{"application/json":{"example":{"message":"The specified redirect url is not valid","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Unprocessable Entity"}}},"delete":{"tags":["Consumers"],"summary":"Delete one consumer","description":"Endpoint that deletes one consumer in Chift","operationId":"consumers_delete_consumer","security":[{"mcp_auth":["consumers"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}}],"responses":{"204":{"description":"Successful Response"},"404":{"content":{"application/json":{"example":{"message":"The consumer does not exist","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/connections":{"get":{"tags":["Connections"],"summary":"Get connections","description":"Returns a list of the connections (active or inactive) linked to your consumer","operationId":"connections_get_connections","security":[{"mcp_auth":["connections","connections.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConnectionItem"},"title":"Response Connections Get Connections"}}}},"404":{"content":{"application/json":{"example":{"message":"The consumer does not exist","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Connections"],"summary":"Add new connection","description":"Returns the url that can be used by your client to enable his integrations.","operationId":"connections_create_connection","security":[{"mcp_auth":["connections"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/PostConnectionItem"},{"type":"null"}],"title":"Item"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkItem"}}}},"400":{"content":{"application/json":{"examples":{"Integration is not valid or active":{"value":{"message":"The specified integrationid is not valid, is not active or does not exist","status":"error"}},"Connection already exists":{"value":{"message":"There is already an active connection for the integrationid {integrationid}. Only one can be created for each consumer for each integrationid.","status":"error"}},"Invalid country code":{"value":{"message":"{country_code} is not a valid country code.","status":"error"}},"Country not supported":{"value":{"message":"No integration supports country '{country_code}'","status":"error"}},"Missing credentials":{"value":{"message":"Missing at least one credential for this integration","status":"error"}},"Missing postconnection value":{"value":{"message":"Missing at least one post connection value for this integration. When providing post connection values, make sure to provide all mandatory post connection values.","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The consumer does not exist","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"content":{"application/json":{"example":{"message":"Invalid datetime format in key {key}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Unprocessable Entity"}}}},"/consumers/{consumer_id}/connections/{connectionid}":{"patch":{"tags":["Connections"],"summary":"Update an existing connection","description":"Returns the url that can be used by your client to update the connection","operationId":"connections_update_connection","security":[{"mcp_auth":["connections"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"connectionid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Connectionid"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/PatchConnectionItem"},{"type":"null"}],"title":"Item"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkItem"}}}},"400":{"content":{"application/json":{"examples":{"Could not retrieve connections":{"value":{"message":"Existing connections could not be retrived","status":"error"}},"Invalid connectionid":{"value":{"message":"The specified connectionid is not valid","status":"error"}},"Missing credentials":{"value":{"message":"Missing at least one credential for this integration","status":"error"}},"Missing postconnection value":{"value":{"message":"Missing at least one post connection value for this integration. When providing post connection values, make sure to provide all mandatory post connection values.","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The connection does not exist","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"content":{"application/json":{"example":{"message":"Invalid datetime format in key {key}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Unprocessable Entity"}}},"delete":{"tags":["Connections"],"summary":"Delete one connection","description":"Endpoint that deletes one connection of a consumer in Chift","operationId":"connections_delete_connection","security":[{"mcp_auth":["connections"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"connectionid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Connectionid"}}],"responses":{"204":{"description":"Successful Response"},"400":{"content":{"application/json":{"example":{"message":"The specified connectionid is not valid","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The connection does not exist","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/connections/{connection_id}/transactions":{"get":{"tags":["Connections"],"summary":"Get transaction information","description":"Returns transaction info by client_request_id","operationId":"get_transaction_by_client_request_id_consumers__consumer_id__connections__connection_id__transactions_get","security":[{"mcp_auth":["connections","connections.read"]}],"parameters":[{"name":"connection_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Connection Id"}},{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"client_request_id","in":"query","required":true,"schema":{"type":"string","title":"Client Request Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiTransactionLookupOut"}}}},"404":{"content":{"application/json":{"example":{"message":"The specified transaction could not be found","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/integrations":{"get":{"tags":["Integrations"],"summary":"Get list of integrations","description":"Returns a list of integrations (active and inactive) available for your account","operationId":"integrations_get_integrations","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/IntegationStatus"},{"type":"null"}],"title":"Status"}},{"name":"include_coverage","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BoolParam"},{"type":"null"}],"default":"false","title":"Include Coverage"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationItem"},"title":"Response Integrations Get Integrations"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/integrations/{integrationid}/{image_type}.json":{"get":{"tags":["Integrations"],"summary":"Returns a logo/icon of an integration (as base64)","operationId":"integrations_get_integration_logo_json","parameters":[{"name":"integrationid","in":"path","required":true,"schema":{"type":"integer","title":"Integrationid"}},{"name":"image_type","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ImageType"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogoImage"}}}},"404":{"content":{"application/json":{"example":{"message":"The {image_type} doesn't exist.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/webhooks/list":{"get":{"tags":["Webhooks"],"summary":"Get list of possible webhooks","description":"Returns a list of webhook that are available for your account","operationId":"webhooks_get_webhook_types","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WebhookItem"},"title":"Response Webhooks Get Webhook Types"}}}}}}},"/webhooks":{"post":{"tags":["Webhooks"],"summary":"Add new webhook instance","description":"Returns the created webhook instance","operationId":"webhooks_create_webhook","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookInstancePostItem"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookInstanceGetItem"}}}},"400":{"content":{"application/json":{"example":{"message":"There is already an existing webhook with the same url and type","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Webhooks"],"summary":"Get list of webhook instances","description":"Returns a list of webhook instances (active/inactive) for your account","operationId":"webhooks_get_webhooks","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/Status"},{"type":"null"}],"title":"Status"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WebhookInstanceGetItem"},"title":"Response Webhooks Get Webhooks"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/webhooks/{webhookid}":{"delete":{"tags":["Webhooks"],"summary":"Delete one webhook","description":"Endpoint that deletes one existing webhook","operationId":"webhooks_delete_webhook","parameters":[{"name":"webhookid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Webhookid"}}],"responses":{"204":{"description":"Successful Response"},"404":{"content":{"application/json":{"example":{"message":"The specified webhook could not be found for this account","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Webhooks"],"summary":"Get one webhook instance","description":"Returns one webhook instance","operationId":"webhooks_get_webhook","parameters":[{"name":"webhookid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Webhookid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookInstanceGetItem"}}}},"404":{"content":{"application/json":{"example":{"message":"The specified webhook could not be found for this account","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Webhooks"],"summary":"Update one webhook","description":"Update one webhook in Chift","operationId":"webhooks_update_webhook","parameters":[{"name":"webhookid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Webhookid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookInstancePatchItem"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookInstanceGetItem"}}}},"400":{"content":{"application/json":{"example":{"message":"The specified url is not valid","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The specified webhook could not be found for this account","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/webhooks/{webhookid}/logs":{"get":{"tags":["Webhooks"],"summary":"Get list of webhook logs for one webhook","description":"Returns a list of webhook logs for one webhook for your account","operationId":"webhooks_get_webhook_logs","parameters":[{"name":"webhookid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Webhookid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WebhookLogItem"},"title":"Response Webhooks Get Webhook Logs"}}}},"404":{"content":{"application/json":{"example":{"message":"The specified webhook could not be found for this account","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/syncs":{"get":{"tags":["Syncs"],"summary":"Get syncs","description":"Returns the syncs","operationId":"syncs_get_syncs","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReadSyncItem"},"title":"Response Syncs Get Syncs"}}}}}},"post":{"tags":["Syncs"],"summary":"Create sync","description":"Returns the created sync","operationId":"syncs_post_sync","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSyncItem"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadSyncItem"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/syncs/{syncid}":{"get":{"tags":["Syncs"],"summary":"Get sync","description":"Returns a sync by id","operationId":"syncs_get_sync","parameters":[{"name":"syncid","in":"path","required":true,"schema":{"type":"string","title":"Syncid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadSyncItem"}}}},"404":{"content":{"application/json":{"example":{"message":"The sync does not exist","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/syncs/{syncid}/flows/{flowid}/event":{"post":{"tags":["Syncs"],"summary":"Send a custom event for a specific flow","description":"Route that can be used to send a specific event for a flow","operationId":"syncs_send_custom_event","parameters":[{"name":"syncid","in":"path","required":true,"schema":{"type":"string","title":"Syncid"}},{"name":"flowid","in":"path","required":true,"schema":{"type":"string","title":"Flowid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostSyncFlowEvent"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerResponse"}}}},"400":{"content":{"application/json":{"example":{"message":"No consumers found","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The chain does not exist","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"content":{"application/json":{"example":{"message":"Error while validating context data; the field {field.get('name')} does not seem to be of type {fieldtype}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Unprocessable Entity"}}}},"/consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}/executions":{"get":{"tags":["Consumers"],"summary":"Get executions information for one consumer/flow/sync","description":"Returns executions information for one consumer/flow/sync","operationId":"syncs_get_consumer_executions","parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"syncid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Syncid"}},{"name":"flowid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Flowid"}},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Date To"}},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Date From"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChainExecutionItem"},"title":"Response Syncs Get Consumer Executions"}}}},"404":{"content":{"application/json":{"example":{"message":"The flow does not exist","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/syncs/{syncid}/executions":{"get":{"tags":["Syncs"],"summary":"Get executions for a sync","description":"Returns all executions for a sync with pagination. Optionally filter by flow.","operationId":"syncs_get_sync_executions","parameters":[{"name":"syncid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Syncid"}},{"name":"flowid","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Flowid"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Size"}},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Date To"}},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Date From"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_SyncExecutionItem_"}}}},"404":{"content":{"application/json":{"example":{"message":"The flow does not exist","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/syncs/{syncid}/flows/{flowid}/executions/{executionid}":{"get":{"tags":["Syncs"],"summary":"Get execution start/end timestamp","description":"Get execution start/end timestamp","operationId":"syncs_get_execution","parameters":[{"name":"syncid","in":"path","required":true,"schema":{"type":"string","title":"Syncid"}},{"name":"flowid","in":"path","required":true,"schema":{"type":"string","title":"Flowid"}},{"name":"executionid","in":"path","required":true,"schema":{"type":"string","title":"Executionid"}},{"name":"consumerid","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consumerid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChainExecutionItem"}}}},"404":{"content":{"application/json":{"example":{"message":"The execution does not exist","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/syncs":{"post":{"tags":["Consumers"],"summary":"Retrieve the url of a sync for a specific consumer","description":"This route can be used to retrieve the url that can be shared with your clients to allow them to connect as specified in a sync","operationId":"syncs_create_synctoconsumer","parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConsumerSyncItem"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkSyncItem"}}}},"404":{"content":{"application/json":{"examples":{"Sync not found":{"value":{"message":"The sync does not exist","status":"error"}},"Flow not found":{"value":{"message":"The flow does not exist","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"400":{"content":{"application/json":{"examples":{"One API integration conflict":{"value":{"message":"You can only provide one integrationid for each selected One API","status":"error"}},"Integration not in sync":{"value":{"message":"{integrationid} is not part of the selected integrations of the sync","status":"error"}},"Invalid country code":{"value":{"message":"{country_code} is not a valid country code.","status":"error"}},"No integrations support country":{"value":{"message":"No integration supports country '{country_code}'","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/syncs/{syncid}":{"get":{"tags":["Consumers"],"summary":"Get sync information for one consumer","description":"Returns sync information (creation date, mapping) related to a specific consumer","operationId":"syncs_get_syncconsumer","parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"syncid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Syncid"}},{"name":"preview_executionid","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Preview Executionid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncConsumerItem"}}}},"404":{"content":{"application/json":{"example":{"message":"The consumer is not configured for this sync","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Syncs"],"summary":"Update flow mappings for a specific consumer","description":"Route that can be used to update the flow mappings for a specific consumer. It will replace the existing configuration with the provided one.","operationId":"syncs_update_synctoconsumer","parameters":[{"name":"syncid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Syncid"}},{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReadSyncMappingItem"},"title":"Body"}}}},"responses":{"204":{"description":"Successful Response"},"404":{"content":{"application/json":{"example":{"message":"The flow is not yet activated for this consumer","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"content":{"application/json":{"example":{"message":"The body should be a list","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Unprocessable Entity"}}}},"/consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}/enable":{"post":{"tags":["Syncs"],"summary":"Enable a flow for a specific consumer","description":"Route that can be used to enable a flow for a specific consumer","operationId":"syncs_enable_syncconsumer","parameters":[{"name":"syncid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Syncid"}},{"name":"flowid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Flowid"}},{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnableFlowConsumer"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"content":{"application/json":{"example":{"message":"The consumer does not exist","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"400":{"content":{"application/json":{"example":{"message":"Impossible to enable the flow as the flow requires configuration fields","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"content":{"application/json":{"example":{"message":"Error while validating context data; the field {field_name} does not seem to be of type {field_type}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Unprocessable Entity"}}}},"/consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}/disable":{"post":{"tags":["Syncs"],"summary":"Disable a flow for a specific consumer","description":"Route that can be used to disable a flow for a specific consumer","operationId":"syncs_disable_syncconsumer","parameters":[{"name":"syncid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Syncid"}},{"name":"flowid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Flowid"}},{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"content":{"application/json":{"example":{"message":"The consumer does not exist","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}":{"patch":{"tags":["Syncs"],"summary":"Update flow settings for a specific consumer","description":"Route that can be used to update the flow configuration for a specific consumer. It will merge the new configuration with the existing one.","operationId":"syncs_update_flowtoconsumer","parameters":[{"name":"syncid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Syncid"}},{"name":"flowid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Flowid"}},{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFlowConsumer"}}}},"responses":{"204":{"description":"Successful Response"},"404":{"content":{"application/json":{"example":{"message":"The flow is not yet activated for this consumer","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"content":{"application/json":{"example":{"message":"Error while validating context data; the field {field_name} does not seem to be of type {field_type}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Unprocessable Entity"}}}},"/consumers/{consumer_id}/connections/{connection_id}/enable_datalayer":{"post":{"tags":["Datalayer"],"summary":"Enable the datalayer sync for a connection","description":"Enables the datalayer sync for the consumer's connection so it refreshes on schedule. Requires the datalayer to be configured for the connection's vertical.","operationId":"datalayer_enable","parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Connection Id"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DatalayerEnableBody"},{"type":"null"}],"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"content":{"application/json":{"example":{"message":"The datalayer is not configured on this account.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The consumer or connection does not exist","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/connections/{connection_id}/refresh_datalayer":{"post":{"tags":["Datalayer"],"summary":"Refresh the datalayer sync for a connection","description":"Triggers an on-demand execution of the datalayer sync for the consumer's connection. Requires the datalayer to be configured for the connection's vertical and the sync enabled.","operationId":"datalayer_refresh","parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Connection Id"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DatalayerRefreshBody"},{"type":"null"}],"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerResponse"}}}},"400":{"content":{"application/json":{"example":{"message":"The datalayer is not configured on this account.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The consumer or connection does not exist","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/connections/{connection_id}/disable_datalayer":{"post":{"tags":["Datalayer"],"summary":"Disable the datalayer sync for a connection","description":"Disables the datalayer sync for the consumer's connection so it stops refreshing. Requires the datalayer to be configured for the connection's vertical.","operationId":"datalayer_disable","parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Connection Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"content":{"application/json":{"example":{"message":"The datalayer is not configured on this account.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The consumer or connection does not exist","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/datastores":{"get":{"tags":["Datastores"],"summary":"Get list of datastores","description":"Returns a list of datastores (active and inactive) available for your account","operationId":"datastores_get_datastores","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/DatastoreStatus"},{"type":"null"}],"title":"Status"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataStoreItem"},"title":"Response Datastores Get Datastores"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/datastore/{datastoreid}/data":{"get":{"tags":["Consumers"],"summary":"Get execution data for a specific consumer and a specific datastore","description":"Returns execution data related to a consumer and a datastore. Queryparams can be used to filter the restuls by datastore column or by executionid","operationId":"datastores_get_consumer_and_datastoredata","parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"datastoreid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Datastoreid"}},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Date To"}},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Date From"}},{"name":"executionid","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Executionid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataItemOut"},"title":"Response Datastores Get Consumer And Datastoredata"}}}},"404":{"content":{"application/json":{"example":{"message":"The datastore does not exist","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Consumers"],"summary":"Add data into a datastore for a consumer","description":"Endpoint that can be used to add data into a datastore for a specific consumer","operationId":"datastores_create_consumer_datastoredata","parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"datastoreid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Datastoreid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataItem"},"title":"Datas"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataItemOut"},"title":"Response Datastores Create Consumer Datastoredata"}}}},"404":{"content":{"application/json":{"example":{"message":"The datastore does not exist","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"content":{"application/json":{"example":{"message":"The input does not match the definition of the datastore","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Unprocessable Entity"}}}},"/consumers/{consumer_id}/datastore/{datastoreid}/data/{datastoredataid}":{"patch":{"tags":["Consumers"],"summary":"Update execution data for a specific consumer and a specific datastore","description":"Update and returns execution data related to a consumer and a datastore","operationId":"datastores_update_consumer_datastoredata","parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"datastoreid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Datastoreid"}},{"name":"datastoredataid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Datastoredataid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataItem"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataItemOut"}}}},"404":{"content":{"application/json":{"example":{"message":"The datastoredata does not exist","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"content":{"application/json":{"example":{"message":"The input does not match the definition of the datastore","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Unprocessable Entity"}}},"delete":{"tags":["Consumers"],"summary":"Delete execution data for a specific consumer and a specific datastore","description":"Delete execution data related to a consumer and a datastore","operationId":"datastores_delete_consumer_datastoredata","parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"datastoreid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Datastoreid"}},{"name":"datastoredataid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Datastoredataid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"content":{"application/json":{"example":{"message":"The datastoredata does not exist","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/issues":{"get":{"tags":["Issues"],"summary":"Get issues","description":"Returns a list of the issues of your account. Filters can be used to query specific results. Filters can be combined and are inclusive.","operationId":"issues_get_issues","parameters":[{"name":"created_on","in":"query","required":false,"schema":{"type":"string","format":"date","description":"The search query to filter issues by creation date.","title":"Created On"},"description":"The search query to filter issues by creation date."},{"name":"last_seen_on","in":"query","required":false,"schema":{"type":"string","format":"date","description":"The search query to filter issues by last seen date.","title":"Last Seen On"},"description":"The search query to filter issues by last seen date."},{"name":"error_code","in":"query","required":false,"schema":{"type":"string","description":"The search query to filter issues by error code.","title":"Error Code"},"description":"The search query to filter issues by error code."},{"name":"status","in":"query","required":false,"schema":{"$ref":"#/components/schemas/IssueStatus","description":"The search query to filter issues by issue status.","default":"all"},"description":"The search query to filter issues by issue status."},{"name":"level","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/IssueLevel"},{"type":"null"}],"description":"The search query to filter issues by issue level.","title":"Level"},"description":"The search query to filter issues by issue level."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IssueItem"},"title":"Response Issues Get Issues"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/issues":{"get":{"tags":["Issues"],"summary":"Get issues by consumer id","description":"Returns a list of the issues linked to specific consumer. Filters can be used to query specific results. Filters can be combined and are inclusive.","operationId":"issues_get_issues_by_consumer_id","parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","title":"Consumer Id"}},{"name":"created_on","in":"query","required":false,"schema":{"type":"string","format":"date","description":"The search query to filter issues by creation date.","title":"Created On"},"description":"The search query to filter issues by creation date."},{"name":"last_seen_on","in":"query","required":false,"schema":{"type":"string","format":"date","description":"The search query to filter issues by last seen date.","title":"Last Seen On"},"description":"The search query to filter issues by last seen date."},{"name":"error_code","in":"query","required":false,"schema":{"type":"string","description":"The search query to filter issues by error code.","title":"Error Code"},"description":"The search query to filter issues by error code."},{"name":"status","in":"query","required":false,"schema":{"$ref":"#/components/schemas/IssueStatus","description":"The search query to filter issues by issue status.","default":"all"},"description":"The search query to filter issues by issue status."},{"name":"level","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/IssueLevel"},{"type":"null"}],"description":"The search query to filter issues by issue level.","title":"Level"},"description":"The search query to filter issues by issue level."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IssueItem"},"title":"Response Issues Get Issues By Consumer Id"}}}},"404":{"content":{"application/json":{"example":{"message":"The consumer does not exist.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/issues/{issue_id}":{"get":{"tags":["Issues"],"summary":"Get details about one issue","description":"Returns one specific issue. This includes as well the list of events for this issue.","operationId":"issues_get_issue","parameters":[{"name":"issue_id","in":"path","required":true,"schema":{"type":"string","title":"Issue Id"}},{"name":"last_execution_only","in":"query","required":false,"schema":{"type":"boolean","description":"If true, only the events related to the last execution will be returned in the list of events.","default":false,"title":"Last Execution Only"},"description":"If true, only the events related to the last execution will be returned in the list of events."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtendedIssueItem"}}}},"404":{"content":{"application/json":{"example":{"message":"The issue does not exist.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/folders":{"get":{"tags":["Accounting","Folders"],"summary":"Get Folders","operationId":"accounting_get_folders","security":[{"mcp_auth":["accounting","accounting.read","accounting.folders","accounting.folders.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FolderItem"},"title":"Response Accounting Get Folders"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/folders/{folder_id}":{"get":{"tags":["Accounting","Folders"],"summary":"Get Folder","operationId":"accounting_get_folder","security":[{"mcp_auth":["accounting","accounting.read","accounting.folders","accounting.folders.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"folder_id","in":"path","required":true,"schema":{"type":"string","title":"Folder Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderItem"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/bookyears":{"get":{"tags":["Accounting","Book years"],"summary":"Get Bookyears","operationId":"accounting_get_bookyears","security":[{"mcp_auth":["accounting","accounting.read","accounting.bookyears","accounting.bookyears.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_BookYear_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/analytic-plans":{"get":{"tags":["Accounting","Analytic plans"],"summary":"Get Analytic Plans","operationId":"accounting_get_analytic_plans","security":[{"mcp_auth":["accounting","accounting.read","accounting.analytic_plans","accounting.analytic_plans.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_AnalyticPlanItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/schemes":{"get":{"tags":["Accounting","Schemes"],"summary":"Get schemes","description":"Get GL schemes existing in the accounting system. A scheme (e.g., RGS, SBR) provides a standardized classification structure for organizing accounts for reporting purposes.","operationId":"accounting_get_schemes","security":[{"mcp_auth":["accounting","accounting.read","accounting.schemes","accounting.schemes.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_SchemeItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/clients":{"post":{"tags":["Accounting","Clients"],"summary":"Create client","description":"Create a new client","operationId":"accounting_create_client","security":[{"mcp_auth":["accounting","accounting.clients"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."},{"name":"force_merge","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Force Merge"},"description":"Indicate the ID of the corresponding supplier in the accounting system. Accounting systems using 1 entity to handle clients/customers and suppliers will merge the existing supplier with the new client/customer (if the parameter is filled in with the ID of an existing supplier)."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientItemIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientItemOut"}}}},"400":{"content":{"application/json":{"examples":{"Invalid company_id":{"value":{"message":"The format of the company_id doesn't seem to be correct.","status":"error"}},"Invalid VAT Number":{"value":{"message":"The VAT number doesn't seem to be correct. Please remove dots and whitespaces. The expected format is the following BE0784930037","status":"error"}},"Client already exists":{"value":{"message":"A client/supplier already exist with the same code/id in the accounting system.","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Accounting","Clients"],"summary":"Get clients","description":"Returns a list of accounting clients","operationId":"accounting_get_clients","security":[{"mcp_auth":["accounting","accounting.read","accounting.clients","accounting.clients.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"},"description":"Filter based on the following fields: name, email, first_name, last_name, external_reference, vat and company_number"},{"name":"updated_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated After"},"description":"Retrieve clients created or updated after a specific datetime (e.g. 2023-01-31T15:00:00 for 31 of January 2023 at 3PM UTC). UTC is the only format that is supported on all connectors."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_ClientItemOut_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/clients/{client_id}":{"patch":{"tags":["Accounting","Clients"],"summary":"Update client","description":"Endpoint that gives the possibility to update an accounting client","operationId":"accounting_update_client","security":[{"mcp_auth":["accounting","accounting.clients"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"client_id","in":"path","required":true,"schema":{"type":"string","title":"Client Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientItemUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientItemOut"}}}},"400":{"content":{"application/json":{"examples":{"Invalid company_id":{"value":{"message":"The format of the company_id doesn't seem to be correct.","status":"error"}},"Invalid VAT Number":{"value":{"message":"The VAT number doesn't seem to be correct. Please remove dots and whitespaces. The expected format is the following: BE0784930037","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The client/supplier doesn't exist in the accounting system.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Accounting","Clients"],"summary":"Get one client","description":"Returns a specific accounting client","operationId":"accounting_get_client","security":[{"mcp_auth":["accounting","accounting.read","accounting.clients","accounting.clients.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"client_id","in":"path","required":true,"schema":{"type":"string","title":"Client Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientItemOut"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The client/supplier doesn't exist in the accounting system.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/suppliers":{"post":{"tags":["Accounting","Suppliers"],"summary":"Create supplier","description":"Create a new supplier","operationId":"accounting_create_supplier","security":[{"mcp_auth":["accounting","accounting.suppliers"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."},{"name":"force_merge","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Force Merge"},"description":"Indicate the ID of the corresponding client/customer in the accounting system. Accounting systems using 1 entity to handle clients/customers and suppliers will merge the existing client/customer with the new supplier (if the parameter is filled in with the ID of an existing client/customer)."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierItemIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierItemOut"}}}},"400":{"content":{"application/json":{"examples":{"Invalid company_id":{"value":{"message":"The format of the company_id doesn't seem to be correct.","status":"error"}},"Invalid VAT Number":{"value":{"message":"The VAT number doesn't seem to be correct. Please remove dots and whitespaces. The expected format is the following: BE0784930037","status":"error"}},"Supplier already exists":{"value":{"message":"A client/supplier already exist with the same code/id in the accounting system.","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Accounting","Suppliers"],"summary":"Get suppliers","description":"Returns a list of accounting suppliers","operationId":"accounting_get_suppliers","security":[{"mcp_auth":["accounting","accounting.read","accounting.suppliers","accounting.suppliers.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"},"description":"Filter based on the following fields: name, email, first_name, last_name, external_reference, vat and company_number"},{"name":"updated_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated After"},"description":"Retrieve suppliers created or updated after a specific datetime (e.g. 2023-01-31T15:00:00 for 31 of January 2023 at 3PM UTC). UTC is the only format that is supported on all connectors."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_SupplierItemOut_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/suppliers/{supplier_id}":{"patch":{"tags":["Accounting","Suppliers"],"summary":"Update one supplier","description":"Update an accounting supplier","operationId":"accounting_update_supplier","security":[{"mcp_auth":["accounting","accounting.suppliers"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"supplier_id","in":"path","required":true,"schema":{"type":"string","title":"Supplier Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierItemUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierItemOut"}}}},"400":{"content":{"application/json":{"examples":{"Invalid company_id":{"value":{"message":"The format of the company_id doesn't seem to be correct.","status":"error"}},"Invalid VAT Number":{"value":{"message":"The VAT number doesn't seem to be correct. Please remove dots and whitespaces. The expected format is the following: BE0784930037","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The client/supplier doesn't exist in the accounting system.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Accounting","Suppliers"],"summary":"Get one supplier","description":"Returns one accounting supplier","operationId":"accounting_get_supplier","security":[{"mcp_auth":["accounting","accounting.read","accounting.suppliers","accounting.suppliers.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"supplier_id","in":"path","required":true,"schema":{"type":"string","title":"Supplier Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierItemOut"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The client/supplier doesn't exist in the accounting system.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/contacts":{"get":{"tags":["Accounting","Contacts"],"summary":"Get contacts of a partner","description":"Returns contacts of a specific client or supplier","operationId":"accounting_get_partner_contacts","security":[{"mcp_auth":["accounting","accounting.read","accounting.contacts","accounting.contacts.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."},{"name":"partner_type","in":"query","required":true,"schema":{"$ref":"#/components/schemas/PartnerType-Input"}},{"name":"partner_id","in":"query","required":true,"schema":{"type":"string","title":"Partner Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_ContactItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The partner doesn't exist in the accounting system.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/invoices":{"post":{"tags":["Accounting","Invoices"],"summary":"Create sale/purchase entry","description":"Create a new sale/purchase accounting entry","operationId":"accounting_create_invoice","security":[{"mcp_auth":["accounting","accounting.invoices"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."},{"name":"force_financial_period","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Force Financial Period"},"description":"Forces financial period in which the invoice must be created. This will create the invoice in the forced financial period rather than the current period. The format is: mmYYYY."},{"name":"regroup_lines","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BoolParam"},{"type":"null"}],"default":"true","title":"Regroup Lines"},"description":"Allow to regroup invoice lines by account number, tax code and analytic account in the accounting system."},{"name":"ignore_accounting_id","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Ignore Accounting Id"},"description":"If set to true, Chift will not wait for the invoice to be processed to return, use this when you do not need the ID in the return value.Note that this might also change the output of the call."},{"name":"force_currency_exchange","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"title":"Force Currency Exchange"},"description":"Boolean flag indicating whether to force the use of the provided currency exchange rate instead of the rate used by the accounting software. "}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceItemInMonoAnalyticPlan"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceItemOutMonoAnalyticPlan"}}}},"400":{"content":{"application/json":{"examples":{"Invalid VAT Code":{"value":{"message":"The format of the VAT Code doesn't seem to be correct.","status":"error"}},"Invalid journal Id":{"value":{"message":"The format of the journal_id doesn't seem to be correct.","status":"error"}},"Invalid analytic account":{"value":{"message":"The format of the analytic account doesn't seem to be correct.","status":"error"}},"Unsupported date":{"value":{"message":"The accounting system is not set up for this invoice date.","status":"error"}},"Invalid journal scope":{"value":{"message":"The journal cannot be used with this type of invoice.","status":"error"}},"Duplicate invoice number":{"value":{"message":"The invoice number is already used in the accounting system.","status":"error"}},"Invoice number too long":{"value":{"message":"The invoice number has a maximal length of 8 characters in the accounting system. (Only applicable to Winbooks).","status":"error"}},"Invalid untaxed amount":{"value":{"message":"You cannot create an invoice with an untaxed amount of 0.","status":"error"}},"Invoice couldn't be created":{"value":{"message":"The invoice couldn't be created in the accounting system.","status":"error"}},"No invoice lines":{"value":{"message":"Please add at least one invoice line.","status":"error"}},"Invalid forced financial period":{"value":{"message":"The forced financial period must be must be 6 numbers (e.g. 02 for february and 20222 => 022022)","status":"error"}},"Invalid PDF":{"value":{"message":"The document is not a valid base64 string representing a PDF.","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"examples":{"VAT Code not found":{"value":{"message":"The Tax Code doens't exist in the accounting system.","status":"error"}},"Journal not found":{"value":{"message":"The journal doesn't exist in the accounting system","status":"error"}},"Multiple journals found":{"value":{"message":"Multiple journals were found. Please indicate the wanted journal in the request.","status":"error"}},"Partner not found":{"value":{"message":"The partner doesn't exist in the accounting system.","status":"error"}},"Account not found":{"value":{"message":"The account number 'x' doesn't exist in the accounting system.","status":"error"}},"Analytic account not found":{"value":{"message":"The analytic account 'x' doesn't exist in the accounting system.","status":"error"}},"Analytic plan not found":{"value":{"message":"The analytic plan doesn't exist in the accounting system.","status":"error"}},"Currency not found":{"value":{"message":"The currency 'x' doesn't exist in the accounting system","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/invoices/multi-analytic-plans":{"post":{"tags":["Accounting","Invoices"],"summary":"Create sale/purchase entry (Multiple plans)","description":"Create a new sale/purchase entry with multiple analytic plans in the accounting","operationId":"accounting_create_invoice_multiple_plans","security":[{"mcp_auth":["accounting","accounting.invoices"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."},{"name":"force_financial_period","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Force Financial Period"},"description":"Forces financial period in which the invoice must be created. This will create the invoice in the forced financial period rather than the current period. The format is: mmYYYY."},{"name":"regroup_lines","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BoolParam"},{"type":"null"}],"default":"true","title":"Regroup Lines"},"description":"Regroup lines by account number, tax code and analytic distribution in the accounting system."},{"name":"ignore_accounting_id","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Ignore Accounting Id"},"description":"If set to true, Chift will not wait for the invoice to be processed to return, use this when you do not need the ID in the return value.Note that this might also change the output of the call."},{"name":"force_currency_exchange","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"title":"Force Currency Exchange"},"description":"Boolean flag indicating whether to force the use of the provided currency exchange rate instead of the rate used by the accounting software. "}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceItemInMultiAnalyticPlans"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceItemOutMultiAnalyticPlans"}}}},"400":{"content":{"application/json":{"examples":{"Invalid VAT Code":{"value":{"message":"The format of the VAT Code doesn't seem to be correct.","status":"error"}},"Invalid journal Id":{"value":{"message":"The format of the journal_id doesn't seem to be correct.","status":"error"}},"Invalid analytic account":{"value":{"message":"The format of the analytic account doesn't seem to be correct.","status":"error"}},"Unsupported date":{"value":{"message":"The accounting system is not set up for this invoice date.","status":"error"}},"Invalid journal scope":{"value":{"message":"The journal cannot be used with this type of invoice.","status":"error"}},"Duplicate invoice number":{"value":{"message":"The invoice number is already used in the accounting system.","status":"error"}},"Invoice number too long":{"value":{"message":"The invoice number has a maximal length of 8 characters in the accounting system. (Only applicable to Winbooks).","status":"error"}},"Invalid untaxed amount":{"value":{"message":"You cannot create an invoice with an untaxed amount of 0.","status":"error"}},"Invoice couldn't be created":{"value":{"message":"The invoice couldn't be created in the accounting system.","status":"error"}},"No invoice lines":{"value":{"message":"Please add at least one invoice line.","status":"error"}},"Invalid forced financial period":{"value":{"message":"The forced financial period must be must be 6 numbers (e.g. 02 for february and 20222 => 022022)","status":"error"}},"Invalid PDF":{"value":{"message":"The document is not a valid base64 string representing a PDF.","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"examples":{"VAT Code not found":{"value":{"message":"The Tax Code doens't exist in the accounting system.","status":"error"}},"Journal not found":{"value":{"message":"The journal doesn't exist in the accounting system","status":"error"}},"Multiple journals found":{"value":{"message":"Multiple journals were found. Please indicate the wanted journal in the request.","status":"error"}},"Partner not found":{"value":{"message":"The partner doesn't exist in the accounting system.","status":"error"}},"Account not found":{"value":{"message":"The account number 'x' doesn't exist in the accounting system.","status":"error"}},"Analytic account not found":{"value":{"message":"The analytic account 'x' doesn't exist in the accounting system.","status":"error"}},"Analytic plan not found":{"value":{"message":"The analytic plan doesn't exist in the accounting system.","status":"error"}},"Currency not found":{"value":{"message":"The currency 'x' doesn't exist in the accounting system","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/invoices/type/{invoice_type}":{"get":{"tags":["Accounting","Invoices"],"summary":"Get invoices by type (sale/purchase entries)","description":"Returns a list of invoices by a specific type (=sale/purchase entries). Each line of the invoice will include the analytic account linked to default analytic plan. Optionally dates can be defined to retrieve invoice from a certain date to another date","operationId":"accounting_get_invoices_by_type","security":[{"mcp_auth":["accounting","accounting.read","accounting.invoices","accounting.invoices.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"invoice_type","in":"path","required":true,"schema":{"$ref":"#/components/schemas/InvoiceType"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"}},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date To"}},{"name":"journal_ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Journal Ids"},"description":"Journal Ids used to filter the invoices. The Ids are separated by ','"},{"name":"include_payments","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BoolParam"},{"type":"null"}],"default":"false","title":"Include Payments"},"description":"Indicate if payments linked to the invoices should be included in the response. By default payments are not included and the field payments is null."},{"name":"payment_status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/PaymentStatus"},{"type":"null"}],"default":"all","title":"Payment Status"},"description":"Extra filter to retrieve invoices with a specific payment status."},{"name":"updated_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated After"},"description":"Retrieve invoices created or updated after a specific datetime (e.g. 2023-01-31T15:00:00 for 31 of January 2023 at 3PM UTC). UTC is the only format that is supported on all connectors."},{"name":"include_invoice_lines","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BoolParam"},{"type":"null"}],"default":"false","title":"Include Invoice Lines"},"description":"Indicate if invoice lines should be included in the response. By default invoice lines are not included when this requires extra requests on the target API."},{"name":"include_partner_info","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BoolParam"},{"type":"null"}],"default":"false","title":"Include Partner Info"},"description":"Indicate if partner (client/supplier) information should be included in the response. By default partner information is not included when it requires extra requests on the target API to be retrieved."},{"name":"approval_status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/InvoiceApprovalStatusFilter"},{"type":"null"}],"title":"Approval Status"},"description":"Filter invoices by approval status."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_InvoiceItemOutMonoAnalyticPlan_"}}}},"400":{"content":{"application/json":{"example":{"message":"You must provide an invoice type.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/invoices/multi-analytic-plans/type/{invoice_type}":{"get":{"tags":["Accounting","Invoices"],"summary":"Get invoices by type (sale/purchase entries - Multiple Analytic Plans)","description":"Returns a list of invoices by a specific type (=sale/purchase entries) with invoice lines including multiple analytic plans. Optionally dates can be defined to retrieve invoice from a certain date to another date","operationId":"accounting_get_invoices_by_type_multi_analytic_plans","security":[{"mcp_auth":["accounting","accounting.read","accounting.invoices","accounting.invoices.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"invoice_type","in":"path","required":true,"schema":{"$ref":"#/components/schemas/InvoiceType"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"}},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date To"}},{"name":"journal_ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Journal Ids"},"description":"Journal Ids used to filter the invoices. The Ids are separated by ','"},{"name":"include_payments","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BoolParam"},{"type":"null"}],"default":"false","title":"Include Payments"},"description":"Indicate if payments linked to the invoices should be included in the response. By default payments are not included and the field payments is null."},{"name":"payment_status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/PaymentStatus"},{"type":"null"}],"default":"all","title":"Payment Status"},"description":"Extra filter to retrieve invoices with a specific payment status."},{"name":"updated_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated After"},"description":"Retrieve invoices created or updated after a specific datetime (e.g. 2023-01-31T15:00:00 for 31 of January 2023 at 3PM UTC). UTC is the only format that is supported on all connectors."},{"name":"include_invoice_lines","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BoolParam"},{"type":"null"}],"default":"false","title":"Include Invoice Lines"},"description":"Indicate if invoice lines should be included in the response. By default invoice lines are not included when this requires extra requests on the target API."},{"name":"include_partner_info","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BoolParam"},{"type":"null"}],"default":"false","title":"Include Partner Info"},"description":"Indicate if partner (client/supplier) information should be included in the response. By default partner information is not included when it requires extra requests on the target API to be retrieved."},{"name":"approval_status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/InvoiceApprovalStatusFilter"},{"type":"null"}],"title":"Approval Status"},"description":"Filter invoices by approval status."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_InvoiceItemOutMultiAnalyticPlans_"}}}},"400":{"content":{"application/json":{"example":{"message":"You must provide an invoice type.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/invoices/{invoice_id}":{"get":{"tags":["Accounting","Invoices"],"summary":"Get one invoice (sale/purchase entry)","description":"Returns a specific invoice (sale/purchase entry). Each line will include the analytic account linked to default analytic plan","operationId":"accounting_get_invoice","security":[{"mcp_auth":["accounting","accounting.read","accounting.invoices","accounting.invoices.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"invoice_id","in":"path","required":true,"schema":{"type":"string","title":"Invoice Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."},{"name":"include_payments","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BoolParam"},{"type":"null"}],"default":"false","title":"Include Payments"},"description":"Indicate if payments linked to the invoice should be included in the response. By default payments are not included and the field payments is null."},{"name":"include_invoice_lines","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BoolParam"},{"type":"null"}],"default":"false","title":"Include Invoice Lines"},"description":"Indicate if invoice lines should be included in the response. By default invoice lines are not included when this requires extra requests on the target API."},{"name":"include_partner_info","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BoolParam"},{"type":"null"}],"default":"false","title":"Include Partner Info"},"description":"Indicate if partner (client/supplier) information should be included in the response. By default partner information is not included when it requires extra requests on the target API to be retrieved."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceItemOutMonoAnalyticPlan"}}}},"400":{"content":{"application/json":{"example":{"message":"The ID of the invoice doesn't have the correct format.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The invoice doesn't exist in the accounting system.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/invoices/multi-analytic-plans/{invoice_id}":{"get":{"tags":["Accounting","Invoices"],"summary":"Get one invoice (sale/purchase entry - Multiple Analytic Plans)","description":"Returns a specific invoice (=sale/purchase entry) with invoice lines /oincluding multiple analytic plans","operationId":"accounting_get_invoice_multi_analytic_plans","security":[{"mcp_auth":["accounting","accounting.read","accounting.invoices","accounting.invoices.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"invoice_id","in":"path","required":true,"schema":{"type":"string","title":"Invoice Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."},{"name":"include_payments","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BoolParam"},{"type":"null"}],"default":"false","title":"Include Payments"},"description":"Indicate if payments linked to the invoice should be included in the response. By default payments are not included and the field payments is null."},{"name":"include_invoice_lines","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BoolParam"},{"type":"null"}],"default":"false","title":"Include Invoice Lines"},"description":"Indicate if invoice lines should be included in the response. By default invoice lines are not included when this requires extra requests on the target API."},{"name":"include_partner_info","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BoolParam"},{"type":"null"}],"default":"false","title":"Include Partner Info"},"description":"Indicate if partner (client/supplier) information should be included in the response. By default partner information is not included when it requires extra requests on the target API to be retrieved."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceItemOutMultiAnalyticPlans"}}}},"400":{"content":{"application/json":{"example":{"message":"The ID of the invoice doesn't have the correct format.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The invoice doesn't exist in the accounting system.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/analytic-accounts":{"post":{"tags":["Accounting","Analytic accounts"],"summary":"Create analytic account","description":"Create a new analytic account in the default analytic plan","operationId":"accounting_create_analytic_account","security":[{"mcp_auth":["accounting","accounting.analytic_accounts"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticAccountItemIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticAccountItemOut"}}}},"400":{"content":{"application/json":{"example":{"message":"An analytic account already exists with the same code in the accounting system.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Accounting","Analytic accounts"],"summary":"Get analytic accounts","description":"Returns all analytic accounts of the default analytic plan","operationId":"accounting_get_analytic_accounts","security":[{"mcp_auth":["accounting","accounting.read","accounting.analytic_accounts","accounting.analytic_accounts.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_AnalyticAccountItemOut_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/analytic-accounts/multi-analytic-plans/{analytic_plan}":{"post":{"tags":["Accounting","Analytic accounts"],"summary":"Create analytic account (Multiple Analytic Plans)","description":"Create a new analytic account in a specific analytic plan","operationId":"accounting_create_analytic_account_multi_plans","security":[{"mcp_auth":["accounting","accounting.analytic_accounts"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"analytic_plan","in":"path","required":true,"schema":{"type":"string","title":"Analytic Plan"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticAccountItemIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticAccountItemOutMultiAnalyticPlans"}}}},"400":{"content":{"application/json":{"example":{"message":"An analytic account already exists with the same code in the accounting system.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/analytic-accounts/{analytic_account_id}":{"patch":{"tags":["Accounting","Analytic accounts"],"summary":"Update analytic account","description":"Update one specific analytic account in the default analytic plan","operationId":"accounting_update_analytic_account","security":[{"mcp_auth":["accounting","accounting.analytic_accounts"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"analytic_account_id","in":"path","required":true,"schema":{"type":"string","title":"Analytic Account Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticAccountItemUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticAccountItemOut"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The analytic account doesn't exist in the accounting system.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Accounting","Analytic accounts"],"summary":"Get analytic account","description":"Returns one specific analytic account of the default analytic plan","operationId":"accounting_get_analytic_account","security":[{"mcp_auth":["accounting","accounting.read","accounting.analytic_accounts","accounting.analytic_accounts.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"analytic_account_id","in":"path","required":true,"schema":{"type":"string","title":"Analytic Account Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticAccountItemOut"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The analytic account doesn't exist in the accounting system.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/analytic-accounts/{analytic_account_id}/multi-analytic-plans/{analytic_plan}":{"patch":{"tags":["Accounting","Analytic accounts"],"summary":"Update analytic account (Multiple Analytic Plans)","description":"Update one specific analytic account in a specific analytic plan","operationId":"accounting_update_analytic_account_multi_plans","security":[{"mcp_auth":["accounting","accounting.analytic_accounts"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"analytic_account_id","in":"path","required":true,"schema":{"type":"string","title":"Analytic Account Id"}},{"name":"analytic_plan","in":"path","required":true,"schema":{"type":"string","title":"Analytic Plan"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticAccountItemUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticAccountItemOutMultiAnalyticPlans"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The analytic account doesn't exist in the accounting system.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Accounting","Analytic accounts"],"summary":"Get analytic account (Multiple Analytic Plans)","description":"Returns one specific analytic account of a specific analytic plan","operationId":"accounting_get_analytic_account_multi_plans","security":[{"mcp_auth":["accounting","accounting.read","accounting.analytic_accounts","accounting.analytic_accounts.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"analytic_account_id","in":"path","required":true,"schema":{"type":"string","title":"Analytic Account Id"}},{"name":"analytic_plan","in":"path","required":true,"schema":{"type":"string","title":"Analytic Plan"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticAccountItemOutMultiAnalyticPlans"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The analytic account doesn't exist in the accounting system.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/analytic-accounts/multi-analytic-plans":{"get":{"tags":["Accounting","Analytic accounts"],"summary":"Get analytic accounts (Multiple Analytic Plans)","description":"Returns all analytic accounts of all analytic plans","operationId":"accounting_get_analytic_accounts_multi_plans","security":[{"mcp_auth":["accounting","accounting.read","accounting.analytic_accounts","accounting.analytic_accounts.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_AnalyticAccountItemOutMultiAnalyticPlans_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/journal/entries":{"get":{"tags":["Accounting","Journal entries"],"summary":"Get journal entries","description":"Returns a list of journal entries. Each item will include the analytic account linked to default analytic plan. Optionally, you can retrieve journal entries linked to a specific client/supplier using the partner_id parameter. When retrieving entries linked to a specific client/supplier, some journal items of an entry (e.g. a miscellaneous operation) could be excluding resulting in an unbalanced journal entry.","operationId":"accounting_get_journal_entries","security":[{"mcp_auth":["accounting","accounting.read","accounting.journal_entries","accounting.journal_entries.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."},{"name":"unposted_allowed","in":"query","required":true,"schema":{"$ref":"#/components/schemas/BoolParam"}},{"name":"journal_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Journal Id"},"description":"Journal ID used to filter journal entries to only retrieve entries for a specific journal. This is an optional filter parameter."},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"},"description":"Accounting date from which the journal entries will be retrieved (this date will be included in the response). This parameter is mandatory if the 'updated_after' parameter is not provided."},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date To"},"description":"Accounting date until which the journal entries will be retrieved (this date will be included in the response). This parameter is mandatory if the 'updated_after' parameter is not provided."},{"name":"updated_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated After"},"description":"When provided only journal entries modified or created after this datetime will be retrieved (this datetime will NOT be included in the response). E.g. 2023-01-31T15:00:00 for 31 of January 2023 at 3PM UTC, UTC is the only format that is supported on all connectors."},{"name":"partner_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_JournalEntryMonoAnalyticPlan_"}}}},"400":{"content":{"application/json":{"example":{"message":"You can retrieve maximum 3 months of data at once. The difference between 'date_from' and 'date_to' is at maximum 3 months when 'updated_after' parameter is not provided.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/journal/entries/multi-analytic-plans":{"get":{"tags":["Accounting","Journal entries"],"summary":"Get journal entries (Multiple Analytic Plans)","description":"Returns a list of journal entries with invoice items including multiple analytic plan.Optionally, you can retrieve journal entries linked to a specific client/supplier using the partner_id parameter. When retrieving entries linked to a specific client/supplier, some journal items of an entry (e.g. a miscellaneous operation) could be excluding resulting in an unbalanced journal entry.","operationId":"accounting_get_journal_entries_multi_plan","security":[{"mcp_auth":["accounting","accounting.read","accounting.journal_entries","accounting.journal_entries.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."},{"name":"unposted_allowed","in":"query","required":true,"schema":{"$ref":"#/components/schemas/BoolParam"}},{"name":"journal_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Journal Id"},"description":"Journal ID used to filter journal entries to only retrieve entries for a specific journal. This is an optional filter parameter."},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"},"description":"Accounting date from which the journal entries will be retrieved (this date will be included in the response). This parameter is mandatory if the 'updated_after' parameter is not provided."},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date To"},"description":"Accounting date until which the journal entries will be retrieved (this date will be included in the response).This parameter is mandatory if the 'updated_after' parameter is not provided."},{"name":"updated_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated After"},"description":"When provided only journal entries modified or created after this datetime will be retrieved (this datetime will NOT be included in the response). E.g. 2023-01-31T15:00:00 for 31 of January 2023 at 3PM UTC, UTC is the only format that is supported on all connectors."},{"name":"partner_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_JournalEntryMultiAnalyticPlan_"}}}},"400":{"content":{"application/json":{"example":{"message":"You can retrieve maximum 3 months of data at once. The difference between 'date_from' and 'date_to' is at maximum 3 months when 'updated_after' parameter is not provided.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/journal/entries/{journal_entry_id}":{"get":{"tags":["Accounting","Journal entries"],"summary":"Get one journal entry","description":"Returns a single journal entry by ID.","operationId":"accounting_get_journal_entry","security":[{"mcp_auth":["accounting","accounting.read","accounting.journal_entries","accounting.journal_entries.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"journal_entry_id","in":"path","required":true,"schema":{"type":"string","title":"Journal Entry Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JournalEntryMultiAnalyticPlan"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The entry doesn't exist in the accounting system.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/journal-entries":{"post":{"tags":["Accounting","Journal entries"],"summary":"Create Journal Entry","description":"Create a new Journal Entry in the accounting system","operationId":"accounting_create_generic_journal_entry","security":[{"mcp_auth":["accounting","accounting.journal_entries"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."},{"name":"force_currency_exchange","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BoolParam"},{"type":"null"}],"default":"false","title":"Force Currency Exchange"},"description":"Boolean flag indicating whether to force the use of the provided currency exchange rate instead of the rate used by the accounting software. "},{"name":"ignore_accounting_id","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Ignore Accounting Id"},"description":"If set to true, Chift will not wait for the invoice to be processed to return, use this when you do not need the ID in the return value.Note that this might also change the output of the call."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericJournalEntry"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JournalEntryMultiAnalyticPlan"}}}},"400":{"content":{"application/json":{"examples":{"Could not create entry (sage 100)":{"value":{"message":"The entry couldn't be created in the accounting system. The journal is already open via the Sage 100 interface.","status":"error"}},"Can not link entry to multiple partner":{"value":{"message":"A sale/purchase entry cannot be linked to multiple partner accounts.","status":"error"}},"Unbalanced entry":{"value":{"message":"The entry is not balanced.","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"examples":{"Unsupported journal":{"value":{"message":"Only entries in a sale or purchase journal can be created.","status":"error"}},"Journal not found":{"value":{"message":"The journal doesn't exist in the accounting system.","status":"error"}},"Account not found":{"value":{"message":"The account number doesn't exist in the accounting system.","status":"error"}},"Partner not found":{"value":{"message":"The client/supplier doesn't exist in the accounting system.","status":"error"}},"Currency not found":{"value":{"message":"The currency doesn't exist or is not active in the accounting system.","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"content":{"application/json":{"examples":{"Partner missing":{"value":{"message":"Please provide a client/supplier account in the partner_id field.","status":"error"}},"Invalid supplier":{"value":{"message":"The partner must be a supplier.","status":"error"}},"Invalid client":{"value":{"message":"The partner must be a client/customer.","status":"error"}},"Missing collective account":{"value":{"message":"Please provide a client/supplier collective account.","status":"error"}},"Missing product":{"value":{"message":"Please provide at least one charge/product account.","status":"error"}},"Invalid currency format":{"value":{"message":"The currency format is not correct. Please use the ISO 4217 codes.","status":"error"}},"Multi currency error":{"value":{"message":"Only one currency can be used.","status":"error"}},"Invalid exchange rates":{"value":{"message":"Exchange rates must be equal.","status":"error"}},"Debit/credit both negative":{"value":{"message":"Debit and credit cannot be negative.","status":"error"}},"Debit/credit no positive":{"value":{"message":"Debit or credit must be positive.","status":"error"}},"Debit/credit both positive":{"value":{"message":"Debit and credit cannot be both positive.","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Unprocessable Entity"}}}},"/consumers/{consumer_id}/accounting/invoices/id/{invoice_id}/payments":{"get":{"tags":["Accounting","Invoices"],"summary":"Get payments by invoice ID","description":"Get payments of a specific invoice based on its ID","operationId":"accounting_get_payments_by_invoice","security":[{"mcp_auth":["accounting","accounting.read","accounting.invoices","accounting.invoices.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"invoice_id","in":"path","required":true,"schema":{"type":"string","title":"Invoice Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_Payment_"}}}},"400":{"content":{"application/json":{"example":{"message":"The ID of the invoice doesn't have the correct format.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The given invoice doesn't exist in the accounting system.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/payment-methods":{"get":{"tags":["Accounting","Invoices"],"summary":"Get payment methods","description":"Get payment methods","operationId":"accounting_get_payment_methods","security":[{"mcp_auth":["accounting","accounting.read","accounting.invoices","accounting.invoices.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_AccountingPaymentMethod_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/invoices/payments":{"post":{"tags":["Accounting","Invoices"],"summary":"Create an invoice payment","description":"Create invoice payment","operationId":"accounting_create_invoice_payment","security":[{"mcp_auth":["accounting","accounting.invoices"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingInvoicePaymentIn"}}}},"responses":{"204":{"description":"Successful Response"},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/payment-terms":{"get":{"tags":["Accounting","Invoices"],"summary":"Get payment terms","description":"Get payment terms","operationId":"accounting_get_payment_terms","security":[{"mcp_auth":["accounting","accounting.read","accounting.invoices","accounting.invoices.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_AccountingPaymentTerms_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/journals":{"get":{"tags":["Accounting","Journals"],"summary":"Get journals","description":"Get journals existing in the accounting system","operationId":"accounting_get_journals","security":[{"mcp_auth":["accounting","accounting.read","accounting.journals","accounting.journals.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_Journal_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/journal":{"post":{"tags":["Accounting","Journals"],"summary":"Create journal","description":"Create a journal in the accounting system","operationId":"accounting_create_journal","security":[{"mcp_auth":["accounting","accounting.journals"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JournalIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Journal"}}}},"400":{"content":{"application/json":{"example":{"message":"A journal already exists with the same code in the accounting system.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The counterpart account doesn't exist in the accounting system.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/vat-codes":{"get":{"tags":["Accounting","VAT codes"],"summary":"Get vat codes","description":"Get vat codes existing in the accounting system","operationId":"accounting_get_vat_codes","security":[{"mcp_auth":["accounting","accounting.read","accounting.vat_codes","accounting.vat_codes.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_AccountingVatCode_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/miscellaneous-operation":{"post":{"tags":["Accounting","Miscellaneous operations"],"summary":"Create miscellaneous operation","description":"Create a new miscellaneous operation","operationId":"accounting_create_miscellaneous_operation","security":[{"mcp_auth":["accounting","accounting.miscellaneous_operations"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MiscellaneousOperationIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MiscellaneousOperationOut"}}}},"400":{"content":{"application/json":{"examples":{"Invalid journal_id":{"value":{"message":"The format of the journal_id doesn't seem to be correct.","status":"error"}},"Invalid analytic account":{"value":{"message":"The format of the analytic account doesn't seem to be correct.","status":"error"}},"Invalid partner_id":{"value":{"message":"The format of the field 'partner_id' doesn't seem to be correct.","status":"error"}},"No lines":{"value":{"message":"Please add at least one line.","status":"error"}},"Unbalanced operation":{"value":{"message":"The operation is not balanced. The sum of the lines must be zero.","status":"error"}},"Missing partner_id":{"value":{"message":"A lines of type 'customer_account' or 'supplier_account' must have a 'partner_id' filled in.","status":"error"}},"Journal wrong scope":{"value":{"message":"The given journal cannot be used with this type of operation.","status":"error"}},"Account wrong scope":{"value":{"message":"The account 'x' cannot be used for this type of line.","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"examples":{"Journal not found":{"value":{"message":"The journal doesn't exist in the accounting system.","status":"error"}},"Multiple journals found":{"value":{"message":"Multiple journals were found. Please indicate the wanted journal in the request.","status":"error"}},"Partner not found":{"value":{"message":"The client/supplier doesn't exist in the accounting system.","status":"error"}},"Account not found":{"value":{"message":"The account number 'x' doesn't exist in the accounting system.","status":"error"}},"Analytic account not found":{"value":{"message":"The analytic account 'x' doesn't exist in the accounting system.","status":"error"}},"Currency not found":{"value":{"message":"The currency 'x' doesn't exist in the accounting system.","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Accounting","Miscellaneous operations"],"summary":"Get miscellaneous operations","description":"Get miscellaneous operations from the the accounting system","operationId":"accounting_get_miscellaneous_operations","security":[{"mcp_auth":["accounting","accounting.read","accounting.miscellaneous_operations","accounting.miscellaneous_operations.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"}},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date To"}},{"name":"journal_ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Journal Ids"},"description":"Journal Ids used to filter the invoices. The Ids are separed by ','"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_MiscellaneousOperationOut_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/miscellaneous-operation/{operation_id}":{"get":{"tags":["Accounting","Miscellaneous operations"],"summary":"Get one miscellaneous operation","description":"Get a specific miscellaneous operation from the the accounting system","operationId":"accounting_get_miscellaneous_operation","security":[{"mcp_auth":["accounting","accounting.read","accounting.miscellaneous_operations","accounting.miscellaneous_operations.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"operation_id","in":"path","required":true,"schema":{"type":"string","title":"Operation Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MiscellaneousOperationOut"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/matching":{"post":{"tags":["Accounting","Journal entries"],"summary":"Match entries","description":"Match existing entries in the accounting system","operationId":"accounting_match_entries","security":[{"mcp_auth":["accounting","accounting.journal_entries"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchingIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchingOut"}}}},"400":{"content":{"application/json":{"examples":{"Invalid format":{"value":{"message":"The entries format doesn't seem to be correct.","status":"error"}},"Unbalanced entry":{"value":{"message":"The amounts of the entries are not balanced.","status":"error"}},"Already matched":{"value":{"message":"Entry 'x' is already matched in the accounting system.","status":"error"}},"Partner mismatch":{"value":{"message":"The entries have different clients/suppliers.","status":"error"}},"Entry missing account":{"value":{"message":"Entry 'x' doesn't have a receivable/payable account.","status":"error"}},"Entry missing partner":{"value":{"message":"Entry 'x' is not linked to a client/supplier.","status":"error"}},"Could not match":{"value":{"message":"An error occured during the matching process. Please retry again later.","status":"error"}},"Entry invalid status":{"value":{"message":"Entry 'x' doesn't have the correct status.","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"Entry 'x' doesn't exist in the accounting system.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/matching-multiple":{"post":{"tags":["Accounting","Journal entries"],"summary":"Match multiple entries","description":"Match existing entries in the accounting system","operationId":"accounting_match_entries_multiple","security":[{"mcp_auth":["accounting","accounting.journal_entries"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultipleMatchingIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MultipleMatchingOut"},"title":"Response Accounting Match Entries Multiple"}}}},"400":{"content":{"application/json":{"examples":{"Invalid format":{"value":{"message":"The entries format doesn't seem to be correct.","status":"error"}},"Unbalanced entry":{"value":{"message":"The amounts of the entries are not balanced.","status":"error"}},"Already matched":{"value":{"message":"Entry 'x' is already matched in the accounting system.","status":"error"}},"Partner mismatch":{"value":{"message":"The entries have different clients/suppliers.","status":"error"}},"Entry missing account":{"value":{"message":"Entry 'x' doesn't have a receivable/payable account.","status":"error"}},"Entry missing partner":{"value":{"message":"Entry 'x' is not linked to a client/supplier.","status":"error"}},"Could not match":{"value":{"message":"An error occured during the matching process. Please retry again later.","status":"error"}},"Entry invalid status":{"value":{"message":"Entry 'x' doesn't have the correct status.","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"Entry 'x' doesn't exist in the accounting system.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/attachments":{"get":{"tags":["Accounting","Attachments"],"summary":"Get attachments","description":"Returns the file content of all attachments linked to an accounting entry (invoice or journal entry). Use this endpoint when an invoice or journal entry has attachments_info.status set to 'yes_to_request'. Pass type=invoice and document_id={invoice_id} for invoices, or type=entry and document_id={entry_id} for journal entries. Each returned item contains a base64-encoded string of the file content (id and base64_string fields).","operationId":"accounting_get_attachments","security":[{"mcp_auth":["accounting","accounting.read","accounting.attachments","accounting.attachments.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."},{"name":"type","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DocumentType"}},{"name":"document_id","in":"query","required":true,"schema":{"type":"string","title":"Document Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_AttachmentItemOut_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/invoices/pdf/{invoice_id}":{"post":{"tags":["Accounting","Attachments"],"summary":"Attach a document (PDF)","description":"Attach a document (PDF) to the invoice entry","operationId":"accounting_add_attachment","security":[{"mcp_auth":["accounting","accounting.attachments"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"invoice_id","in":"path","required":true,"schema":{"type":"string","title":"Invoice Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."},{"name":"overwrite_existing","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BoolParam"},{"type":"null"}],"default":"false","title":"Overwrite Existing"},"description":"Indicate what to do if a document is already attched to the invoice."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentItem"}}}},"responses":{"204":{"description":"Successful Response"},"400":{"content":{"application/json":{"examples":{"Invalid PDF":{"value":{"message":"The document is not a vlaid base64 string representing a PDF.","status":"error"}},"Attachment already exists":{"value":{"message":"An attachmmend already exists for this invoice.","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The invoice doesn't exist in the accounting system.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/chart-of-accounts":{"get":{"tags":["Accounting","Ledger accounts"],"summary":"Get chart of accounts","description":"Get all accounts in the chart of accounts","operationId":"accounting_get_chart_of_accounts","security":[{"mcp_auth":["accounting","accounting.read","accounting.ledger_accounts","accounting.ledger_accounts.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."},{"name":"classes","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Classes"},"description":"Filter based on the class of the account (e.g. 6,7 to retrieve 6 and 7 account classes). The classes are separated by ','."},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/AccountTypeFilter"},{"type":"null"}],"title":"Type"},"description":"Filter based on the type of the account (e.g. bank, cash, income, expense, vat)."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_AccountItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/chart-of-accounts/balance":{"post":{"tags":["Accounting","Ledger accounts"],"summary":"Get the balance of accounts","description":"Get the balance of accounts in the accounting plan (chart of accounts) between specific months","operationId":"accounting_get_accounts_balances","security":[{"mcp_auth":["accounting","accounting.read","accounting.ledger_accounts","accounting.ledger_accounts.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountBalanceFilter"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_AccountBalance_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/bank-accounts":{"get":{"tags":["Accounting","Bank accounts"],"summary":"Get bank accounts","description":"Returns a list of bank accounts in the accounting system","operationId":"accounting_get_bank_accounts","security":[{"mcp_auth":["accounting","accounting.read","accounting.bank_accounts","accounting.bank_accounts.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_BankAccountItemOut_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Accounting","Bank accounts"],"summary":"Create bank account","description":"Create a new bank account in the accounting system","operationId":"accounting_create_bank_account","security":[{"mcp_auth":["accounting","accounting.bank_accounts"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountItemIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountItemOut"}}}},"400":{"content":{"application/json":{"example":{"message":"A bank account/journal already exists with the same code in the accounting system.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/bank-transactions":{"post":{"tags":["Accounting","Bank transactions"],"summary":"Create bank transactions","description":"Create new bank transactions","operationId":"accounting_create_bank_transactions","security":[{"mcp_auth":["accounting","accounting.bank_transactions"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankStatementItemIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankStatementItemOut"}}}},"400":{"content":{"application/json":{"example":{"message":"The format of the bank_statement_id doesn't seem to be correct.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/employees":{"get":{"tags":["Accounting","Employees"],"summary":"Get employees","description":"Returns a list of the employees linked to the company","operationId":"accounting_get_employees","security":[{"mcp_auth":["accounting","accounting.read","accounting.employees","accounting.employees.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_EmployeeItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/financial-entries":{"post":{"tags":["Accounting","Journal entries"],"summary":"Create a financial entry","description":"Create a new financial entry (Bank or Cash operation)","operationId":"accounting_create_financial_entries","security":[{"mcp_auth":["accounting","accounting.journal_entries"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."},{"name":"financial_counterpart_account","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Financial Counterpart Account"},"description":"Number of ledger account representing bank account in accounting. Required in cases where the connector does not allow direct linking of the ledger account representing the bank account and the journal representing the bank account, making it necessary to specify it here."},{"name":"force_currency_exchange","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"title":"Force Currency Exchange"},"description":"Boolean flag indicating whether to force the use of the provided currency exchange rate instead of the rate used by the accounting software. "},{"name":"ignore_accounting_id","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Ignore Accounting Id"},"description":"If set to true, Chift will not wait for the entry to be processed to return, use this when you do not need the ID in the return value.Note that this might also change the output of the call."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialEntryItemIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialEntryItemOut"}}}},"400":{"content":{"application/json":{"examples":{"Invalid Journal Id":{"value":{"message":"The format of the journal_id doesn't seem to be correct.","status":"error"}},"No items":{"value":{"message":"Please add at least one item.","status":"error"}},"Journal wrong scope":{"value":{"message":"The given journal cannot be used with this type of operation.","status":"error"}},"Account wrong scope":{"value":{"message":"The account 'x' cannot be used for this type of line.","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"examples":{"Journal not found":{"value":{"message":"The journal doesn't exist in the accounting system.","status":"error"}},"Partner not found":{"value":{"message":"The client/supplier/employee doesn't exist in the accounting system.","status":"error"}},"Account not found":{"value":{"message":"The account number 'x' doesn't exist in the accounting system.","status":"error"}},"Currency not found":{"value":{"message":"The currency 'x' doesn't exist in the accounting system.","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/expenses":{"post":{"tags":["Accounting","Expenses"],"summary":"Create an expense","description":"Create a new employee expense","operationId":"accounting_create_expense","security":[{"mcp_auth":["accounting","accounting.expenses"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseItemIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseItemOut"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/outstandings":{"get":{"tags":["Accounting","Outstanding"],"summary":"Get clients/suppliers outstanding items","description":"Returns a list of all clients/suppliers outstanding items","operationId":"accounting_get_outstandings","security":[{"mcp_auth":["accounting","accounting.read","accounting.outstandings","accounting.outstandings.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."},{"name":"type","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OutstandingType"}},{"name":"unposted_allowed","in":"query","required":true,"schema":{"$ref":"#/components/schemas/BoolParam"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_OutstandingItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/accounts":{"post":{"tags":["Accounting","Ledger accounts"],"summary":"Create ledger account","description":"Create a new ledger account in the chart of accounts","operationId":"accounting_create_ledger_account","security":[{"mcp_auth":["accounting","accounting.ledger_accounts"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerAccountItemIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountItem"}}}},"400":{"content":{"application/json":{"example":{"message":"A ledger account already exists with the same number in the accounting system.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/accounting/export-fec":{"get":{"tags":["Accounting","Exports"],"summary":"Export entries in FEC format","description":"Returns accounting entries according to the FEC format","operationId":"accounting_export_fec","security":[{"mcp_auth":["accounting","accounting.read","accounting.exports","accounting.exports.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id"},"description":"Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled."},{"name":"date_from","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Date From"},"description":"Start date for the FEC export."},{"name":"date_to","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Date To"},"description":"End date for the FEC export."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FECItemOut"},"title":"Response Accounting Export Fec"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pos/orders":{"get":{"tags":["Point of Sale","Orders"],"summary":"Get orders","description":"Returns a list of the orders","operationId":"pos_get_orders","security":[{"mcp_auth":["pos","pos.read","pos.orders","pos.orders.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"},"description":"Start date (inclusive) of the period to get orders from"},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date To"},"description":"End date (inclusive) of the period to get orders from"},{"name":"location_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Id"},"description":"Unique identifier of the location. If none passed, orders from all locations will be returned unless the location was selected by the end-user"},{"name":"state","in":"query","required":false,"schema":{"$ref":"#/components/schemas/States","default":"all"},"description":"State of the orders to get"},{"name":"closure_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Closure Id"},"description":"Unique identifier of the closure. If none passed, orders from all closures will be selected."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_POSOrderItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pos/orders/{order_id}":{"get":{"tags":["Point of Sale","Orders"],"summary":"Get one order","description":"Returns a single order","operationId":"pos_get_order","security":[{"mcp_auth":["pos","pos.read","pos.orders","pos.orders.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"order_id","in":"path","required":true,"schema":{"type":"string","title":"Order Id"},"description":"Unique identifier of the order"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSOrderItem"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"404":{"content":{"application/json":{"example":{"message":"The order with id {OrderId} could not be found","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Point of Sale","Orders"],"summary":"Update order","description":"Update one order","operationId":"pos_update_pos_customer","security":[{"mcp_auth":["pos","pos.orders"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"order_id","in":"path","required":true,"schema":{"type":"string","title":"Order Id"},"description":"Unique identifier of the order"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrderItem"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSOrderItem"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pos/locations":{"get":{"tags":["Point of Sale","Locations"],"summary":"Get locations","description":"Returns a list of the locations","operationId":"pos_get_locations","security":[{"mcp_auth":["pos","pos.read","pos.locations","pos.locations.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_POSLocationItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pos/payments":{"get":{"tags":["Point of Sale","Payments"],"summary":"Get payments","description":"Returns a list of payments","operationId":"pos_get_payments","security":[{"mcp_auth":["pos","pos.read","pos.payments","pos.payments.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"date_from","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Date From"},"description":"Start date (inclusive) of the period to get payments from"},{"name":"date_to","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Date To"},"description":"End date (inclusive) of the period to get payments from"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_POSPaymentItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pos/sales":{"get":{"tags":["Point of Sale","Orders"],"summary":"Get sales","description":"Returns the summary of the sales","operationId":"pos_get_sales","security":[{"mcp_auth":["pos","pos.read","pos.orders","pos.orders.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"date_from","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Date From"},"description":"Start date (inclusive) of the period to get sales from"},{"name":"date_to","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Date To"},"description":"End date (inclusive) of the period to get sales from"},{"name":"location_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Id"},"description":"Unique identifier of the location. If none passed, sales from all locations will be returned unless the location was selected by the end-user"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesItem"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pos/payment-methods":{"get":{"tags":["Point of Sale","Payment methods"],"summary":"Get payment methods (POS)","description":"Returns the list of payment methods (POS)","operationId":"pos_get_payments_methods","security":[{"mcp_auth":["pos","pos.read","pos.payment_methods","pos.payment_methods.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"location_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Id"},"description":"Unique identifier of the location If none passed, payment methods from all locations will be returned unless the location was selected by the end-user"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_PaymentMethods_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pos/customers":{"get":{"tags":["Point of Sale","customers","Customers"],"summary":"Get customers","description":"Returns the list of customers","operationId":"pos_get_customers","security":[{"mcp_auth":["pos","pos.read","pos.customers","pos.customers.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"},"description":"Filter based on other parameters than the email/phone, e.g. firstname, lastname"},{"name":"email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"description":"Filter based on email of customer"},{"name":"phone","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"description":"Filter based on phone of customer"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_POSCustomerItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Point of Sale","Customers"],"summary":"Create one customer","description":"Create a customer","operationId":"pos_create_pos_customer","security":[{"mcp_auth":["pos","pos.customers"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSCreateCustomerItem"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSCustomerItem"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pos/customers/{customer_id}":{"get":{"tags":["Point of Sale","customers","Customers"],"summary":"Get one customer","description":"Returns a specific customer","operationId":"pos_get_customer","security":[{"mcp_auth":["pos","pos.read","pos.customers","pos.customers.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","title":"Customer Id"},"description":"Unique identifier of the customer"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSCustomerItem"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"404":{"content":{"application/json":{"example":{"message":"The customer with id {CustomerId} could not be found","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pos/product-categories":{"get":{"tags":["Point of Sale","Categories"],"summary":"Get product categories","description":"Returns a list of product categories","operationId":"pos_get_product_categories","security":[{"mcp_auth":["pos","pos.read","pos.categories","pos.categories.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"location_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Id"},"description":"Unique identifier of the location. If none passed, product categories from all locations will be returned unless the location was selected by the end-user"},{"name":"only_parents","in":"query","required":false,"schema":{"$ref":"#/components/schemas/BoolParam","default":"false"},"description":"If true, only parent categories will be returned"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_ProductCategoryItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pos/products":{"get":{"tags":["Point of Sale","Products"],"summary":"Get products","description":"Returns a list of products","operationId":"pos_get_products","security":[{"mcp_auth":["pos","pos.read","pos.products","pos.products.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"location_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Id"},"description":"Unique identifier of the location. If none passed, products from all locations will be returned unless the location was selected by the end-user"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_POSProductItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pos/accounting-categories":{"get":{"tags":["Point of Sale","Categories"],"summary":"Get accounting categories","description":"Returns a list of accounting categories. When not available for a specific POS, it will return the same values as the product categories.","operationId":"pos_get_accounting_categories","security":[{"mcp_auth":["pos","pos.read","pos.categories","pos.categories.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"location_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Id"},"description":"Unique identifier of the location. If none passed, accounting categories from all locations will be returned unless the location was selected by the end-user"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_AccountingCategoryItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pos/tax-rates":{"get":{"tags":["Point of Sale","Taxes"],"summary":"Get tax rates (POS)","description":"Returns a list of the tax rates","operationId":"pos_get_taxes","security":[{"mcp_auth":["pos","pos.read","pos.taxes","pos.taxes.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_POSTaxRateItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pos/closures/{date}":{"get":{"tags":["Point of Sale","Closures"],"summary":"Get closure info for a specific day","description":"Returns whether the closure was already done for a specific day or not","operationId":"pos_get_closure","security":[{"mcp_auth":["pos","pos.read","pos.closure","pos.closure.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"date","in":"path","required":true,"schema":{"type":"string","format":"date","title":"Date"},"description":"Filter based on the date of the closure"},{"name":"location_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Id"},"description":"Unique identifier of the location. If none passed, closures from all locations will be returned unless the location was selected by the end-user"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosureItem"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pos/objectives":{"get":{"tags":["Point of Sale","Objectives"],"summary":"Get objectives","description":"Return the total amount and the tax amount for a specific period","operationId":"pos_get_objectives","security":[{"mcp_auth":["pos","pos.read","pos.objectives","pos.objectives.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"date_from","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Date From"},"description":"Start date (inclusive) of the period to get payments from"},{"name":"date_to","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Date To"},"description":"End date (inclusive) of the period to get payments from"},{"name":"location_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Id"},"description":"Unique identifier of the location. If none passed, objectives from all locations will be returned unless the location was selected by the end-user"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_ObjectivesItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pos/report":{"get":{"tags":["Point of Sale","Closures"],"summary":"Get report for a specific date (E-reporting)","description":"The endpoints returns the report for a specific date containing the required data for e-reporting","operationId":"pos_get_report","security":[{"mcp_auth":["pos","pos.read","pos.closure","pos.closure.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"date","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Date"},"description":"Filter based on the business date"},{"name":"location_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Id"},"description":"Unique identifier of the location. If none passed, we will use the selected location by the end-user. If no location was selected, we will return an error."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportItem"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/commerce/customers":{"get":{"tags":["eCommerce","Customers"],"summary":"Get all customers","description":"Returns a list of all the customers","operationId":"ecommerce_get_customers","security":[{"mcp_auth":["commerce","commerce.read","commerce.customers","commerce.customers.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_CommerceCustomerItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/commerce/customers/{customer_id}":{"get":{"tags":["eCommerce","Customers"],"summary":"Get one specific customer","description":"Returns a specific customer","operationId":"ecommerce_get_customer","security":[{"mcp_auth":["commerce","commerce.read","commerce.customers","commerce.customers.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommerceCustomerItem"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The customer doesn't exist.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/commerce/products":{"get":{"tags":["eCommerce","Products and variants"],"summary":"Get all products","description":"Returns a list of all the products","operationId":"ecommerce_get_products","security":[{"mcp_auth":["commerce","commerce.read","commerce.products_variants","commerce.products_variants.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"updated_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated After"},"description":"Retrieve products updated after a specific datetime (e.g. 2025-01-31T15:00:00 for 31 of January 2025 at 3PM UTC). UTC is the only format that is supported on all connectors."},{"name":"sku","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sku"},"description":"SKU of the product. Supports multiple values separated by comma"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_CommerceProductItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/commerce/products/{product_id}":{"get":{"tags":["eCommerce","Products and variants"],"summary":"Get one specific product","description":"Returns a specific product","operationId":"ecommerce_get_product","security":[{"mcp_auth":["commerce","commerce.read","commerce.products_variants","commerce.products_variants.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"product_id","in":"path","required":true,"schema":{"type":"string","title":"Product Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommerceProductItem"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The product doesn't exist.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/commerce/variants/{variant_id}":{"get":{"tags":["eCommerce","Products and variants"],"summary":"Get one specific product variant","description":"Returns a specific product variant","operationId":"ecommerce_get_variant","security":[{"mcp_auth":["commerce","commerce.read","commerce.products_variants","commerce.products_variants.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"variant_id","in":"path","required":true,"schema":{"type":"string","title":"Variant Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariantItem"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The variant doesn't exist.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/commerce/variants/set_quantity/{variant_id}":{"post":{"tags":["eCommerce","Products and variants"],"summary":"Update available quantity","description":"Update available quantity of a product variant in a specific location","operationId":"ecommerce_update_variant_quantity","security":[{"mcp_auth":["commerce","commerce.products_variants"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"variant_id","in":"path","required":true,"schema":{"type":"string","title":"Variant Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryDetailsUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryDetailsItem"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"examples":{"Variant not found":{"value":{"message":"The variant doesn't exist.","status":"error"}},"Location not found":{"value":{"message":"The location doesn't exist.","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/commerce/locations":{"get":{"tags":["eCommerce","Locations"],"summary":"Get all locations","description":"Returns a list of all locations","operationId":"ecommerce_get_locations","security":[{"mcp_auth":["commerce","commerce.read","commerce.locations","commerce.locations.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_CommerceLocationItemOut_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/commerce/orders":{"get":{"tags":["eCommerce","Orders"],"summary":"Get all orders","description":"Returns a list of all the orders","operationId":"ecommerce_get_orders","security":[{"mcp_auth":["commerce","commerce.read","commerce.orders","commerce.orders.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"},"description":"Filter orders created at or after this date (e.g. 2023-01-31)"},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date To"},"description":"Filter orders created at or before this date (e.g. 2023-01-31)"},{"name":"updated_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated After"},"description":"Filter orders last updated at or after this date (e.g. 2023-01-31T15:00:00 for 31 of January 2023 at 3PM UTC). UTC is the only format that is supported on all connectors."},{"name":"include_detailed_refunds","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BoolParam"},{"type":"null"}],"default":"false","title":"Include Detailed Refunds"},"description":"Include detailed information concerning refunds"},{"name":"include_product_categories","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BoolParam"},{"type":"null"}],"default":"false","title":"Include Product Categories"},"description":"Include detailed information about categories"},{"name":"include_customer_details","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BoolParam"},{"type":"null"}],"default":"true","title":"Include Customer Details"},"description":"Include detailed information about customer"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_OrderItemOut_"}}}},"400":{"content":{"application/json":{"examples":{"Invalid date_from":{"value":{"message":"The date format of the field 'Date From' is not valid. The expected format is the following: YYYY-MM-DD.","status":"error"}},"Invalid date_to":{"value":{"message":"The date format of the field 'Date To' is not valid. The expected format is the following: YYYY-MM-DD.","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["eCommerce","Orders"],"summary":"Create an order","description":"Create a new order","operationId":"ecommerce_create_order","security":[{"mcp_auth":["commerce","commerce.orders"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderItemIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderItemOut"}}}},"400":{"content":{"application/json":{"examples":{"No lines":{"value":{"message":"The order must contain at least one line.","status":"error"}},"Invalid currency":{"value":{"message":"The currency format is not correct. Please use the ISO 4217 codes.","status":"error"}},"Invalid country":{"value":{"message":"The country format is not correct. Please use the ISO 3166-1 codes.","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"content":{"application/json":{"examples":{"Invalid phone number":{"value":{"message":"The phone number doesnt seem to be valid. The number must begin with the country code.","status":"error"}},"Phone number used":{"value":{"message":"The phone number is already used by another client.","status":"error"}}},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Unprocessable Entity"}}}},"/consumers/{consumer_id}/commerce/orders/{order_id}":{"get":{"tags":["eCommerce","Orders"],"summary":"Get one specific order","description":"Returns a specific order","operationId":"ecommerce_get_order","security":[{"mcp_auth":["commerce","commerce.read","commerce.orders","commerce.orders.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"order_id","in":"path","required":true,"schema":{"type":"string","title":"Order Id"}},{"name":"include_product_categories","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BoolParam"},{"type":"null"}],"default":"false","title":"Include Product Categories"},"description":"Include detailed information about categories"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderItemOut"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The order doesn't exist.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/commerce/payment-methods":{"get":{"tags":["eCommerce","Payment methods"],"summary":"Get all payment methods","description":"Returns the list of the payment methods","operationId":"ecommerce_get_payments_methods","security":[{"mcp_auth":["commerce","commerce.read","commerce.payment_methods","commerce.payment_methods.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_PaymentMethodItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/commerce/product-categories":{"get":{"tags":["eCommerce","Categories"],"summary":"Get all product categories","description":"Returns the list of the product categories","operationId":"ecommerce_get_product_categories","security":[{"mcp_auth":["commerce","commerce.read","commerce.categories","commerce.categories.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"only_parents","in":"query","required":false,"schema":{"$ref":"#/components/schemas/BoolParam","default":"false"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_CategoryItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/commerce/taxes":{"get":{"tags":["eCommerce","Taxes"],"summary":"Get all tax rates","description":"Returns the list of all tax rates","operationId":"ecommerce_get_taxes","security":[{"mcp_auth":["commerce","commerce.read","commerce.taxes","commerce.taxes.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_TaxRateItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/commerce/countries":{"get":{"tags":["eCommerce","Countries"],"summary":"Get all countries","description":"Returns the list of all activated countries","operationId":"ecommerce_get_countries","security":[{"mcp_auth":["commerce","commerce.read","commerce.countries","commerce.countries.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_CountryItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/invoicing/contacts":{"get":{"tags":["Invoicing","Contacts"],"summary":"Retrieve all contacts","description":"Returns a list of all the contacts. Optionally contact type can be defined to retrieve contact from a certain type.","operationId":"invoicing_get_contacts","security":[{"mcp_auth":["invoicing","invoicing.read","invoicing.contacts","invoicing.contacts.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"contact_type","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ContactType","default":"all"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_ContactItemOut_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Invoicing","Contacts"],"summary":"Create a contact","description":"Create a new contact.","operationId":"invoicing_post_contacts","security":[{"mcp_auth":["invoicing","invoicing.contacts"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactItemIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactItemOut"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/invoicing/contacts/{contact_id}":{"get":{"tags":["Invoicing","Contacts"],"summary":"Retrieve one contact","description":"Returns a contact","operationId":"invoicing_get_contact","security":[{"mcp_auth":["invoicing","invoicing.read","invoicing.contacts","invoicing.contacts.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","title":"Contact Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactItemOut"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The contact doesn't exist.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/invoicing/products":{"get":{"tags":["Invoicing","Products"],"summary":"Retrieve all products","description":"Returns a list of all the products","operationId":"invoicing_get_products","security":[{"mcp_auth":["invoicing","invoicing.read","invoicing.products","invoicing.products.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_ProductItemOut_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Invoicing","Products"],"summary":"Create a product","description":"Create a new product.","operationId":"invoicing_post_products","security":[{"mcp_auth":["invoicing","invoicing.products"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductItem"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductItemOut"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/invoicing/products/{product_id}":{"get":{"tags":["Invoicing","Products"],"summary":"Retrieve one product","description":"Returns a product","operationId":"invoicing_get_product","security":[{"mcp_auth":["invoicing","invoicing.read","invoicing.products","invoicing.products.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"product_id","in":"path","required":true,"schema":{"type":"string","title":"Product Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductItemOut"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The product doesn't exist.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/invoicing/taxes":{"get":{"tags":["Invoicing","Taxes"],"summary":"Retrieve all taxes","description":"Returns a list of all the taxes","operationId":"invoicing_get_taxes","security":[{"mcp_auth":["invoicing","invoicing.read","invoicing.taxes","invoicing.taxes.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_InvoicingVatCode_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/invoicing/taxes/{tax_id}":{"get":{"tags":["Invoicing","Taxes"],"summary":"Retrieve one tax","description":"Returns a tax","operationId":"invoicing_get_tax","security":[{"mcp_auth":["invoicing","invoicing.read","invoicing.taxes","invoicing.taxes.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"tax_id","in":"path","required":true,"schema":{"type":"string","title":"Tax Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicingVatCode"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The tax doesn't exist.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/invoicing/invoices":{"get":{"tags":["Invoicing","Invoices"],"summary":"Retrieve all invoices","description":"Returns a list of invoices. Optionally invoice type and dates can be defined to retrieve invoices of a certain type from a certain date to another date","operationId":"invoicing_get_invoices","security":[{"mcp_auth":["invoicing","invoicing.read","invoicing.invoices","invoicing.invoices.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"}},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date To"}},{"name":"invoice_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/InvoicingInvoiceType"},{"type":"null"}],"default":"all","title":"Invoice Type"}},{"name":"payment_status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/PaymentStatus"},{"type":"null"}],"default":"all","title":"Payment Status"}},{"name":"updated_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated After"}},{"name":"include_invoice_lines","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BoolParam"},{"type":"null"}],"default":"false","title":"Include Invoice Lines"},"description":"Include the invoice lines in the response. By default, invoice lines are included when no extra request is needed to fetch them. If you want to include them explicitly, set this parameter to true."},{"name":"include_analytic_accounts","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BoolParam"},{"type":"null"}],"default":"false","title":"Include Analytic Accounts"},"description":"Include analytic accounts in the response"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_InvoiceItemOut_"}}}},"400":{"content":{"application/json":{"example":{"message":"You must provide an invoice type.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Invoicing","Invoices"],"summary":"Create an invoice","description":"Create a new invoice.","operationId":"invoicing_post_invoices","security":[{"mcp_auth":["invoicing","invoicing.invoices"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceItemIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceItemOut"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/invoicing/invoices/{invoice_id}":{"get":{"tags":["Invoicing","Invoices"],"summary":"Retrieve one invoice","description":"Returns a invoice","operationId":"invoicing_get_invoice","security":[{"mcp_auth":["invoicing","invoicing.read","invoicing.invoices","invoicing.invoices.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"invoice_id","in":"path","required":true,"schema":{"type":"string","title":"Invoice Id"}},{"name":"include_pdf","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BoolParam"},{"type":"null"}],"default":"false","title":"Include Pdf"},"description":"Include the invoice PDF as a base64 encoded string in the response"},{"name":"include_analytic_accounts","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BoolParam"},{"type":"null"}],"default":"false","title":"Include Analytic Accounts"},"description":"Include analytic accounts in the response"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceItemOutSingle"}}}},"400":{"content":{"application/json":{"example":{"message":"The ID of the invoice doesn't have the correct format.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The invoice doesn't exist in the invoicing system.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/invoicing/upload-document":{"post":{"tags":["Invoicing"],"summary":"Upload a document (PDF)","description":"Upload a document (PDF)","operationId":"invoicing_upload_document","security":[{"mcp_auth":["invoicing"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentItemIn"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadDocumentItemOut"}}}},"400":{"content":{"application/json":{"example":{"message":"The document is not a valid base64 string representing a PDF.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/invoicing/opportunities":{"get":{"tags":["Invoicing","Opportunities"],"summary":"Retrieve all opportunities","description":"Returns a list of all the opportunities","operationId":"invoicing_get_opportunities","security":[{"mcp_auth":["invoicing","invoicing.read","invoicing.opportunities","invoicing.opportunities.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_OpportunityItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/invoicing/opportunities/{opportunity_id}":{"get":{"tags":["Invoicing","Opportunities"],"summary":"Retrieve one opportunity","description":"Returns an opportunity","operationId":"invoicing_get_opportunity","security":[{"mcp_auth":["invoicing","invoicing.read","invoicing.opportunities","invoicing.opportunities.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"opportunity_id","in":"path","required":true,"schema":{"type":"string","title":"Opportunity Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpportunityItem"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The opportunity doesn't exist.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/invoicing/payments":{"get":{"tags":["Invoicing","Payments"],"summary":"Retrieve all payments (invoicing)","description":"Returns a list of payments","operationId":"invoicing_get_payments","security":[{"mcp_auth":["invoicing","invoicing.read","invoicing.payments","invoicing.payments.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"}},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date To"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_InvoicingPaymentItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Invoicing","Payments"],"summary":"Create a payment (invoicing)","description":"Create a payment (invoicing)","operationId":"invoicing_create_payment","security":[{"mcp_auth":["invoicing","invoicing.payments"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicingPaymentItemIn"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicingPaymentItem"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/invoicing/payments/{payment_id}":{"patch":{"tags":["Invoicing","Payments"],"summary":"Update a payment (invoicing)","description":"Update a payment (invoicing)","operationId":"invoicing_update_payment","security":[{"mcp_auth":["invoicing","invoicing.payments"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"payment_id","in":"path","required":true,"schema":{"type":"string","title":"Payment Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicingPaymentItemUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicingPaymentItem"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/invoicing/payment-methods":{"get":{"tags":["Invoicing","Payment methods"],"summary":"Retrieve all payment methods","description":"Returns the list of payment methods","operationId":"invoicing_get_payments_methods","security":[{"mcp_auth":["invoicing","invoicing.read","invoicing.payment_methods","invoicing.payment_methods.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_InvoicingPaymentMethodItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/invoicing/bank-accounts":{"get":{"tags":["Invoicing","Bank accounts"],"summary":"Retrieve all Bank Accounts","description":"Returns the list of bank accounts","operationId":"invoicing_get_bank_accounts","security":[{"mcp_auth":["invoicing","invoicing.read","invoicing.bank_accounts","invoicing.bank_accounts.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_InvoicingBankAccountItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/invoicing/bank-transactions":{"get":{"tags":["Invoicing","Bank transactions"],"summary":"Retrieve all Bank Transactions","description":"Returns the list of bank transactions","operationId":"invoicing_get_bank_transactions","security":[{"mcp_auth":["invoicing","invoicing.read","invoicing.bank_transactions","invoicing.bank_transactions.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"},"description":"The start date (inclusive) for filtering bank transactions. If provided, only transactions on or after this date will be returned."},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date To"},"description":"The end date (inclusive) for filtering bank transactions. If provided, only transactions on or before this date will be returned."},{"name":"bank_account_id","in":"query","required":true,"schema":{"type":"string","title":"Bank Account Id"},"description":"The unique identifier of the bank account to filter transactions for. If omitted, transactions from all accessible accounts will be included."},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BankTransactionStatus"},{"type":"null"}],"title":"Status"},"description":"Filter transactions by their status."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_InvoicingBankTransactionItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/banking/financial-institutions":{"get":{"tags":["Banking","Financial institutions"],"summary":"Get list of financial institutions","description":"Returns the list of financial institutions the user consent access to","operationId":"banking_get_financial_institutions","security":[{"mcp_auth":["banking","banking.read","banking.financial_institutions","banking.financial_institutions.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_BankingFinancialInstitutionItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/banking/accounts":{"get":{"tags":["Banking","Banking accounts"],"summary":"Get list of banking accounts","description":"Returns the list of banking accounts","operationId":"banking_get_accounts","security":[{"mcp_auth":["banking","banking.read","banking.banking_accounts","banking.banking_accounts.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_BankingAccountItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/banking/transactions":{"get":{"tags":["Banking","Transactions"],"summary":"Get list of financial transactions","description":"Returns the list of transactions of an account","operationId":"banking_get_account_transactions","security":[{"mcp_auth":["banking","banking.read","banking.transactions","banking.transactions.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"account_id","in":"query","required":true,"schema":{"type":"string","title":"Account Id"}},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"}},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date To"}},{"name":"date_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/TransactionFilterDateType"},{"type":"null"}],"default":"value_date","title":"Date Type"}},{"name":"updated_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Updated After"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_BankingTransactionItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/banking/counterparts":{"get":{"tags":["Banking","Banking accounts"],"summary":"Get aggregated list of account counterparts found in transactions","description":"Returns the aggregated list of account counterpats found in transactions. Useful for categorisation.","operationId":"banking_get_account_counterparts","security":[{"mcp_auth":["banking","banking.read","banking.banking_accounts","banking.banking_accounts.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"account_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Id"}},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"}},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date To"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_BankingCounterPartItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/banking/attachments":{"get":{"tags":["Banking","Attachments"],"summary":"Get Attachments","description":"Returns a list of all attachments linked to a transaction","operationId":"banking_get_attachments","security":[{"mcp_auth":["banking","banking.read","banking.attachments","banking.attachments.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"transaction_id","in":"query","required":true,"schema":{"type":"string","title":"Transaction Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_AttachmentItemOut_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/payment/locations":{"get":{"tags":["Payment","Locations"],"summary":"Retrieve all locations","description":"Returns a list of locations.","operationId":"payment_get_locations","security":[{"mcp_auth":["payment","payment.read","payment.locations","payment.locations.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_PaymentLocationItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/payment/balances":{"get":{"tags":["Payment","Balances"],"summary":"Retrieve all balances","description":"Returns a list of balances.","operationId":"payment_get_balances","security":[{"mcp_auth":["payment","payment.read","payment.balances","payment.balances.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_BalanceItemOut_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/payment/transactions":{"get":{"tags":["Payment","Transactions"],"summary":"Retrieve all transactions","description":"Returns a list of transactions. Optionally transaction type and dates can be defined to retrieve transactions of a certain type from a certain date to another date","operationId":"payment_get_transactions","security":[{"mcp_auth":["payment","payment.read","payment.transactions","payment.transactions.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"accounting_category","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/TransactionAccountingCategory"},{"type":"null"}],"default":"all","title":"Accounting Category"},"description":"Filter based on the type of the transaction."},{"name":"starting_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Starting From"},"description":"Get all transactions more recent than this one excluded"},{"name":"balance_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Balance Id"},"description":"Get all transactions for a specific balance"},{"name":"payout_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payout Id"},"description":"Get all transactions linked to a specific payout"},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"}},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date To"}},{"name":"location_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Id"},"description":"Get all transactions for a specific location"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_TransactionItemOut_"}}}},"400":{"content":{"application/json":{"example":{"message":"You must provide an transaction type.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/payment/payments":{"get":{"tags":["Payment","Payments"],"summary":"Retrieve all payments","description":"Returns a list of payments.","operationId":"payment_get_payments","security":[{"mcp_auth":["payment","payment.read","payment.payments","payment.payments.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"}},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date To"}},{"name":"location_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Id"},"description":"Get all transactions for a specific location"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_PaymentItemOut_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/payment/payments/{payment_id}":{"get":{"tags":["Payment","Payments"],"summary":"Get a payment","description":"Returns a specific payment.","operationId":"payment_get_payment","security":[{"mcp_auth":["payment","payment.read","payment.payments","payment.payments.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"payment_id","in":"path","required":true,"schema":{"type":"string","title":"Payment Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentItemOut"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"example":{"message":"The payment doesn't exist in the system.","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/payment/refunds":{"get":{"tags":["Payment","Refunds"],"summary":"Retrieve all refunds","description":"Returns a list of refunds.","operationId":"payment_get_refunds","security":[{"mcp_auth":["payment","payment.read","payment.refunds","payment.refunds.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"payment_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Id"},"description":"Optional payment ID, to retrieve all refunds associated with that payment."},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"}},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date To"}},{"name":"location_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Id"},"description":"Get all transactions for a specific location"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_RefundItemOut_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/payment/payouts":{"get":{"tags":["Payment","Payouts"],"summary":"Retrieve all payouts","description":"Returns a list of payouts (periodic bank transfers made by the processor to the merchant).","operationId":"payment_get_payouts","security":[{"mcp_auth":["payment","payment.read","payment.payouts","payment.payouts.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"}},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date To"}},{"name":"location_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Id"},"description":"Get all transactions for a specific location"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_PayoutItemOut_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pms/orders":{"get":{"tags":["Property Management System","Orders"],"summary":"Get orders (PMS)","description":"Returns a list of the orders","operationId":"pms_get_orders","security":[{"mcp_auth":["pms","pms.read","pms.orders","pms.orders.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"date_from","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Date From"}},{"name":"date_to","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Date To"}},{"name":"location_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Id"}},{"name":"state","in":"query","required":false,"schema":{"$ref":"#/components/schemas/PMSStates","default":"consumed"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_PMSOrderItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pms/invoices":{"get":{"tags":["Property Management System","Invoices"],"summary":"Get invoices (PMS)","description":"Returns a list of the invoices","operationId":"pms_get_invoices","security":[{"mcp_auth":["pms","pms.read","pms.invoices","pms.invoices.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"date_from","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Date From"}},{"name":"date_to","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Date To"}},{"name":"location_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_PMSInvoiceFullItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pms/customers":{"get":{"tags":["Property Management System","Customers"],"summary":"Get customers (PMS)","description":"Returns a list of all the customers","operationId":"pms_get_customers","security":[{"mcp_auth":["pms","pms.read","pms.customers","pms.customers.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"},"description":"Filter based on other parameters than the email/phone, e.g. firstname, lastname"},{"name":"email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"description":"Filter based on email of customer"},{"name":"phone","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"description":"Filter based on phone of customer"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_PMSCustomerItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pms/customers/{customer_id}":{"get":{"tags":["Property Management System","customers","Customers"],"summary":"Get one customer (PMS)","description":"Returns a specific customer","operationId":"pms_get_customer","security":[{"mcp_auth":["pms","pms.read","pms.customers","pms.customers.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PMSCustomerItem"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"404":{"content":{"application/json":{"example":{"message":"The customer with id {CustomerId} could not be found","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pms/locations":{"get":{"tags":["Property Management System","Locations"],"summary":"Get locations (PMS)","description":"Returns a list of the locations","operationId":"pms_get_locations","security":[{"mcp_auth":["pms","pms.read","pms.locations","pms.locations.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_PMSLocationItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pms/payments":{"get":{"tags":["Property Management System","Payments"],"summary":"Get payments (PMS)","description":"Returns a list of payments","operationId":"pms_get_payments","security":[{"mcp_auth":["pms","pms.read","pms.payments","pms.payments.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"date_from","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Date From"}},{"name":"date_to","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Date To"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_PMSPaymentItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pms/payment-methods":{"get":{"tags":["Property Management System","Payment methods"],"summary":"Get payment methods (PMS)","description":"Returns the list of payment methods","operationId":"pms_get_payments_methods","security":[{"mcp_auth":["pms","pms.read","pms.payment_methods","pms.payment_methods.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"location_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_PMSPaymentMethods_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pms/accounting-categories":{"get":{"tags":["Property Management System","Categories"],"summary":"Get accounting categories (PMS)","description":"Returns a list of accounting categories. When not available for a specific PMS,it will return the same values as the product categories.","operationId":"pms_get_accounting_categories","security":[{"mcp_auth":["pms","pms.read","pms.categories","pms.categories.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_PMSAccountingCategoryItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pms/closures/{date}":{"get":{"tags":["Property Management System","Closures"],"summary":"Get closure info for a specific day (PMS)","description":"Returns whether the closure was already done for a specific day or not","operationId":"pms_get_closure","security":[{"mcp_auth":["pms","pms.read","pms.closure_info","pms.closure_info.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"date","in":"path","required":true,"schema":{"type":"string","format":"date","title":"Date"}},{"name":"location_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PMSClosureItem"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pms/taxes":{"get":{"tags":["Property Management System","Taxes"],"summary":"Get tax rates (PMS)","description":"Returns a list of the tax rates","operationId":"pms_get_taxes","security":[{"mcp_auth":["pms","pms.read","pms.taxes","pms.taxes.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_PMSTaxRateItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/consumers/{consumer_id}/pms/accounting-transactions":{"get":{"tags":["Property Management System","Taxes"],"summary":"Get the accounting transactions (PMS)","description":"Returns a list of the accounting transactions","operationId":"pms_get_accounting_transactions","security":[{"mcp_auth":["pms","pms.read","pms.taxes","pms.taxes.read"]}],"parameters":[{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"},"description":"Page size"},{"name":"date_from","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Date From"}},{"name":"date_to","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Date To"}},{"name":"location_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChiftPage_PMSAccountingTransactionItem_"}}}},"400":{"content":{"application/json":{"example":{"message":"Error while trying to perform your request","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Request"},"502":{"content":{"application/json":{"example":{"message":"Error while trying to authenticate to {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Bad Gateway"},"405":{"content":{"application/json":{"example":{"message":"The resource {Method} - {Resource} is not supported by {ConnectorName}","status":"error"},"schema":{"$ref":"#/components/schemas/ChiftError"}}},"description":"Method Not Allowed"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AccountBalance":{"properties":{"account_number":{"type":"string","title":"Account Number","description":"Ledger account number in the chart of accounts"},"account_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Name","description":"Display name of the ledger account"},"debit":{"type":"number","title":"Debit","description":"Debit at end date. When debit and credit are equal to 0 and balance is different from 0 then the debit and credit cannot be determined, only the balance can be calculated in those cases."},"credit":{"type":"number","title":"Credit","description":"Credit at end date. When debit and credit are equal to 0 and balance is different from 0 then the debit and credit cannot be determined, only the balance can be calculated in those cases."},"balance":{"type":"number","title":"Balance"},"period_debit":{"type":"number","title":"Period Debit","description":"Debit at end date beginning from the given start date. When debit and credit are equal to 0 and balance is different from 0 then the debit and credit cannot be determined, only the balance can be calculated in those cases."},"period_credit":{"type":"number","title":"Period Credit","description":"Credit at end date beginning from the given start date. When debit and credit are equal to 0 and balance is different from 0 then the debit and credit cannot be determined, only the balance can be calculated in those cases."},"period_balance":{"type":"number","title":"Period Balance","description":"Balance at end date beginning from the given start date."}},"type":"object","required":["account_number","debit","credit","balance","period_debit","period_credit","period_balance"],"title":"AccountBalance"},"AccountBalanceFilter":{"properties":{"accounts":{"items":{"type":"string"},"type":"array","title":"Accounts","description":"Array/list containing the account numbers/classes to include in the response. E.g. [\"601\", \"7\"] to retrieve all account in the class 7 and accounts with an account number beginning with 601"},"start":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start","description":"Start month (inclusive). Format: YYYYMM (e.g., 202502 for February 2025)."},"end":{"type":"string","maxLength":6,"minLength":6,"title":"End","description":"End month (inclusive). Format: YYYYMM (e.g., 202512 for December 2025)."}},"type":"object","required":["accounts","end"],"title":"AccountBalanceFilter"},"AccountItem":{"properties":{"number":{"type":"string","title":"Number","description":"The account number in the chart of accounts. Must be unique within the accounting folder. In some countries (e.g., France, Belgium, Spain), the number structure is constrained by local accounting rules and must follow official charts of accounts (e.g., Plan Comptable Général)."},"name":{"type":"string","title":"Name","description":"Name or label of the account as it appears in the accounting system. This is typically used for internal referencing and identification of the account."},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Flag indicating whether the account is active. If True, the account is active and can be used in transactions. If False, the account is inactive and cannot be used for transactions.","default":true},"type":{"anyOf":[{"$ref":"#/components/schemas/AccountItemType"},{"type":"null"}],"description":"Represents the functional type of the ledger account, used to support common accounting operations such as payments, invoicing, tax handling, and reporting. The type here is more operational and aligned with how accounts are actually used in day-to-day processes (e.g., tracking receivables, recording VAT, handling bank transactions) "},"scheme_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Scheme Ids","description":"List of scheme classification IDs linked to this ledger account. A scheme (e.g., RGS, SBR) provides a standardized classification structure for organizing accounts for reporting purposes. Multiple scheme codes can be associated with a single account."},"accounting_category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accounting Category","description":"Category of the ledger account in the accounting system. This is the category of the account as defined in the accounting system."}},"type":"object","required":["number","name"],"title":"AccountItem"},"AccountItemType":{"type":"string","enum":["bank","cash","other_financial","receivable","payable","income","expense","other_expense","vat","other"],"title":"AccountItemType"},"AccountToCreate":{"properties":{"account_number":{"type":"string","minLength":1,"title":"Account Number"},"account_name":{"type":"string","minLength":1,"title":"Account Name"}},"type":"object","required":["account_number","account_name"],"title":"AccountToCreate"},"AccountTypeFilter":{"type":"string","enum":["bank","cash","income","expense","other_expense","vat"],"title":"AccountTypeFilter"},"AccountingCategoryItem":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the accounting category","examples":["371ca583-d218-4900-b236-397532cf0e2"]},"name":{"type":"string","title":"Name","description":"Name given to the accounting category","examples":["Beverages"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code assigned to the category","examples":["123456"]},"ledger_account_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ledger Account Code","description":"Ledger account code assigned to the category","examples":["123456"]},"posting_account_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Posting Account Code","description":"Posting account code assigned to the category","examples":["123456"]}},"type":"object","required":["id","name"],"title":"AccountingCategoryItem"},"AccountingInfoOut":{"properties":{"main_currency":{"type":"string","title":"Main Currency","description":"Main currency of the accounting folder. ISO-4217 format.","examples":["EUR","USD","GBP"]},"main_currency_total":{"type":"number","title":"Main Currency Total","description":"Total amount of the invoice in the accounting folder's currency.","default":0,"examples":["100.0","123.4","1.23"]},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number","description":"Client/supplier ledger account used to book the invoice total amount. (optional)","examples":["411001","401234","1600"]}},"type":"object","title":"AccountingInfoOut"},"AccountingInvoicePaymentIn":{"properties":{"date":{"type":"string","format":"date","title":"Date","description":"The date of the payment"},"payment_method_id":{"type":"string","title":"Payment Method Id","description":"Technical ID of the payment method in the accounting system."},"currency":{"type":"string","title":"Currency","description":"Payment currency"},"currency_exchange_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Currency Exchange Rate","description":"Exchange rate applicable at the payment date. Required when the currency is different from the system's currency.","default":1},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference","description":"External reference of the payment."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number","description":"Unique Payment number (if managed by the software)."},"items":{"items":{"$ref":"#/components/schemas/AccountingInvoicePaymentItemIn"},"type":"array","title":"Items","description":"Payment's repartition"}},"type":"object","required":["date","payment_method_id","currency","items"],"title":"AccountingInvoicePaymentIn"},"AccountingInvoicePaymentItemIn":{"properties":{"invoice_id":{"type":"string","title":"Invoice Id","description":"Technical ID of the invoice in the accounting system."},"amount":{"type":"number","exclusiveMinimum":0.0,"title":"Amount","description":"Paid amount dedicated to the invoice. The amount must be positive and follows the sign of the linked invoice."}},"type":"object","required":["invoice_id","amount"],"title":"AccountingInvoicePaymentItemIn"},"AccountingPaymentMethod":{"properties":{"id":{"type":"string","title":"Id","description":"Technical ID of the payment method in the accounting system."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the payment method"}},"type":"object","required":["id"],"title":"AccountingPaymentMethod"},"AccountingPaymentTerms":{"properties":{"id":{"type":"string","title":"Id","description":"Technical ID of the payment term in the accounting system."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the payment term"}},"type":"object","required":["id"],"title":"AccountingPaymentTerms"},"AccountingVatCode":{"properties":{"id":{"type":"string","title":"Id","description":"Unique id of the VAT Code instance in the accounting system."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Short code (sometimes also used as id) for the VAT code, as defined in the accounting system. This code is typically used for internal referencing, mapping, or selection of VAT codes"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Flag indicating whether the vat code is active. If True, the vat code is active and can be used in entries/invoices. If False, the vat code is inactive and cannot be used in entries/invoices.","default":true},"label":{"type":"string","title":"Label","description":"Label of the VAT code as it appears in the accounting system. This is the human-readable name used to identify the VAT code."},"scope":{"anyOf":[{"$ref":"#/components/schemas/VatCodeScope"},{"type":"null"}],"description":"Scope of the VAT code, indicating its applicability. Use 'nat' for VAT codes that apply to local/domestic sales or purchases, 'eu' for cross-border transactions within the EU, and 'int' for transactions with countries outside the EU.","default":"unknown"},"rate":{"type":"number","title":"Rate","description":"VAT rate associated with the VAT code. This is the percentage rate applied to the amount when this VAT code is used."},"type":{"$ref":"#/components/schemas/VatCodeType","description":"Type of the VAT code, indicating whether it is a sales tax or purchase tax. This helps in understanding how the VAT code is applied in transactions."},"deductible_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deductible Account","description":"Ledger account number used for the deductible part of the VAT code. This is typically used for purchase transactions where VAT can be deducted."},"payable_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payable Account","description":"Ledger account number used for the payable part of the VAT code. This is typically used for sales transactions where VAT is collected from customers."},"reversed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Reversed","description":"Indicates whether the VAT code is reversed. A reversed VAT code is used in specific scenarios, such as reverse charge mechanisms, where the responsibility for reporting VAT shifts from the seller to the buyer.","default":false},"withholding_tax":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Withholding Tax","description":"Indicates whether the VAT code is a withholding tax. This is used to indicate that the VAT code is a withholding tax and should be treated as such.","default":false},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country of the VAT code. This is the ISO 3166-1 code of the country."}},"type":"object","required":["id","label","rate","type"],"title":"AccountingVatCode"},"AddressItem":{"properties":{"address_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Type","description":"Type of the address","examples":["home"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name given to the address (e.g. 'home')","examples":["Home"]},"street":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street","description":"Street name","examples":["Main Street"]},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number","description":"Number of the address","examples":["123"]},"box":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box","description":"Box of the address","examples":["A"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name","examples":["Paris"]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postal Code","description":"Postal code of the address","examples":["75000"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country, format: ISO 3166-1 codes.","examples":["FR"]}},"type":"object","title":"AddressItem"},"AddressItemIn":{"properties":{"address_type":{"$ref":"#/components/schemas/AddressType"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number"},"box":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"street":{"type":"string","title":"Street"},"city":{"type":"string","title":"City"},"postal_code":{"type":"string","title":"Postal Code"},"country":{"type":"string","title":"Country","description":"Format: ISO 3166-1 codes."}},"type":"object","required":["address_type","street","city","postal_code","country"],"title":"AddressItemIn"},"AddressItemInInvoicing":{"properties":{"address_type":{"$ref":"#/components/schemas/AddressTypeInvoicing"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number"},"box":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"street":{"type":"string","title":"Street"},"city":{"type":"string","title":"City"},"postal_code":{"type":"string","title":"Postal Code"},"country":{"type":"string","title":"Country","description":"Format: ISO 3166-1 codes."}},"type":"object","required":["address_type","street","city","postal_code","country"],"title":"AddressItemInInvoicing"},"AddressItemOut":{"properties":{"address_type":{"$ref":"#/components/schemas/AddressType"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number"},"box":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"street":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postal Code"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Format: ISO 3166-1 codes."}},"type":"object","required":["address_type"],"title":"AddressItemOut"},"AddressItemOutInvoicing":{"properties":{"address_type":{"$ref":"#/components/schemas/AddressTypeInvoicing"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number"},"box":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"street":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postal Code"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Format: ISO 3166-1 codes."}},"type":"object","required":["address_type"],"title":"AddressItemOutInvoicing"},"AddressType":{"type":"string","enum":["main","delivery","invoice"],"title":"AddressType"},"AddressTypeInvoicing":{"type":"string","enum":["main","delivery","invoice","other"],"title":"AddressTypeInvoicing"},"AnalyticAccountItemIn":{"properties":{"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Flag indicating whether the analytic account is active.","default":true},"code":{"type":"string","minLength":1,"title":"Code","description":"Short code for the analytic account. Often used for internal referencing. May be required to be unique"},"name":{"type":"string","minLength":1,"title":"Name","description":"Name or label of the analytic account as it appears in the accounting system."},"currency":{"type":"string","title":"Currency","description":"Indicates the currency of the analytic account (e.g., EUR, USD)."}},"type":"object","required":["code","name","currency"],"title":"AnalyticAccountItemIn"},"AnalyticAccountItemOut":{"properties":{"id":{"type":"string","title":"Id","description":"Unique id of the analytic account in the accounting system."},"active":{"type":"boolean","title":"Active","description":"Flag indicating whether the analytic account is active."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Short code for the analytic account. Often used for internal referencing. For some integrations, it may be required to be unique."},"name":{"type":"string","title":"Name","description":"Name or label of the analytic account as it appears in the accounting system."},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Indicates the currency of the analytic account (e.g., EUR, USD)."},"balance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Balance","default":0},"credit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit","default":0},"debit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Debit","default":0}},"type":"object","required":["id","active","name"],"title":"AnalyticAccountItemOut"},"AnalyticAccountItemOutMultiAnalyticPlans":{"properties":{"id":{"type":"string","title":"Id","description":"Unique id of the analytic account in the accounting system."},"active":{"type":"boolean","title":"Active","description":"Flag indicating whether the analytic account is active."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Short code for the analytic account. Often used for internal referencing. For some integrations, it may be required to be unique."},"name":{"type":"string","title":"Name","description":"Name or label of the analytic account as it appears in the accounting system."},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Indicates the currency of the analytic account (e.g., EUR, USD)."},"balance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Balance","default":0},"credit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit","default":0},"debit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Debit","default":0},"analytic_plan":{"type":"string","title":"Analytic Plan"}},"type":"object","required":["id","active","name","analytic_plan"],"title":"AnalyticAccountItemOutMultiAnalyticPlans"},"AnalyticAccountItemUpdate":{"properties":{"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Flag indicating whether the analytic account is active.","default":true},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Short code for the analytic account. Often used for internal referencing. May be required to be unique"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name or label of the analytic account as it appears in the accounting system."},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Indicates the currency of the analytic account (e.g., EUR, USD)."}},"type":"object","title":"AnalyticAccountItemUpdate"},"AnalyticDistribution":{"properties":{"analytic_plan":{"type":"string","title":"Analytic Plan","description":"Id of the analytic plan to which the distribution applies."},"analytic_accounts":{"items":{"$ref":"#/components/schemas/AnalyticDistributionDetail"},"type":"array","title":"Analytic Accounts","description":"List of analytic accounts and their respective percentages for the distribution."}},"type":"object","required":["analytic_plan","analytic_accounts"],"title":"AnalyticDistribution"},"AnalyticDistributionDetail":{"properties":{"analytic_account":{"type":"string","title":"Analytic Account"},"percentage":{"type":"number","title":"Percentage","description":"Percentage of the untaxed amount attributed to this analytic account. Only whole numbers (no decimals) are allowed. The total across the analytic distribution (all accounts in a given analytic plan) must equal 100%."}},"type":"object","required":["analytic_account","percentage"],"title":"AnalyticDistributionDetail"},"AnalyticDistributionDetailInvoicing":{"properties":{"analytic_account_code":{"type":"string","title":"Analytic Account Code","description":"Code of the analytic account."},"analytic_account_name":{"type":"string","title":"Analytic Account Name","description":"Name of the analytic account."},"percentage":{"type":"number","title":"Percentage","description":"Percentage of the untaxed amount attributed to this analytic account. Only whole numbers (no decimals) are allowed. The total across the analytic distribution (all accounts in a given analytic plan) must equal 100%."}},"type":"object","required":["analytic_account_code","analytic_account_name","percentage"],"title":"AnalyticDistributionDetailInvoicing"},"AnalyticDistributionInvoicing":{"properties":{"analytic_plan_code":{"type":"string","title":"Analytic Plan Code","description":"Code of the analytic plan to which the distribution applies."},"analytic_accounts":{"items":{"$ref":"#/components/schemas/AnalyticDistributionDetailInvoicing"},"type":"array","title":"Analytic Accounts","description":"List of analytic accounts and their respective percentages for the distribution."}},"type":"object","required":["analytic_plan_code","analytic_accounts"],"title":"AnalyticDistributionInvoicing"},"AnalyticPlanItem":{"properties":{"id":{"type":"string","title":"Id","description":"Unique id of the analytic plan instance in the accounting system."},"name":{"type":"string","title":"Name","description":"Name of the analytic plan as it appears in the accounting system."},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Indicates if the analytic plan is active.","default":true},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Id","description":"Id of the parent analytic plan, if any. This is used to create a hierarchy of analytic plans when that is supported."}},"type":"object","required":["id","name"],"title":"AnalyticPlanItem"},"Api":{"type":"string","enum":["Point of Sale","eCommerce","Accounting","Invoicing","Communication","Banking","Custom","Payment","Property Management System"],"title":"Api"},"ApiTransactionLookupOut":{"properties":{"created_on":{"type":"string","format":"date-time","title":"Created On","description":"Date and time when the API transaction started (UTC).","examples":["2024-05-15T12:34:56Z"]},"method":{"$ref":"#/components/schemas/HTTPMethod","description":"HTTP method of the original request.","examples":["POST"]},"route":{"type":"string","title":"Route","description":"Path of the original request.","examples":["/consumers/a65f95f4-7188-4866-a3ff-eb0fe17958c3/accounting/suppliers"]},"status_code":{"type":"integer","title":"Status Code","description":"HTTP status code returned by the original request.","examples":[200]},"created_entity_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created Entity Id","description":"Identifier of the entity created by the request, when applicable (typically for POST).","examples":["inv_123"]}},"type":"object","required":["created_on","method","route","status_code"],"title":"ApiTransactionLookupOut"},"AttachmentItem":{"properties":{"base64_string":{"type":"string","title":"Base64 String"},"name":{"anyOf":[{"type":"string","maxLength":200,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_ ]{1,196}(?:.pdf)?$"},{"type":"null"}],"title":"Name","description":"A name for the PDF file to be created for accounting software that support it."}},"type":"object","required":["base64_string"],"title":"AttachmentItem"},"AttachmentItemIn":{"properties":{"base64_string":{"type":"string","title":"Base64 String"},"document_type":{"$ref":"#/components/schemas/InvoicingDocumentType"}},"type":"object","required":["base64_string","document_type"],"title":"AttachmentItemIn"},"AttachmentItemOut":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the attachment in the accounting system."},"base64_string":{"type":"string","title":"Base64 String","description":"The file content encoded as a base64 string. Decode this to reconstruct the original file (PDF, image, etc.)."}},"type":"object","required":["id","base64_string"],"title":"AttachmentItemOut"},"AuthItem":{"properties":{"clientId":{"type":"string","title":"Clientid"},"clientSecret":{"type":"string","title":"Clientsecret"},"accountId":{"type":"string","format":"uuid","title":"Accountid"},"marketplaceId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Marketplaceid"}},"type":"object","required":["clientId","clientSecret","accountId"],"title":"AuthItem"},"BalanceItemOut":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"available_amount":{"type":"number","title":"Available Amount","description":"Total amount available"},"currency":{"type":"string","title":"Currency","description":"Currency"},"create_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Create Date","description":"Create Date"}},"type":"object","required":["id","source_ref","available_amount","currency"],"title":"BalanceItemOut"},"BankAccountItemIn":{"properties":{"code":{"type":"string","minLength":1,"title":"Code","description":"A userfriendly code to represent the bank account. This will be used as the code of the journal if we need to create a journal for the bank account."},"currency":{"type":"string","minLength":1,"title":"Currency","description":"Currency of the bank account (e.g., EUR, USD)."},"account_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Name","description":"Name of the bank account. Represents this specific bank account in the accounting system."},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number","description":"Unique number representing the bank account. At least one of the fields 'account_number' or 'IBAN' must be filled in."},"iban":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Iban","description":"IBAN of the bank account. At least one of the fields 'account_number' or 'IBAN' must be filled in."},"bank_name":{"type":"string","title":"Bank Name","description":"Name of the bank linked to the bank account."}},"type":"object","required":["code","currency","bank_name"],"title":"BankAccountItemIn"},"BankAccountItemOut":{"properties":{"id":{"type":"string","title":"Id"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"A userfriendly code to represent the bank account. This will be used as the code of the journal if we need to create a journal for the bank account."},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Currency of the bank account (e.g., EUR, USD)."},"account_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Name","description":"Name of the bank account. Represents this specific bank account in the accounting system."},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number","description":"Unique number representing the bank account."},"iban":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Iban","description":"IBAN of the bank account."},"bank_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Name","description":"Name of the bank linked to the bank account."},"journal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Journal Id","description":"Indicates the journal used in the accounting system to represent the bank account. The journal contains all the transactions related to this specific bank account."},"ledger_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ledger Account","description":"Indicates the ledger account used in the accounting system to represent the bank account. The ledger account is used in all the transactions related to this specific bank account. This ledger account is used to track the balance of the bank account."},"unallocated_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unallocated Account","description":"Unallocated ledger account used to book entries when the final ledger account / client / supplier / employee is not yet known (specific to bank and cash journals)"}},"type":"object","required":["id"],"title":"BankAccountItemOut"},"BankAccountRoutingType":{"type":"string","enum":["unknown","ach","sort_code","bsb","transit","ifsc","clabe"],"title":"BankAccountRoutingType"},"BankAccountsItem":{"properties":{"is_primary":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Primary","description":"Indicates whether this is the default bank account for this third-party. Only one bank account per third-party can have is_primary set to true. Defaults to true.","default":true},"iban":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Iban","description":"International Bank Account Number (ISO 13616). Present for countries in the IBAN scheme (e.g., France, Germany, United Kingdom). null for countries that do not participate in the IBAN scheme (e.g., US, Canada, Australia)."},"bic_swift":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bic Swift","description":"Bank Identifier Code (ISO 9362), also known as SWIFT code. 8 or 11 characters. Optional for domestic payments, but required for international wire transfers."},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number","description":"Local bank account number. Used when the country does not participate in the IBAN scheme (e.g., US, CA, AU). Always paired with a routing_code."},"routing_code":{"anyOf":[{"$ref":"#/components/schemas/RoutingCodeItem"},{"type":"null"}],"description":"Domestic routing identifier for the bank. Required when no iban is present. Contains two subfields: type and value"}},"type":"object","title":"BankAccountsItem"},"BankStatementItemIn":{"properties":{"bank_statement_date":{"type":"string","format":"date","title":"Bank Statement Date","description":"Date of the bank statement"},"bank_account_id":{"type":"string","minLength":1,"title":"Bank Account Id","description":"Unique ID of the bank account in the accounting system"},"currency":{"type":"string","minLength":1,"title":"Currency","description":"Currency of the bank statement. This must be the same as the currency of the bank account."},"external_bank_statement_id":{"type":"string","minLength":1,"title":"External Bank Statement Id","description":"External bank statement ID. To be compatible with all software, we recommend to use only digits with a maximum length of 10."},"opening_balance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Opening Balance","description":"Opening balance of the bank account before the statement"},"pdf":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pdf","description":"Base64 PDF attachment of the bank statement."},"pdf_name":{"anyOf":[{"type":"string","maxLength":200,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_ ]{1,196}(?:.pdf)?$"},{"type":"null"}],"title":"Pdf Name","description":"A name for the PDF file to be created for accounting software that support it."},"items":{"items":{"$ref":"#/components/schemas/BankTransactionItemIn"},"type":"array","title":"Items","description":"List of transaction items"}},"type":"object","required":["bank_statement_date","bank_account_id","currency","external_bank_statement_id","items"],"title":"BankStatementItemIn"},"BankStatementItemOut":{"properties":{"bank_statement_date":{"type":"string","format":"date","title":"Bank Statement Date","description":"Date of the bank statement"},"bank_account_id":{"type":"string","minLength":1,"title":"Bank Account Id","description":"Unique ID of the bank account in the accounting system"},"currency":{"type":"string","minLength":1,"title":"Currency","description":"Currency of the bank statement. This must be the same as the currency of the bank account."},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"Internal bank statement ID generated by the accounting system"},"external_bank_statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Bank Statement Id","description":"External bank statement ID"},"items":{"items":{"$ref":"#/components/schemas/BankTransactionItemOut"},"type":"array","title":"Items","description":"List of transaction items with their IDs"}},"type":"object","required":["bank_statement_date","bank_account_id","currency","items"],"title":"BankStatementItemOut"},"BankTransactionCounterpartItem":{"properties":{"counterpart_type":{"anyOf":[{"$ref":"#/components/schemas/BankTransactionCounterpartType"},{"type":"null"}],"description":"Type of the counterpart"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"ID of the counterpart in the accounting system"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the counterpart","examples":["John Doe"]},"iban":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Iban","description":"IBAN of the counterpart","examples":["BE61310126985517"]},"bank_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Account","description":"Bank account number of the counterpart","examples":["310126985517"]}},"type":"object","title":"BankTransactionCounterpartItem"},"BankTransactionCounterpartType":{"type":"string","enum":["customer","supplier","employee"],"title":"BankTransactionCounterpartType"},"BankTransactionItemIn":{"properties":{"general_ledger_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"General Ledger Account","description":"Number of the general ledger account to book the transaction against."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Transaction description"},"external_transaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Transaction Id","description":"External transaction ID"},"amount":{"type":"number","title":"Amount","description":"Total amount including fee and tax"},"fee_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fee Amount","description":"Fee amount","default":0},"tax_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Tax Amount","description":"Tax amount","default":0},"currency_exchange_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Currency Exchange Rate","description":"Exchange rate applicable at the transaction date","default":1},"counterpart":{"anyOf":[{"$ref":"#/components/schemas/BankTransactionCounterpartItem"},{"type":"null"}],"description":"Counterpart of the transaction"}},"type":"object","required":["amount"],"title":"BankTransactionItemIn"},"BankTransactionItemOut":{"properties":{"general_ledger_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"General Ledger Account","description":"Number of the general ledger account to book the transaction against."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Transaction description"},"external_transaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Transaction Id","description":"External transaction ID"},"amount":{"type":"number","title":"Amount","description":"Total amount including fee and tax"},"fee_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fee Amount","description":"Fee amount","default":0},"tax_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Tax Amount","description":"Tax amount","default":0},"currency_exchange_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Currency Exchange Rate","description":"Exchange rate applicable at the transaction date","default":1},"counterpart":{"anyOf":[{"$ref":"#/components/schemas/BankTransactionCounterpartItem"},{"type":"null"}],"description":"Counterpart of the transaction"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"Internal transaction ID generated by the accounting system"}},"type":"object","required":["amount"],"title":"BankTransactionItemOut"},"BankTransactionStatus":{"type":"string","enum":["draft","done"],"title":"BankTransactionStatus"},"BankingAccountItem":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the account","examples":["account-123"]},"currency":{"type":"string","title":"Currency","description":"Currency of the account","examples":["EUR"]},"current_balance":{"type":"number","title":"Current Balance","description":"Current balance of the account","examples":[1000]},"current_balance_last_update_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Current Balance Last Update Date","description":"Last update date of the current balance","examples":["2025-01-01T00:00:00Z"]},"available_balance":{"type":"number","title":"Available Balance","description":"Available balance of the account","examples":[1000]},"available_balance_last_update_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Available Balance Last Update Date","description":"Last update date of the available balance","examples":["2025-01-01T00:00:00Z"]},"description":{"type":"string","title":"Description","description":"Description of the account","examples":["Chift account"]},"reference":{"type":"string","title":"Reference","description":"Reference of the account","examples":["FR76300040123456789012345678"]},"reference_type":{"type":"string","title":"Reference Type","description":"Type of the reference","examples":["IBAN"]},"holder_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Holder Name","description":"Name of the account holder","examples":["John Doe"]},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Indicates if the account is active","default":true,"examples":[true]}},"type":"object","required":["id","currency","current_balance","available_balance","description","reference","reference_type"],"title":"BankingAccountItem"},"BankingCounterPartItem":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the counterpart","examples":["John Doe"]},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference","description":"Reference of the counterpart","examples":["FR76300040123456789012345678"]},"details":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Details","description":"Details of the counterpart","examples":["Chift counterpart"]}},"type":"object","title":"BankingCounterPartItem"},"BankingFinancialInstitutionItem":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the financial institution","examples":["financial-institution-123"]},"bic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bic","description":"BIC of the financial institution","examples":["GEBABEBBXXX"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country of the financial institution, format: ISO 3166-1 codes.","examples":["FR"]},"name":{"type":"string","title":"Name","description":"Name of the financial institution","examples":["BNP"]}},"type":"object","required":["id","name"],"title":"BankingFinancialInstitutionItem"},"BankingTransactionItem":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the transaction","examples":["transaction-123"]},"bank_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Account Id","description":"Identifier of the bank account linked to the transaction","examples":["account-123"]},"amount":{"type":"number","title":"Amount","description":"Amount of the transaction","examples":[1000]},"tax_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Tax Amount","description":"VAT amount of the transaction","examples":[200]},"currency":{"type":"string","title":"Currency","description":"Currency of the transaction","examples":["EUR"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the transaction","examples":["Chift transaction"]},"additional_information":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Additional Information","description":"Additional information of the transaction","examples":["Chift transaction"]},"counterpart_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterpart Name","description":"Name of the counterpart","examples":["John Doe"]},"counterpart_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterpart Reference","description":"Reference of the counterpart","examples":["FR76300040123456789012345678"]},"remittance_information":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remittance Information","description":"Remittance information of the transaction","examples":["Chift transaction"]},"creation_date":{"type":"string","format":"date-time","title":"Creation Date","description":"Creation date of the transaction","examples":["2025-01-01T00:00:00Z"]},"value_date":{"type":"string","format":"date-time","title":"Value Date","description":"Value date of the transaction","examples":["2025-01-01T00:00:00Z"]},"execution_date":{"type":"string","format":"date-time","title":"Execution Date","description":"Execution date of the transaction","examples":["2025-01-01T00:00:00Z"]},"internal_transaction":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Internal Transaction","description":"Indicates if the transaction is internal","default":false,"examples":[false]},"operation_type":{"anyOf":[{"$ref":"#/components/schemas/OperationType"},{"type":"null"}],"description":"Type of the operation","default":"other","examples":["incoming_transfer"]},"last_update_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Update On","description":"Last update date of the transaction","examples":["2025-01-01T00:00:00Z"]},"status":{"anyOf":[{"$ref":"#/components/schemas/BankingTransactionStatus"},{"type":"null"}],"description":"Status of the transaction","examples":["pending"]},"open_balance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Open Balance","description":"Opening balance of the account at the time of the transaction","examples":[1000.0]},"attachments_info":{"$ref":"#/components/schemas/ItemAttachmentInfoOut","description":"Extra information about the attachments linked to the invoice."}},"type":"object","required":["id","amount","currency","creation_date","value_date","execution_date"],"title":"BankingTransactionItem"},"BankingTransactionStatus":{"type":"string","enum":["pending","declined","completed"],"title":"BankingTransactionStatus"},"BookYear":{"properties":{"name":{"type":"string","title":"Name","description":"Name of the book year, typically in the format 'YYYY'."},"start":{"type":"string","format":"date","title":"Start","description":"Start date of the book year (format: YYYY-MM-DD). This is the date when the book year begins."},"end":{"type":"string","format":"date","title":"End","description":"End date of the book year (format: YYYY-MM-DD). This is the date when the book year ends."},"closed":{"type":"boolean","title":"Closed","description":"Indicates whether the book year is closed. A closed book year normally cannot be modified or have new entries added to it."}},"type":"object","required":["name","start","end","closed"],"title":"BookYear"},"BoolParam":{"type":"string","enum":["true","false"],"title":"BoolParam"},"CategoryItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"name":{"type":"string","title":"Name"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Id","description":"Technical id of the parent category in the target software"}},"type":"object","required":["id","source_ref","name"],"title":"CategoryItem"},"ChainExecutionItem":{"properties":{"id":{"type":"string","title":"Id","description":"Execution id"},"parentexecutionid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentexecutionid","description":"Parent execution id. An execution is linked to multiple child executions linked to consumers."},"start":{"type":"string","format":"date-time","title":"Start"},"end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End"},"status":{"type":"string","title":"Status"}},"type":"object","required":["id","parentexecutionid","start","end","status"],"title":"ChainExecutionItem"},"ChiftError":{"properties":{"message":{"type":"string","title":"Message"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","default":"error"},"detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Detail","default":""}},"type":"object","required":["message"],"title":"ChiftError"},"ChiftId":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"}},"type":"object","required":["id","source_ref"],"title":"ChiftId"},"ChiftPage_AccountBalance_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AccountBalance"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[AccountBalance]"},"ChiftPage_AccountItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AccountItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[AccountItem]"},"ChiftPage_AccountingCategoryItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AccountingCategoryItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[AccountingCategoryItem]"},"ChiftPage_AccountingPaymentMethod_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AccountingPaymentMethod"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[AccountingPaymentMethod]"},"ChiftPage_AccountingPaymentTerms_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AccountingPaymentTerms"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[AccountingPaymentTerms]"},"ChiftPage_AccountingVatCode_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AccountingVatCode"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[AccountingVatCode]"},"ChiftPage_AnalyticAccountItemOutMultiAnalyticPlans_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AnalyticAccountItemOutMultiAnalyticPlans"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[AnalyticAccountItemOutMultiAnalyticPlans]"},"ChiftPage_AnalyticAccountItemOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AnalyticAccountItemOut"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[AnalyticAccountItemOut]"},"ChiftPage_AnalyticPlanItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AnalyticPlanItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[AnalyticPlanItem]"},"ChiftPage_AttachmentItemOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AttachmentItemOut"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[AttachmentItemOut]"},"ChiftPage_BalanceItemOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/BalanceItemOut"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[BalanceItemOut]"},"ChiftPage_BankAccountItemOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/BankAccountItemOut"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[BankAccountItemOut]"},"ChiftPage_BankingAccountItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/BankingAccountItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[BankingAccountItem]"},"ChiftPage_BankingCounterPartItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/BankingCounterPartItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[BankingCounterPartItem]"},"ChiftPage_BankingFinancialInstitutionItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/BankingFinancialInstitutionItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[BankingFinancialInstitutionItem]"},"ChiftPage_BankingTransactionItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/BankingTransactionItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[BankingTransactionItem]"},"ChiftPage_BookYear_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/BookYear"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[BookYear]"},"ChiftPage_CategoryItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CategoryItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[CategoryItem]"},"ChiftPage_ClientItemOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ClientItemOut"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[ClientItemOut]"},"ChiftPage_CommerceCustomerItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CommerceCustomerItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[CommerceCustomerItem]"},"ChiftPage_CommerceLocationItemOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CommerceLocationItemOut"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[CommerceLocationItemOut]"},"ChiftPage_CommerceProductItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CommerceProductItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[CommerceProductItem]"},"ChiftPage_ContactItemOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ContactItemOut"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[ContactItemOut]"},"ChiftPage_ContactItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ContactItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[ContactItem]"},"ChiftPage_CountryItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CountryItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[CountryItem]"},"ChiftPage_EmployeeItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/EmployeeItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[EmployeeItem]"},"ChiftPage_InvoiceItemOutMonoAnalyticPlan_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/InvoiceItemOutMonoAnalyticPlan"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[InvoiceItemOutMonoAnalyticPlan]"},"ChiftPage_InvoiceItemOutMultiAnalyticPlans_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/InvoiceItemOutMultiAnalyticPlans"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[InvoiceItemOutMultiAnalyticPlans]"},"ChiftPage_InvoiceItemOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/InvoiceItemOut"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[InvoiceItemOut]"},"ChiftPage_InvoicingBankAccountItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/InvoicingBankAccountItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[InvoicingBankAccountItem]"},"ChiftPage_InvoicingBankTransactionItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/InvoicingBankTransactionItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[InvoicingBankTransactionItem]"},"ChiftPage_InvoicingPaymentItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/InvoicingPaymentItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[InvoicingPaymentItem]"},"ChiftPage_InvoicingPaymentMethodItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/InvoicingPaymentMethodItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[InvoicingPaymentMethodItem]"},"ChiftPage_InvoicingVatCode_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/InvoicingVatCode"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[InvoicingVatCode]"},"ChiftPage_JournalEntryMonoAnalyticPlan_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/JournalEntryMonoAnalyticPlan"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[JournalEntryMonoAnalyticPlan]"},"ChiftPage_JournalEntryMultiAnalyticPlan_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/JournalEntryMultiAnalyticPlan"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[JournalEntryMultiAnalyticPlan]"},"ChiftPage_Journal_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Journal"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[Journal]"},"ChiftPage_MiscellaneousOperationOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/MiscellaneousOperationOut"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[MiscellaneousOperationOut]"},"ChiftPage_ObjectivesItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ObjectivesItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[ObjectivesItem]"},"ChiftPage_OpportunityItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/OpportunityItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[OpportunityItem]"},"ChiftPage_OrderItemOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/OrderItemOut"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[OrderItemOut]"},"ChiftPage_OutstandingItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/OutstandingItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[OutstandingItem]"},"ChiftPage_PMSAccountingCategoryItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PMSAccountingCategoryItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[PMSAccountingCategoryItem]"},"ChiftPage_PMSAccountingTransactionItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PMSAccountingTransactionItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[PMSAccountingTransactionItem]"},"ChiftPage_PMSCustomerItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PMSCustomerItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[PMSCustomerItem]"},"ChiftPage_PMSInvoiceFullItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PMSInvoiceFullItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[PMSInvoiceFullItem]"},"ChiftPage_PMSLocationItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PMSLocationItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[PMSLocationItem]"},"ChiftPage_PMSOrderItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PMSOrderItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[PMSOrderItem]"},"ChiftPage_PMSPaymentItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PMSPaymentItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[PMSPaymentItem]"},"ChiftPage_PMSPaymentMethods_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PMSPaymentMethods"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[PMSPaymentMethods]"},"ChiftPage_PMSTaxRateItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PMSTaxRateItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[PMSTaxRateItem]"},"ChiftPage_POSCustomerItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/POSCustomerItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[POSCustomerItem]"},"ChiftPage_POSLocationItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/POSLocationItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[POSLocationItem]"},"ChiftPage_POSOrderItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/POSOrderItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[POSOrderItem]"},"ChiftPage_POSPaymentItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/POSPaymentItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[POSPaymentItem]"},"ChiftPage_POSProductItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/POSProductItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[POSProductItem]"},"ChiftPage_POSTaxRateItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/POSTaxRateItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[POSTaxRateItem]"},"ChiftPage_PaymentItemOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PaymentItemOut"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[PaymentItemOut]"},"ChiftPage_PaymentLocationItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PaymentLocationItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[PaymentLocationItem]"},"ChiftPage_PaymentMethodItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PaymentMethodItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[PaymentMethodItem]"},"ChiftPage_PaymentMethods_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PaymentMethods"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[PaymentMethods]"},"ChiftPage_Payment_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Payment"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[Payment]"},"ChiftPage_PayoutItemOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PayoutItemOut"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[PayoutItemOut]"},"ChiftPage_ProductCategoryItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ProductCategoryItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[ProductCategoryItem]"},"ChiftPage_ProductItemOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ProductItemOut"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[ProductItemOut]"},"ChiftPage_RefundItemOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/RefundItemOut"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[RefundItemOut]"},"ChiftPage_SchemeItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/SchemeItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[SchemeItem]"},"ChiftPage_SupplierItemOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/SupplierItemOut"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[SupplierItemOut]"},"ChiftPage_SyncExecutionItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/SyncExecutionItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[SyncExecutionItem]"},"ChiftPage_TaxRateItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/TaxRateItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[TaxRateItem]"},"ChiftPage_TransactionItemOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/TransactionItemOut"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"}},"type":"object","required":["items","total","page","size"],"title":"ChiftPage[TransactionItemOut]"},"ClientItemIn":{"properties":{"external_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Reference","description":"External identifier used to link the client in the accounting system with the corresponding client reference in your own system."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"Only used when the client is an individual (is_company=false). Indicates the first name of the client."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Only used when the client is an individual (is_company=false). Indicates the last name of the client."},"name":{"type":"string","minLength":1,"title":"Name","description":"Full name or legal name of the client (individual or company). This is the name that will be displayed in the accounting software."},"function":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Function","description":"Only used when the client is an individual (is_company=false). Indicates the function of the client."},"is_company":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Company","description":"Indicates if the client is an individual or a company.","default":true},"company_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Id","description":"Only used when the client is an individual (is_company=false). Indicates the id of the company linked to the client."},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone","description":"Phone number of the client."},"mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile","description":"Mobile phone number of the client."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Email address of the client."},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language","description":"Language of the client. Format: ISO 639-1 codes."},"internal_notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Notes","description":"Internal notes about the client."},"website":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website","description":"Website of the client."},"vat":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vat","description":"VAT number of the client, used for tax compliance and invoicing. This value is unique per company and can be used as a reliable identifier to match clients between systems."},"iban":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Iban","description":"IBAN account number of the client."},"bank_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Account","description":"Bank account number of the client."},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Indicates the currency of the client (e.g., EUR)."},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Indicates if the client is active.","default":true},"addresses":{"items":{"$ref":"#/components/schemas/AddressItemIn"},"type":"array","title":"Addresses","description":"List of addresses associated with the client."},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number","description":"Number of ledger account assigned to the client in the accounting system as it will appear in the official accounting export file (FEC, SIE, iXBRL, etc.). This is typically the ledger account used for posting receivables. In some systems, each customer has a dedicated account; in others, a shared control account is used and customer balances are tracked in a subledger."}},"type":"object","required":["name","addresses"],"title":"ClientItemIn"},"ClientItemOut":{"properties":{"external_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Reference","description":"External identifier used to link the client in the accounting system with the corresponding client reference in your own system."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"Only used when the client is an individual (is_company=false). Indicates the first name of the client."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Only used when the client is an individual (is_company=false). Indicates the last name of the client."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Full name or legal name of the client (individual or company). This is the name displayed in the accounting software."},"function":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Function","description":"Only used when the client is an individual (is_company=false). Indicates the function of the client."},"is_company":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Company","description":"Indicates if the client is an individual or a company.","default":true},"company_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Id","description":"Only used when the client is an individual (is_company=false). Indicates the id of the company linked to the client."},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone","description":"Phone number of the client."},"mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile","description":"Mobile phone number of the client."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Email address of the client."},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language","description":"Language of the client. Format: ISO 639-1 codes."},"internal_notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Notes","description":"Internal notes about the client."},"website":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website","description":"Website of the client."},"vat":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vat","description":"VAT number of the client."},"iban":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Iban","description":"IBAN account number of the client. DEPRECATED see bank_accounts"},"bank_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Account","description":"Bank account number of the client. DEPRECATED see bank_accounts"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Indicates the currency of the client (e.g., EUR)."},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Indicates if the client is active.","default":true},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number","description":"Ledger account number assigned to the customer in the accounting system as it will appear in the official accounting export file (FEC, SIE, iXBRL, etc.)."},"company_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Number","description":"Id of the associated company, used when the record is a contact person linked to a company."},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"Id of the client in the accounting software. This is the unique identifier used to reference the client in the system."},"last_updated_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Updated On","description":"The last time the client has been updated."},"addresses":{"anyOf":[{"items":{"$ref":"#/components/schemas/AddressItemOut"},"type":"array"},{"type":"null"}],"title":"Addresses","description":"List of addresses associated with the client.","default":[]},"third_party_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Third Party Account","description":"Third party account number/code representing the client in the accounting software."},"bank_accounts":{"anyOf":[{"items":{"$ref":"#/components/schemas/BankAccountsItem"},"type":"array"},{"type":"null"}],"title":"Bank Accounts","description":"List of bank accounts information associated with the client."}},"type":"object","title":"ClientItemOut"},"ClientItemUpdate":{"properties":{"external_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Reference","description":"External identifier used to link the client in the accounting system with the corresponding client reference in your own system."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"Only used when the client is an individual (is_company=false). Indicates the first name of the client."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Only used when the client is an individual (is_company=false). Indicates the last name of the client."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Full name or legal name of the client (individual or company). This is the name that will be displayed in the accounting software."},"function":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Function","description":"Only used when the client is an individual (is_company=false). Indicates the function of the client."},"is_company":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Company","description":"Indicates if the client is an individual or a company.","default":true},"company_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Id","description":"Only used when the client is an individual (is_company=false). Indicates the id of the company linked to the client."},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone","description":"Phone number of the client."},"mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile","description":"Mobile phone number of the client."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Email address of the client."},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language","description":"Language of the client. Format: ISO 639-1 codes."},"internal_notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Notes","description":"Internal notes about the client."},"website":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website","description":"Website of the client."},"vat":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vat","description":"VAT number of the client, used for tax compliance and invoicing. This value is unique per company and can be used as a reliable identifier to match clients between systems."},"iban":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Iban","description":"IBAN account number of the client."},"bank_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Account","description":"Bank account number of the client."},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Indicates the currency of the client (e.g., EUR)."},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Indicates if the client is active.","default":true},"addresses":{"anyOf":[{"items":{"$ref":"#/components/schemas/AddressItemOut"},"type":"array"},{"type":"null"}],"title":"Addresses","description":"List of addresses associated with the client.","default":[]}},"type":"object","title":"ClientItemUpdate"},"ClosureItem":{"properties":{"date":{"type":"string","format":"date","title":"Date","description":"Date of the closure","examples":["2025-01-01"]},"status":{"$ref":"#/components/schemas/ClosureStates","description":"Status of the closure","examples":["closed"]},"closures":{"anyOf":[{"items":{"$ref":"#/components/schemas/POSClosureInformationItem"},"type":"array"},{"type":"null"}],"title":"Closures","description":"Info about closures related to specific day","default":[]}},"type":"object","required":["date","status"],"title":"ClosureItem"},"ClosurePaymentItem":{"properties":{"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Id","description":"Unique identifier of the payment method used for the payment","examples":["payment_method-1"]},"payment_method_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Name","description":"Chift's name of the payment method used for the payment","examples":["Cash"]},"tip":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Tip","description":"Total amount of the tips of the payment. Tips are not part of the total of the payment","default":"0","examples":[1]},"total":{"type":"number","title":"Total","description":"Total amount including tax","examples":[11]}},"type":"object","required":["total"],"title":"ClosurePaymentItem"},"ClosureStates":{"type":"string","enum":["open","closed"],"title":"ClosureStates"},"CommerceAddressItemIn":{"properties":{"first_name":{"type":"string","title":"First Name"},"last_name":{"type":"string","title":"Last Name"},"street":{"type":"string","title":"Street"},"number":{"type":"string","title":"Number"},"box":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box"},"city":{"type":"string","title":"City"},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postal Code"},"country":{"type":"string","title":"Country","description":"Format: ISO 3166-1 codes."},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"}},"type":"object","required":["first_name","last_name","street","number","city","country"],"title":"CommerceAddressItemIn"},"CommerceAddressItemOut":{"properties":{"address_type":{"$ref":"#/components/schemas/AddressType"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name"},"street":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street"},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number"},"box":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postal Code"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Format: ISO 3166-1 codes."},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"vat":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vat"}},"type":"object","required":["address_type"],"title":"CommerceAddressItemOut"},"CommerceCustomerItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language","description":"Format: ISO 639-1 codes."},"internal_notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Notes"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Indicates the currency of the client (e.g. EUR)."},"addresses":{"anyOf":[{"items":{"$ref":"#/components/schemas/CommerceAddressItemOut"},"type":"array"},{"type":"null"}],"title":"Addresses","default":[]},"created_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created On"}},"type":"object","required":["id","source_ref"],"title":"CommerceCustomerItem"},"CommerceDiscountItem":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"amount":{"type":"number","title":"Amount"}},"type":"object","required":["name","description","amount"],"title":"CommerceDiscountItem"},"CommerceLocationItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the location in Chift"},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","name"],"title":"CommerceLocationItem"},"CommerceLocationItemOut":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the location in Chift"},"name":{"type":"string","title":"Name"},"source_ref":{"anyOf":[{"$ref":"#/components/schemas/Ref"},{"type":"null"}],"description":"Technical id of the location in the target software"}},"type":"object","required":["id","name"],"title":"CommerceLocationItemOut"},"CommerceProductCategoryItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the category in Chift"},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","name"],"title":"CommerceProductCategoryItem"},"CommerceProductItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"description_html":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description Html"},"categories":{"anyOf":[{"items":{"$ref":"#/components/schemas/CommerceProductCategoryItem"},"type":"array"},{"type":"null"}],"title":"Categories","default":[]},"created_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created On"},"last_updated_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Updated On"},"variants":{"anyOf":[{"items":{"$ref":"#/components/schemas/ProductVariantItem"},"type":"array"},{"type":"null"}],"title":"Variants","default":[]},"status":{"anyOf":[{"$ref":"#/components/schemas/ProductStatus"},{"type":"null"}]},"sku":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sku"},"common_attributes":{"anyOf":[{"items":{"$ref":"#/components/schemas/CommonAttributeItem"},"type":"array"},{"type":"null"}],"title":"Common Attributes","description":"List of attributes that are shared by all variants of the product.","default":[]},"variant_attributes_options":{"anyOf":[{"items":{"$ref":"#/components/schemas/VariantAttributeOptionItem"},"type":"array"},{"type":"null"}],"title":"Variant Attributes Options","default":[]},"common_images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageItem"},"type":"array"},{"type":"null"}],"title":"Common Images","description":"List of images that are shared by all variants of the product.","default":[]}},"type":"object","required":["id","source_ref","name"],"title":"CommerceProductItem"},"CommerceProductPriceItem":{"properties":{"currency":{"type":"string","title":"Currency"},"price":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Price","default":0}},"type":"object","required":["currency"],"title":"CommerceProductPriceItem"},"CommerceTransactionStatus":{"type":"string","enum":["failed","pending","success"],"title":"CommerceTransactionStatus"},"CommonAttributeItem":{"properties":{"name":{"type":"string","title":"Name"},"values":{"items":{"type":"string"},"type":"array","title":"Values"}},"type":"object","required":["name","values"],"title":"CommonAttributeItem"},"ConnectionItem":{"properties":{"connectionid":{"type":"string","format":"uuid","title":"Connectionid"},"name":{"type":"string","title":"Name"},"integration":{"type":"string","title":"Integration"},"integrationid":{"type":"integer","title":"Integrationid"},"api":{"type":"string","title":"Api"},"data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Data"},"status":{"$ref":"#/components/schemas/ConnectionStatus"},"agent":{"anyOf":[{"$ref":"#/components/schemas/LocalAgentInfo"},{"type":"null"}],"description":"For local agent only. Indicates whether the local agent is up and running"}},"type":"object","required":["connectionid","name","integration","integrationid","api","status"],"title":"ConnectionItem"},"ConnectionStatus":{"type":"string","enum":["active","inactive"],"title":"ConnectionStatus"},"ConsumerItem":{"properties":{"consumerid":{"type":"string","format":"uuid","title":"Consumerid","description":"Unique id of the consumer in Chift"},"name":{"type":"string","minLength":1,"title":"Name","description":"Name of the consumer as it will appear in your Chift platform. This name may be used for automated communications, such as automatic mailings if you enable this feature"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Optional - Email address of the consumer. It can be used for sending automated reminders (if the feature is enabled) and deployment by mail of local agent (when on-premise connector)."},"internal_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Reference","description":"Your internal reference for the client (e.g., customer ID or unique identifier in your system)."},"redirect_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Redirect Url","description":"URL to redirect the user after completing the activation via our link. Useful for directing customers to a dynamic or personalized url. You can also set up a default static URL in Chift's back office for all consumers."}},"type":"object","required":["consumerid","name"],"title":"ConsumerItem"},"ContactGender":{"type":"string","enum":["H","F","N/A"],"title":"ContactGender"},"ContactItem":{"properties":{"id":{"type":"string","title":"Id","description":"Unique id of the contact in the accounting system."},"name":{"type":"string","title":"Name","description":"Full name of the contact."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"First name of the contact."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Last name of the contact."},"function":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Function","description":"Business role or job title of the contact."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Email address of the contact."},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone","description":"Phone number of the contact."},"mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile","description":"Mobile phone number of the contact."}},"type":"object","required":["id","name"],"title":"ContactItem"},"ContactItemIn":{"properties":{"is_prospect":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Prospect","description":"Is a prospect?"},"is_customer":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Customer","description":"Is a customer?"},"is_supplier":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Supplier","description":"Is a supplier?"},"is_company":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Company","description":"Is a company?"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name","description":"Name of the company"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"Firstname"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Lastname"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Email"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone","description":"Phone"},"mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile","description":"Mobile"},"company_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Id","description":"Technical id of the contact' company in Chift"},"vat":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vat","description":"VAT number"},"company_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Number","description":"Company number (identification number different than the VAT (e.g. siret))"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Currency matching target sofware name"},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language","description":"Language matching target sofware name"},"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Comment","description":"Comment"},"customer_account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Account Number","description":"Number of the accounting account used for sales (e.g. 701000)"},"supplier_account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Supplier Account Number","description":"Number of the accounting account used for purchases (e.g. 601000)"},"birthdate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Birthdate","description":"Birthdate"},"gender":{"anyOf":[{"$ref":"#/components/schemas/ContactGender"},{"type":"null"}],"description":"Gender"},"addresses":{"anyOf":[{"items":{"$ref":"#/components/schemas/AddressItemInInvoicing"},"type":"array"},{"type":"null"}],"title":"Addresses","description":"Addresses","default":[]}},"type":"object","title":"ContactItemIn"},"ContactItemOut":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"is_prospect":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Prospect","description":"Is a prospect?"},"is_customer":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Customer","description":"Is a customer?"},"is_supplier":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Supplier","description":"Is a supplier?"},"is_company":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Company","description":"Is a company?"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name","description":"Name of the company"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"Firstname"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Lastname"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Email"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone","description":"Phone"},"mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile","description":"Mobile"},"company_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Id","description":"Technical id of the contact' company in Chift"},"vat":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vat","description":"VAT number"},"company_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Number","description":"Company number (identification number different than the VAT (e.g. siret))"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Currency matching target sofware name"},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language","description":"Language matching target sofware name"},"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Comment","description":"Comment"},"customer_account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Account Number","description":"Number of the accounting account used for sales (e.g. 701000)"},"supplier_account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Supplier Account Number","description":"Number of the accounting account used for purchases (e.g. 601000)"},"birthdate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Birthdate","description":"Birthdate"},"gender":{"anyOf":[{"$ref":"#/components/schemas/ContactGender"},{"type":"null"}],"description":"Gender"},"addresses":{"anyOf":[{"items":{"$ref":"#/components/schemas/AddressItemOutInvoicing"},"type":"array"},{"type":"null"}],"title":"Addresses","description":"Addresses","default":[]},"external_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Reference","description":"External reference of the contact in the invoicing system"}},"type":"object","required":["id","source_ref"],"title":"ContactItemOut"},"ContactType":{"type":"string","enum":["prospect","customer","supplier","all"],"title":"ContactType"},"CountryItem":{"properties":{"code":{"type":"string","title":"Code","description":"Country ISO Code"},"name":{"type":"string","title":"Name"}},"type":"object","required":["code","name"],"title":"CountryItem"},"CoverageItem":{"properties":{"operation":{"type":"string","title":"Operation"},"status":{"$ref":"#/components/schemas/CoverageStatus"}},"type":"object","required":["operation","status"],"title":"CoverageItem"},"CoverageStatus":{"type":"string","enum":["SUPPORTED","NOT_IMPLEMENTED","NOT_SUPPORTED","UNDER_ANALYSIS"],"title":"CoverageStatus"},"CreateConsumerSyncItem":{"properties":{"syncid":{"type":"string","format":"uuid","title":"Syncid"},"integrationids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Integrationids","description":"[OPTIONAL] Can be used to specify maximum one integrationid for each One API that you want to highlight. If specified, only this connector will be displayed to your clients.","default":[]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"ISO 3166-1 alpha-2 country code to filter connectors by country. Ignored if integrationids are provided."},"link_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Link Metadata"}},"type":"object","required":["syncid"],"title":"CreateConsumerSyncItem"},"CreateFlowItem":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"execution":{"$ref":"#/components/schemas/FlowExecution"},"config":{"anyOf":[{"$ref":"#/components/schemas/FlowConfig-Input"},{"type":"null"}],"default":{"datastores":[]}},"triggers":{"items":{"$ref":"#/components/schemas/FlowTrigger"},"type":"array","title":"Triggers"}},"type":"object","required":["name","execution","triggers"],"title":"CreateFlowItem"},"CreateSyncItem":{"properties":{"name":{"type":"string","minLength":1,"title":"Name"},"config":{"anyOf":[{"additionalProperties":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"propertyNames":{"const":"presync"},"type":"object"},{"type":"null"}],"title":"Config"},"connections":{"items":{"$ref":"#/components/schemas/SyncsConnectionItem"},"type":"array","title":"Connections"},"mappings":{"items":{"$ref":"#/components/schemas/CreateSyncMappingItem-Input"},"type":"array","title":"Mappings","default":[]},"flows":{"items":{"$ref":"#/components/schemas/CreateFlowItem"},"type":"array","title":"Flows","default":[]}},"type":"object","required":["name","connections"],"title":"CreateSyncItem"},"CreateSyncMappingItem-Input":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"display_order":{"type":"integer","title":"Display Order","default":0},"challenge_question":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Challenge Question"},"conditions":{"anyOf":[{"additionalProperties":{"additionalProperties":true,"type":"object"},"propertyNames":{"const":"hideIf"},"type":"object"},{"type":"null"}],"title":"Conditions"},"sub_mappings":{"items":{"$ref":"#/components/schemas/CreateSyncMappingToFieldItem-Input"},"type":"array","title":"Sub Mappings","default":[]}},"type":"object","required":["name"],"title":"CreateSyncMappingItem"},"CreateSyncMappingItem-Output":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"display_order":{"type":"integer","title":"Display Order","default":0},"challenge_question":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Challenge Question"},"conditions":{"anyOf":[{"additionalProperties":{"additionalProperties":true,"type":"object"},"propertyNames":{"const":"hideIf"},"type":"object"},{"type":"null"}],"title":"Conditions"},"sub_mappings":{"items":{"$ref":"#/components/schemas/CreateSyncMappingToFieldItem-Output"},"type":"array","title":"Sub Mappings","default":[]}},"type":"object","required":["name"],"title":"CreateSyncMappingItem"},"CreateSyncMappingToFieldItem-Input":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"display_order":{"type":"integer","title":"Display Order","default":0},"challenge_question":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Challenge Question"},"conditions":{"anyOf":[{"additionalProperties":{"additionalProperties":true,"type":"object"},"propertyNames":{"const":"hideIf"},"type":"object"},{"type":"null"}],"title":"Conditions"},"source_field":{"$ref":"#/components/schemas/FieldItem"},"target_field":{"$ref":"#/components/schemas/FieldItem"},"display_delete":{"type":"boolean","title":"Display Delete","default":false},"logic":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Logic"}},"type":"object","required":["name","source_field","target_field"],"title":"CreateSyncMappingToFieldItem"},"CreateSyncMappingToFieldItem-Output":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"display_order":{"type":"integer","title":"Display Order","default":0},"challenge_question":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Challenge Question"},"conditions":{"anyOf":[{"additionalProperties":{"additionalProperties":true,"type":"object"},"propertyNames":{"const":"hideIf"},"type":"object"},{"type":"null"}],"title":"Conditions"},"source_field":{"$ref":"#/components/schemas/FieldItem"},"target_field":{"$ref":"#/components/schemas/FieldItem"},"display_delete":{"type":"boolean","title":"Display Delete","default":false},"logic":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Logic"}},"type":"object","required":["name","source_field","target_field"],"title":"CreateSyncMappingToFieldItem"},"CredentialItem":{"properties":{"key":{"type":"string","title":"Key"},"value":{"type":"string","title":"Value"}},"type":"object","required":["key","value"],"title":"CredentialItem"},"DataItem":{"properties":{"data":{"additionalProperties":true,"type":"object","title":"Data"}},"type":"object","required":["data"],"title":"DataItem"},"DataItemOut":{"properties":{"data":{"additionalProperties":true,"type":"object","title":"Data"},"id":{"type":"string","title":"Id"},"created_on":{"type":"string","format":"date-time","title":"Created On"},"modified_on":{"type":"string","format":"date-time","title":"Modified On"}},"type":"object","required":["data","id","created_on","modified_on"],"title":"DataItemOut"},"DataStoreItem":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"status":{"anyOf":[{"$ref":"#/components/schemas/DatastoreStatus"},{"type":"null"}],"default":"active"},"definition":{"$ref":"#/components/schemas/DatastoreDef"}},"type":"object","required":["id","name","definition"],"title":"DataStoreItem"},"DatalayerEnableBody":{"properties":{"from_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"From Date","description":"Date from which the data is synced. Defaults to one year ago when omitted."}},"type":"object","title":"DatalayerEnableBody"},"DatalayerRefreshBody":{"properties":{"force_from_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Force From Date","description":"Force the refresh to (re)sync data from this date, overriding the flow configuration."}},"type":"object","title":"DatalayerRefreshBody"},"DatastoreColumn":{"properties":{"name":{"type":"string","title":"Name"},"title":{"type":"string","title":"Title"},"type":{"type":"string","title":"Type"},"optional":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Optional","default":false}},"type":"object","required":["name","title","type"],"title":"DatastoreColumn"},"DatastoreDef":{"properties":{"columns":{"items":{"$ref":"#/components/schemas/DatastoreColumn"},"type":"array","title":"Columns"},"search_column":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Column","description":"Column name that will be indexed and used in search if any."}},"type":"object","required":["columns"],"title":"DatastoreDef"},"DatastoreStatus":{"type":"string","enum":["active","inactive"],"title":"DatastoreStatus"},"DiscountItem":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the discount","examples":["Percentage discount"]},"total":{"type":"number","title":"Total","description":"Total amount of the discount","examples":[10]},"type":{"$ref":"#/components/schemas/DiscountType","description":"Type of the discount","default":"UNKNOWN","examples":["offered"]}},"type":"object","required":["total"],"title":"DiscountItem"},"DiscountType":{"type":"string","enum":["OFFERED","UNKNOWN","LOSS"],"title":"DiscountType"},"DocumentType":{"type":"string","enum":["invoice","entry"],"title":"DocumentType"},"EcommerceFulfillmentObject":{"properties":{"fulfillment_type":{"$ref":"#/components/schemas/EcommerceFulfillmentType"},"shipping_from_address":{"anyOf":[{"$ref":"#/components/schemas/AddressItemOut"},{"type":"null"}]}},"type":"object","required":["fulfillment_type"],"title":"EcommerceFulfillmentObject"},"EcommerceFulfillmentType":{"type":"string","enum":["FBA","FBM"],"title":"EcommerceFulfillmentType"},"EmployeeItem":{"properties":{"id":{"type":"string","title":"Id","description":"Unique id of the employee in the accounting system."},"name":{"type":"string","title":"Name","description":"Full name or legal name of the employee as it appears in the accounting system."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"First name of the employee."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Last name of the employee."},"function":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Function","description":"Job title or function of the employee."},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone","description":"Phone number of the employee."},"mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile","description":"Mobile phone number of the employee."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Email address of the employee."},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Indicates if the employee is active.","default":true},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference","description":"External reference or identifier for the employee."},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number","description":"Ledger account number assigned to the employee in the accounting system as it will appear in the official accounting export file (FEC, SIE, iXBRL, etc.)"}},"type":"object","required":["id","name"],"title":"EmployeeItem"},"EnableFlowConsumer":{"properties":{"integrationids":{"items":{"type":"string"},"type":"array","title":"Integrationids","description":"List of integrationids of the connections that will be used to enable the flow","default":[]},"triggerid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Triggerid","default":"trigger-1"},"cronschedule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cronschedule"},"data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Data","description":"Object containing the configuration of the flow for the consumer","default":{}}},"type":"object","title":"EnableFlowConsumer"},"EntryLineType":{"type":"string","enum":["customer_account","supplier_account","employee_account","general_account"],"title":"EntryLineType"},"ErrorInfo":{"properties":{"error_code":{"type":"string","title":"Error Code"},"status":{"type":"string","title":"Status"},"title":{"type":"string","title":"Title"},"description":{"type":"string","title":"Description"}},"type":"object","required":["error_code","status","title"],"title":"ErrorInfo"},"ExecutionType":{"type":"string","enum":["code","module"],"title":"ExecutionType"},"ExpenseItemIn":{"properties":{"employee_id":{"type":"string","title":"Employee Id","description":"Employee identifier in the accounting system."},"total":{"type":"number","title":"Total","description":"Total amount including taxes for the expense."},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Total untaxed amount for the expense."},"tax_amount":{"type":"number","title":"Tax Amount","description":"Total tax amount for the expense."},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference","description":"External reference."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number","description":"Unique number for idempotency in the accounting system."},"currency":{"type":"string","title":"Currency","description":"Currency of the expense (e.g., EUR, USD)."},"currency_exchange_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Currency Exchange Rate","description":"Exchange rate at expense date if currency differs from folder currency. Must be positive if provided.","default":1},"date":{"type":"string","format":"date","title":"Date","description":"Expense date."},"pdf":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pdf","description":"Base64 PDF attachment of the expense document."},"pdf_name":{"anyOf":[{"type":"string","maxLength":200,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_ ]{1,196}(?:.pdf)?$"},{"type":"null"}],"title":"Pdf Name","description":"A name for the PDF file to be created for accounting software that support it."},"lines":{"items":{"$ref":"#/components/schemas/ExpenseLineItem"},"type":"array","minItems":1,"title":"Lines","description":"Expense lines."}},"type":"object","required":["employee_id","total","untaxed_amount","tax_amount","currency","date","lines"],"title":"ExpenseItemIn"},"ExpenseItemOut":{"properties":{"employee_id":{"type":"string","title":"Employee Id","description":"Employee identifier in the accounting system."},"total":{"type":"number","title":"Total","description":"Total amount including taxes for the expense."},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Total untaxed amount for the expense."},"tax_amount":{"type":"number","title":"Tax Amount","description":"Total tax amount for the expense."},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference","description":"External reference."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number","description":"Unique number for idempotency in the accounting system."},"currency":{"type":"string","title":"Currency","description":"Currency of the expense (e.g., EUR, USD)."},"currency_exchange_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Currency Exchange Rate","description":"Exchange rate at expense date if currency differs from folder currency. Must be positive if provided.","default":1},"date":{"type":"string","format":"date","title":"Date","description":"Expense date."},"pdf":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pdf","description":"Base64 PDF attachment of the expense document."},"pdf_name":{"anyOf":[{"type":"string","maxLength":200,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_ ]{1,196}(?:.pdf)?$"},{"type":"null"}],"title":"Pdf Name","description":"A name for the PDF file to be created for accounting software that support it."},"lines":{"items":{"$ref":"#/components/schemas/ExpenseLineItem"},"type":"array","minItems":1,"title":"Lines","description":"Expense lines."},"id":{"type":"string","title":"Id","description":"Unique id of the expense in the accounting system."}},"type":"object","required":["employee_id","total","untaxed_amount","tax_amount","currency","date","lines","id"],"title":"ExpenseItemOut"},"ExpenseLineItem":{"properties":{"total":{"type":"number","title":"Total","description":"Total amount for the line including taxes."},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Untaxed amount for the line."},"tax_amount":{"type":"number","title":"Tax Amount","description":"Tax amount for the line."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Line description"},"account_number":{"type":"string","title":"Account Number","description":"General ledger account number to book the expense."},"tax_rate":{"type":"number","title":"Tax Rate","description":"Tax rate (e.g., 21.0 for 21%)."},"tax_id":{"type":"string","title":"Tax Id","description":"Tax identifier to validate against the provided tax_rate."}},"type":"object","required":["total","untaxed_amount","tax_amount","account_number","tax_rate","tax_id"],"title":"ExpenseLineItem"},"ExtendedIssueItem":{"properties":{"id":{"type":"string","title":"Id"},"consumer_id":{"type":"string","title":"Consumer Id"},"connection_id":{"type":"string","title":"Connection Id"},"integration_id":{"type":"integer","title":"Integration Id"},"integration_name":{"type":"string","title":"Integration Name"},"created_on":{"type":"string","format":"date-time","title":"Created On"},"updated_on":{"type":"string","format":"date-time","title":"Updated On"},"last_seen":{"type":"string","format":"date-time","title":"Last Seen"},"error":{"$ref":"#/components/schemas/ErrorInfo"},"occurrences":{"type":"integer","title":"Occurrences"},"level":{"$ref":"#/components/schemas/IssueLevel"},"events":{"items":{"$ref":"#/components/schemas/IssueEvent"},"type":"array","title":"Events","default":[]}},"type":"object","required":["id","consumer_id","connection_id","integration_id","integration_name","created_on","updated_on","last_seen","error","occurrences","level"],"title":"ExtendedIssueItem"},"FECItemOut":{"properties":{"JournalCode":{"type":"string","title":"Journalcode"},"JournalLib":{"type":"string","title":"Journallib"},"EcritureNum":{"type":"string","title":"Ecriturenum"},"EcritureDate":{"type":"string","format":"date","title":"Ecrituredate"},"CompteNum":{"type":"string","title":"Comptenum"},"CompteLib":{"type":"string","title":"Comptelib"},"CompAuxNum":{"type":"string","title":"Compauxnum"},"CompAuxLib":{"type":"string","title":"Compauxlib"},"PieceRef":{"type":"string","title":"Pieceref"},"PieceDate":{"type":"string","format":"date","title":"Piecedate"},"Debit":{"type":"number","title":"Debit"},"Credit":{"type":"number","title":"Credit"},"EcritureLet":{"type":"string","title":"Ecriturelet"},"DateLet":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Datelet"},"ValidDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Validdate"},"Montantdevise":{"type":"number","title":"Montantdevise"},"Idevise":{"type":"string","title":"Idevise"}},"type":"object","required":["JournalCode","JournalLib","EcritureNum","EcritureDate","CompteNum","CompteLib","CompAuxNum","CompAuxLib","PieceRef","PieceDate","Debit","Credit","EcritureLet","DateLet","ValidDate","Montantdevise","Idevise"],"title":"FECItemOut"},"FeesItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"created_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created On"},"type":{"$ref":"#/components/schemas/FeesType"},"removed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Removed","description":"Indicates if the fee has been removed from the order","default":false},"tax_rate":{"type":"number","title":"Tax Rate"},"tax_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Id","description":"Technical id of the tax rate in Chift"},"discounts":{"anyOf":[{"items":{"$ref":"#/components/schemas/CommerceDiscountItem"},"type":"array"},{"type":"null"}],"title":"Discounts","default":[]},"untaxed_amount":{"type":"number","title":"Untaxed Amount"},"tax_amount":{"type":"number","title":"Tax Amount"},"total":{"type":"number","title":"Total"}},"type":"object","required":["id","source_ref","type","tax_rate","untaxed_amount","tax_amount","total"],"title":"FeesItem"},"FeesType":{"type":"string","enum":["shipping","other"],"title":"FeesType"},"FieldItem":{"properties":{"name":{"type":"string","title":"Name"},"type":{"$ref":"#/components/schemas/FieldItemType"},"display_condition":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Display Condition"},"values":{"anyOf":[{"items":{"$ref":"#/components/schemas/FieldItemValue"},"type":"array"},{"type":"null"}],"title":"Values","default":[]},"api_route":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Route"},"connection_type":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Connection Type"}},"type":"object","required":["name","type"],"title":"FieldItem"},"FieldItemType":{"type":"string","enum":["fixed","api"],"title":"FieldItemType"},"FieldItemValue":{"properties":{"id":{"type":"string","title":"Id"},"label":{"type":"string","title":"Label"}},"type":"object","required":["id","label"],"title":"FieldItemValue"},"FieldRef":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"Technical id in the target software"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Name of the model/entity in the target software"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Value the field in the target software"}},"type":"object","title":"FieldRef"},"FinancialEntryItemIn":{"properties":{"date":{"type":"string","format":"date","title":"Date","description":"Accounting date of the financial entry (format: YYYY-MM-DD). This is the date when the financial entry is recorded in the accounting system."},"journal_id":{"type":"string","title":"Journal Id","description":"Id of the journal instance in the accounting system in which the financial entry is recorded."},"currency":{"type":"string","title":"Currency","description":"Indicates the currency of the operation (e.g., EUR, USD)."},"currency_exchange_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Currency Exchange Rate","description":"Indicates the exchange rate at the date of the operation. Must be filled in when creating the operation in another currency from the folder's default currency.","default":1},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference","description":"Optional reference field that can be used for lettering by storing an external or contextual identifier related to the entry . For example, it can be used to store a reference number, such as the invoice number associated with the payment."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number","description":"Unique 'number' of the financial entry in the accounting software. This is an internal number or identifier assigned to the financial entry. It is recommended to use this number for idempotency to prevent duplicate entries. Refer to the idempotency documentation in the Developer Guides for more details."},"items":{"items":{"$ref":"#/components/schemas/FinancialEntryLineItem"},"type":"array","minItems":1,"title":"Items"},"pdf":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pdf","description":"Base 64 string representing the PDF attached to the sale/purchase entry."},"pdf_name":{"anyOf":[{"type":"string","maxLength":200,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_ ]{1,196}(?:.pdf)?$"},{"type":"null"}],"title":"Pdf Name","description":"A name for the PDF file to be created for accounting software that support it."}},"type":"object","required":["date","journal_id","currency","items"],"title":"FinancialEntryItemIn"},"FinancialEntryItemOut":{"properties":{"date":{"type":"string","format":"date","title":"Date","description":"Accounting date of the financial entry (format: YYYY-MM-DD). This is the date when the financial entry is recorded in the accounting system."},"journal_id":{"type":"string","title":"Journal Id","description":"Id of the journal instance in the accounting system in which the financial entry is recorded."},"currency":{"type":"string","title":"Currency","description":"Indicates the currency of the operation (e.g., EUR, USD)."},"currency_exchange_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Currency Exchange Rate","description":"Indicates the exchange rate at the date of the operation. Must be filled in when creating the operation in another currency from the folder's default currency.","default":1},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference","description":"Optional reference field that can be used for lettering by storing an external or contextual identifier related to the entry . For example, it can be used to store a reference number, such as the invoice number associated with the payment."},"id":{"type":"string","title":"Id","description":"Unique id of the financial entry instance in the accounting system."},"number":{"type":"string","title":"Number","description":"Unique 'number' of the financial entry in the accounting software. This is an internal number or identifier assigned to the financial entry. It is recommended to use this number for idempotency to prevent duplicate entries. Refer to the idempotency documentation in the Developer Guides for more details."},"items":{"items":{"$ref":"#/components/schemas/FinancialEntryLineItemOut"},"type":"array","title":"Items"}},"type":"object","required":["date","journal_id","currency","id","number","items"],"title":"FinancialEntryItemOut"},"FinancialEntryLineItem":{"properties":{"account_type":{"$ref":"#/components/schemas/EntryLineType","description":"account_type can be either general ('general_account') or thirdparty ('customer', 'supplier' or 'employee')"},"account":{"type":"string","minLength":1,"title":"Account","description":"Depending on account_type, if the account_type is 'general_account', this is the general ledger account number used to book the journal item against. If the account_type is 'customer_account', 'supplier_account' or 'employee_account', this is the thirdparty_id (id of the customer, supplier or employee in the accounting system)."},"amount":{"type":"number","title":"Amount","description":"A positive value represents funds received in the bank or cash account (i.e., the bank/cash account is debited and the specified account_number is credited). A negative value represents funds leaving the bank/cash account."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Text description for this line item. This is typically used to provide additional context or information."},"tax_info":{"anyOf":[{"$ref":"#/components/schemas/TaxInfo"},{"type":"null"}],"description":"Tax information related to the financial entry line item. The provided tax amount is added to the amount of the line item. This is only supported for general accounts."},"automated_matching_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Automated Matching Number","description":"Automated matching number of the financial entry line item. This is used to let the accounting system do an automated matching based on this value. This is not supported on all accounting systems."}},"type":"object","required":["account_type","account","amount"],"title":"FinancialEntryLineItem"},"FinancialEntryLineItemOut":{"properties":{"account_type":{"$ref":"#/components/schemas/EntryLineType","description":"account_type can be either general ('general_account') or thirdparty ('customer', 'supplier' or 'employee')"},"account":{"type":"string","minLength":1,"title":"Account","description":"Depending on account_type, if the account_type is 'general_account', this is the general ledger account number used to book the journal item against. If the account_type is 'customer_account', 'supplier_account' or 'employee_account', this is the thirdparty_id (id of the customer, supplier or employee in the accounting system)."},"amount":{"type":"number","title":"Amount","description":"A positive value represents funds received in the bank or cash account (i.e., the bank/cash account is debited and the specified account_number is credited). A negative value represents funds leaving the bank/cash account."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Text description for this line item. This is typically used to provide additional context or information."},"tax_info":{"anyOf":[{"$ref":"#/components/schemas/TaxInfo"},{"type":"null"}],"description":"Tax information related to the financial entry line item. The provided tax amount is added to the amount of the line item. This is only supported for general accounts."},"automated_matching_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Automated Matching Number","description":"Automated matching number of the financial entry line item. This is used to let the accounting system do an automated matching based on this value. This is not supported on all accounting systems."},"counterpart_account":{"type":"string","title":"Counterpart Account"}},"type":"object","required":["account_type","account","amount","counterpart_account"],"title":"FinancialEntryLineItemOut"},"FlowConfig-Input":{"properties":{"definitionFields":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Definitionfields"},"doorkeyFields":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Doorkeyfields"},"customFields":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Customfields"},"datastores":{"anyOf":[{"items":{"$ref":"#/components/schemas/FlowDataStoreItem-Input"},"type":"array"},{"type":"null"}],"title":"Datastores","default":[]}},"type":"object","title":"FlowConfig"},"FlowConfig-Output":{"properties":{"definitionFields":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Definitionfields"},"doorkeyFields":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Doorkeyfields"},"customFields":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Customfields"},"datastores":{"anyOf":[{"items":{"$ref":"#/components/schemas/FlowDataStoreItem-Output"},"type":"array"},{"type":"null"}],"title":"Datastores","default":[]}},"type":"object","title":"FlowConfig"},"FlowDataStoreItem-Input":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"name":{"type":"string","title":"Name"},"status":{"anyOf":[{"$ref":"#/components/schemas/DatastoreStatus"},{"type":"null"}],"default":"active"},"definition":{"$ref":"#/components/schemas/DatastoreDef"}},"type":"object","required":["name","definition"],"title":"FlowDataStoreItem"},"FlowDataStoreItem-Output":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"name":{"type":"string","title":"Name"},"status":{"anyOf":[{"$ref":"#/components/schemas/DatastoreStatus"},{"type":"null"}],"default":"active"},"definition":{"$ref":"#/components/schemas/DatastoreDef"}},"type":"object","required":["name","definition"],"title":"FlowDataStoreItem"},"FlowExecution":{"properties":{"type":{"$ref":"#/components/schemas/ExecutionType"},"data":{"anyOf":[{"$ref":"#/components/schemas/FlowExecutionChain"},{"$ref":"#/components/schemas/FlowExecutionCode"},{"type":"null"}],"title":"Data"}},"type":"object","required":["type","data"],"title":"FlowExecution"},"FlowExecutionChain":{"properties":{"name":{"type":"string","title":"Name"}},"type":"object","required":["name"],"title":"FlowExecutionChain"},"FlowExecutionCode":{"properties":{"code":{"type":"string","title":"Code"}},"type":"object","required":["code"],"title":"FlowExecutionCode"},"FlowTrigger":{"properties":{"id":{"type":"string","title":"Id"},"type":{"$ref":"#/components/schemas/TriggerType"},"cronschedules":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Cronschedules"},"visible":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Visible","default":true},"definitionFields":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Definitionfields"},"options":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Options"},"priority":{"$ref":"#/components/schemas/TriggerPriority","default":"NORMAL"}},"type":"object","required":["id","type"],"title":"FlowTrigger"},"FolderAddressItem":{"properties":{"street":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street"},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number"},"box":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box"},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postal Code"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Format: ISO 3166-1 codes."}},"type":"object","title":"FolderAddressItem"},"FolderItem":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"selected":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Selected","default":true},"vat":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vat"},"company_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Number"},"main_currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Main Currency","description":"Format: ISO 3166-1 codes."},"addresses":{"anyOf":[{"items":{"$ref":"#/components/schemas/FolderAddressItem"},"type":"array"},{"type":"null"}],"title":"Addresses"}},"type":"object","required":["id","name"],"title":"FolderItem"},"GenericJournalEntry":{"properties":{"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference","description":"Optional reference field used to store an external or contextual identifier related to the entry. For example, it can be used to store a reference number, the invoice number issued by the suppllier or any other relevant information."},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date","description":"If the journal entry relates to an invoice, this is the due date for payment or settlement (format: YYYY-MM-DD)."},"journal_id":{"type":"string","title":"Journal Id","description":"Id of the journal instance in the accounting system in which the journal entry is recorded."},"number":{"type":"string","minLength":1,"title":"Number","description":"Unique 'number' of the journal entry in the accounting software. This is an internal number or ID assigned to the journal entry, not necessarily the label or number visible on an invoice. It is recommended to use this number for idempotency to prevent duplicate entries. Refer to the idempotency documentation in the Developer Guides for more details."},"currency":{"type":"string","minLength":1,"title":"Currency","description":"Indicates the currency of the journal entry (e.g., EUR, USD)."},"currency_exchange_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Currency Exchange Rate","description":"Indicates the exchange rate at the date of the journal entry. Must be filled in when creating the entry in another currency from the folder's default currency.","default":1},"date":{"type":"string","format":"date","title":"Date","description":"Accounting date of the journal entry (format: YYYY-MM-DD). This is the date when the journal entry is recorded in the accounting system."},"items":{"items":{"$ref":"#/components/schemas/GenericJournalItem"},"type":"array","minItems":2,"title":"Items","description":"List of journal items that make up the journal entry. Each item represents a line in the journal entry, and the sum of debits must equal the sum of credits to ensure the entry is balanced. There must always be at least 2 lines/items."},"pdf":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pdf","description":"Base 64 string representing the PDF attached to the item."},"pdf_name":{"anyOf":[{"type":"string","maxLength":200,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_ ]{1,196}(?:.pdf)?$"},{"type":"null"}],"title":"Pdf Name","description":"A name for the PDF file to be created for accounting software that support it."},"posted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Posted","description":"Indicates if the journal entry has been posted (finalized) in the accounting system. If not provided, it defaults to True.","default":true},"start_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Start Date","description":"Start date of the period covered by the journal entry (format: YYYY-MM-DD). This field should be used when the entry relates to prepaid income or expenses (accruals and deferrals), indicating when the covered period begins."},"end_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"End Date","description":"End date of the period covered by the journal entry (format: YYYY-MM-DD). This field should be used when the entry relates to prepaid income or expenses (accruals and deferrals), indicating when the covered period ends."}},"type":"object","required":["journal_id","number","currency","date","items"],"title":"GenericJournalEntry"},"GenericJournalItem":{"properties":{"account_type":{"$ref":"#/components/schemas/EntryLineType","description":"account_type can be either general ('general_account') or thirdparty ('customer', 'supplier' or 'employee')"},"account":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Account","description":"Depending on account_type, if the account_type is 'general_account', this is the general ledger account number used to book the journal item against. If the account_type is 'customer_account', 'supplier_account' or 'employee_account', this is the thirdparty_id (id of the customer, supplier or employee in the accounting system)."},"force_general_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Force General Account","description":"Overrides the default general account for customer, supplier, or employee accounts. If provided, this value will be used as the general account instead of the one determined by the accounting system's configuration."},"prioritise_thirdparty_account":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Prioritise Thirdparty Account","description":"If True, prioritize using the third-party account information when a general account is forced in accounting software that only allows one account. Recommended to set it to True","default":false},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Text description for this journal item. This is typically used to provide additional context or information."},"debit":{"type":"number","title":"Debit","description":"Amount to debit on the account. Must be 0 if credit line is not 0"},"credit":{"type":"number","title":"Credit","description":"Amount to credit on the account. Must be 0 if debit line is not 0"},"analytic_distribution":{"anyOf":[{"items":{"$ref":"#/components/schemas/AnalyticDistribution"},"type":"array"},{"type":"null"}],"title":"Analytic Distribution","description":"List of analytic distributions for the journal item. Each distribution specifies an analytic plan and the allocation of the journal entry item's amount across analytic accounts using percentages.","default":[]},"tax_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Code","description":"Indicates the Tax Code used for the entry item. This is the Id of the Tax Code instance in the accounting software."},"tax_info":{"anyOf":[{"$ref":"#/components/schemas/TaxInfo"},{"type":"null"}],"description":"Tax information related to the journal item. The provided tax amount is added to the amount (debit or credit) of the journal item. This is only supported for general accounts."},"account_info":{"anyOf":[{"$ref":"#/components/schemas/AccountToCreate"},{"type":"null"}],"description":"(For certain specific connectors only) Details of the third-party account (client/supplier) to be created if it does not already exist in the accounting system. Some softwares do not support creating third-party accounts via API; in such cases, this information must be provided to allow the accounting software to automatically create the missing account (e.g., for Tiime)."}},"type":"object","required":["account_type","debit","credit"],"title":"GenericJournalItem"},"HTTPMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","HEAD","OPTIONS"],"title":"HTTPMethod"},"HTTPValidationError":{"title":"Validation Error","required":["message"],"type":"object","properties":{"message":{"title":"Message","type":"string","default":"Validation error"},"status":{"title":"Status","type":"string","default":"error"},"detail":{"title":"Detail","type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ImageItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the image in the target software"},"main_image":{"type":"boolean","title":"Main Image"},"url":{"type":"string","title":"Url"}},"type":"object","required":["id","main_image","url"],"title":"ImageItem"},"ImageType":{"type":"string","enum":["icon","logo"],"title":"ImageType"},"ImportMode":{"type":"string","enum":["IMPORT_ONLY_MISSING_DAYS","REIMPORT_ENTIRE_PERIOD"],"title":"ImportMode","description":"Enumeration of import modes for flow execution."},"IntegationStatus":{"type":"string","enum":["active","inactive"],"title":"IntegationStatus"},"IntegrationItem":{"properties":{"integrationid":{"type":"integer","title":"Integrationid"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"status":{"$ref":"#/components/schemas/IntegationStatus"},"api":{"$ref":"#/components/schemas/Api"},"logo_url":{"type":"string","title":"Logo Url"},"icon_url":{"type":"string","title":"Icon Url"},"post_connections":{"anyOf":[{"items":{"$ref":"#/components/schemas/IntegrationsPostConnectionItem"},"type":"array"},{"type":"null"}],"title":"Post Connections","description":"List of post-connections that can be activated for this integration.","default":[]},"operations_coverage":{"anyOf":[{"items":{"$ref":"#/components/schemas/CoverageItem"},"type":"array"},{"type":"null"}],"title":"Operations Coverage","description":"List of operations coverage for this integration.","default":[]},"credentials":{"anyOf":[{"items":{"$ref":"#/components/schemas/IntegrationsCredentialItem"},"type":"array"},{"type":"null"}],"title":"Credentials","description":"List of credentials that must be specified to create a connection. Can be used if you want to pass credentials on connection creation. Not compatible with oAuth2 routes.","default":[]},"supported_countries":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Supported Countries","description":"Country codes (ISO 3166-1 alpha-2) where this integration is supported. If not defined, the integration is supported globally.","examples":["BE","FR","ES"]},"local_agent":{"type":"boolean","title":"Local Agent","description":"This field indicate if the integration is a local agent.","default":false}},"type":"object","required":["integrationid","name","status","api","logo_url","icon_url"],"title":"IntegrationItem"},"IntegrationsCredentialItem":{"properties":{"name":{"type":"string","title":"Name"},"optional":{"type":"boolean","title":"Optional","default":false},"visibility":{"anyOf":[{"$ref":"#/components/schemas/Visibility"},{"type":"null"}],"description":"Visibility of the credential. If connector is selected, it should be defined when the connector is activated on your environment. If consumer is selected, the end-user will have to provide the credential when creating the connection. If both is selected, the credential can be defined when the connector is activated on your environment or when the end-user creates the connection (it will not be available for the end-user when it's activated at connector-level)","default":"both"}},"type":"object","required":["name"],"title":"IntegrationsCredentialItem"},"IntegrationsPostConnectionItem":{"properties":{"id":{"type":"string","title":"Id"},"title":{"type":"string","title":"Title"},"optional":{"type":"boolean","title":"Optional"},"resource":{"type":"string","title":"Resource"},"config":{"$ref":"#/components/schemas/IntegrationsPostConnectionItemConfig","description":"Dict of enabled post-connections on this integration.","default":{}}},"type":"object","required":["id","title","optional","resource"],"title":"IntegrationsPostConnectionItem"},"IntegrationsPostConnectionItemConfig":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":false},"allow_multiple":{"type":"boolean","title":"Allow Multiple","default":false}},"type":"object","title":"IntegrationsPostConnectionItemConfig"},"InventoryDetailsItem":{"properties":{"location":{"$ref":"#/components/schemas/CommerceLocationItem"},"available_quantity":{"type":"number","title":"Available Quantity"}},"type":"object","required":["location","available_quantity"],"title":"InventoryDetailsItem"},"InventoryDetailsUpdate":{"properties":{"location_id":{"type":"string","title":"Location Id","description":"Technical id of the location in Chift"},"available_quantity":{"type":"number","minimum":0.0,"title":"Available Quantity"}},"type":"object","required":["location_id","available_quantity"],"title":"InventoryDetailsUpdate"},"InvoiceApprovalStatus":{"type":"string","enum":["unknown","pending","approved","rejected"],"title":"InvoiceApprovalStatus"},"InvoiceApprovalStatusFilter":{"type":"string","enum":["pending","approved","rejected"],"title":"InvoiceApprovalStatusFilter"},"InvoiceCorrection":{"properties":{"sale_invoice_correction_tax_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sale Invoice Correction Tax Code","description":"Tax code to apply on the correction line when the invoice is a sale (customer invoice). Required only when invoice_correction is used for a sale invoice or refund."},"purchase_invoice_correction_tax_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Purchase Invoice Correction Tax Code","description":"Tax code to apply on the correction line when the invoice is a purchase (supplier invoice). Required only when invoice_correction is used for a purchase invoice or refund."},"invoice_correction_credit_account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Correction Credit Account Number","description":"Account number to use for the correction line on a sale (customer invoice)."},"invoice_correction_debit_account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Correction Debit Account Number","description":"Account number to use for the correction line on a purchase (supplier invoice)."}},"type":"object","title":"InvoiceCorrection"},"InvoiceItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"invoice_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Number","description":"Number/sequence","examples":["INV-12345"]},"creation_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Creation Date","description":"Creation date of the invoice","examples":["2023-10-01T12:00:00"]},"closing_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Closing Date","description":"Closing date of the invoice","examples":["2023-10-10T12:00:00"]},"partners":{"anyOf":[{"items":{"$ref":"#/components/schemas/InvoicePartnerItem"},"type":"array"},{"type":"null"}],"title":"Partners","description":"List of partners related to the invoice"}},"type":"object","required":["id","source_ref","invoice_number"],"title":"InvoiceItem"},"InvoiceItemDueDatesOut":{"properties":{"due_date":{"type":"string","format":"date","title":"Due Date","description":"Due date of the item."},"payment_method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method","description":"Payment method used to pay the invoice on that due date."},"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Id","description":"Technical ID of the payment method used to pay the invoice on that due date."},"amount":{"type":"number","title":"Amount","description":"Amount due for the invoice on that due date. A positive amount represents debit on customer invoices and supplier refunds or credit on supplier invoices and customer refunds. A negative amount represents credit on customer invoices and supplier refunds or debit on supplier invoices and customer refunds."}},"type":"object","required":["due_date","amount"],"title":"InvoiceItemDueDatesOut"},"InvoiceItemIn":{"properties":{"currency":{"type":"string","title":"Currency","description":"Currency matching target sofware name"},"invoice_type":{"$ref":"#/components/schemas/InvoicingCreateInvoiceType","description":"Invoice type"},"status":{"$ref":"#/components/schemas/InvoiceStatus","description":"Status"},"invoice_date":{"type":"string","format":"date","title":"Invoice Date","description":"Invoicing date"},"tax_amount":{"type":"number","title":"Tax Amount","description":"Taxes amount"},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Untaxed amount"},"total":{"type":"number","title":"Total","description":"Total amount incl. taxes"},"lines":{"items":{"$ref":"#/components/schemas/InvoiceLineItem"},"type":"array","title":"Lines","description":"Invoice lines","default":[]},"partner_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Id","description":"Technical id of the vendor/customer in Chift"},"invoice_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Number","description":"Number/sequence"},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date","description":"Due date"},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference","description":"Reference"},"payment_communication":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Communication","description":"Payment communication"},"customer_memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Memo","description":"Customer note/memo"},"journal_ref":{"anyOf":[{"$ref":"#/components/schemas/FieldRef"},{"type":"null"}],"description":"Journal"},"italian_specificities":{"anyOf":[{"$ref":"#/components/schemas/ItalianSpecificities-Input"},{"type":"null"}],"description":"Specificities for Italy"}},"type":"object","required":["currency","invoice_type","status","invoice_date","tax_amount","untaxed_amount","total"],"title":"InvoiceItemIn"},"InvoiceItemInMonoAnalyticPlan":{"properties":{"invoice_type":{"$ref":"#/components/schemas/InvoiceType","description":"Specifies the type of invoice"},"invoice_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Number","description":"Unique 'number' of the invoice instance in the accounting software. This is an internal reference number. if not specified, will be automatically generated according to the system’s numbering rules. It does not necessarily match the number displayed on an invoice.It is recommended to use this number for idempotency to prevent duplicate entries. Refer to the idempotency documentation in the Developer Guides for more details"},"currency":{"type":"string","title":"Currency","description":"Code (e.g., USD, EUR) of the currency used for invoice amounts."},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Total amount of the invoice excluding taxes."},"tax_amount":{"type":"number","title":"Tax Amount","description":"Total amount of tax applied to the invoice"},"total":{"type":"number","title":"Total","description":"Total amount of the invoice, including taxes (untaxed_amount + tax_amount)."},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference","description":"Optional reference field used to store an external or contextual identifier related to the entry. For purchase invoices, it typically contains the invoice number issued by the supplier. For sales invoices, it may reference a quote number or any other relevant document. Unlike number, this field is not subject to specific format or character restrictions and can hold free-form text."},"payment_communication":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Communication","description":"Field containing the payment reference or communication associated with the invoice (e.g., bank transfer reference, SEPA remittance message). Often used for reconciliation purposes."},"customer_memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Memo","description":"Internal or external note associated with the invoice, typically intended for the customer. Can include additional context, comments, or special instructions related to the transaction."},"payment_term_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Term Id","description":"Technical ID of the payment term associated with the invoice."},"withholding_tax":{"anyOf":[{"$ref":"#/components/schemas/WithholdingTax"},{"type":"null"}],"description":"Withholding tax information for the invoice."},"invoice_date":{"type":"string","format":"date","title":"Invoice Date","description":"Accounting date of the invoice (format: YYYY-MM-DD)."},"due_date":{"type":"string","format":"date","title":"Due Date","description":"Due date for payment or settlement (format: YYYY-MM-DD)."},"partner_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Partner Id","description":"Id of the related third party (supplier or customer) in the accounting software. Used to link the invoice to the corresponding client or supplier record in the accounting system."},"journal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Journal Id","description":"Identifier of the journal for the invoice. If not provided, the journal will be set automatically if only one exists; otherwise, an error will be thrown."},"status":{"anyOf":[{"$ref":"#/components/schemas/InvoiceStatusIn"},{"type":"null"}],"description":"string indicating if invoice has been posted (finalized) in the accounting system.","default":"posted"},"pdf":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pdf","description":"Base 64 string representing the PDF attached to the invoice."},"pdf_name":{"anyOf":[{"type":"string","maxLength":200,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_ ]{1,196}(?:.pdf)?$"},{"type":"null"}],"title":"Pdf Name","description":"A name for the PDF file to be created for accounting software that support it."},"currency_exchange_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Currency Exchange Rate","description":"Exchange rate applicable at the date of the invoice. Required when the invoice currency is different from the folder's default currency.","default":1},"invoice_correction":{"anyOf":[{"$ref":"#/components/schemas/InvoiceCorrection"},{"type":"null"}],"description":"Information used to add a correction line when roundings have an impact on the total amount of the invoice."},"nl_payment_terms_split":{"anyOf":[{"$ref":"#/components/schemas/NlPaymentTermsSplit"},{"type":"null"}],"description":"NL only - For Dutch split payment compliance (G/N-rekening): use to specify how invoice amounts are divided between a blocked (G) and normal (N) account in high-risk sectors (e.g., construction, staffing)."},"shipping_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Shipping Country","description":"Format: ISO 3166-1 codes."},"partner_info":{"anyOf":[{"$ref":"#/components/schemas/AccountToCreate"},{"type":"null"}],"description":"Information about the client/supplier that must be created. In some tools we cannot create a client/supplier by API. Missing clients/suppliers must be explicitly provided during the invoice creation and will be automatically created by the accounting software. This is for example the case for Tiime."},"lines":{"items":{"$ref":"#/components/schemas/InvoiceLineItemInMonoAnalyticPlan"},"type":"array","title":"Lines"},"start_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Start Date","description":"Start date of the period covered by the invoice (format: YYYY-MM-DD). This field should be used when the invoice relates to prepaid income or expenses (accruals and deferrals), indicating when the covered period begins."},"end_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"End Date","description":"End date of the period covered by the invoice (format: YYYY-MM-DD). This field should be used when the invoice relates to prepaid income or expenses (accruals and deferrals), indicating when the covered period ends."},"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Id","description":"Technical ID of the payment method in the accounting system. This is an indication of the payment method that will be used to pay the invoice. It is not necessarily the payment method that will eventually be used to pay the invoice."}},"type":"object","required":["invoice_type","currency","untaxed_amount","tax_amount","total","invoice_date","due_date","lines"],"title":"InvoiceItemInMonoAnalyticPlan"},"InvoiceItemInMultiAnalyticPlans":{"properties":{"invoice_type":{"$ref":"#/components/schemas/InvoiceType","description":"Specifies the type of invoice"},"invoice_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Number","description":"Unique 'number' of the invoice instance in the accounting software. This is an internal reference number. if not specified, will be automatically generated according to the system’s numbering rules. It does not necessarily match the number displayed on an invoice.It is recommended to use this number for idempotency to prevent duplicate entries. Refer to the idempotency documentation in the Developer Guides for more details"},"currency":{"type":"string","title":"Currency","description":"Code (e.g., USD, EUR) of the currency used for invoice amounts."},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Total amount of the invoice excluding taxes."},"tax_amount":{"type":"number","title":"Tax Amount","description":"Total amount of tax applied to the invoice"},"total":{"type":"number","title":"Total","description":"Total amount of the invoice, including taxes (untaxed_amount + tax_amount)."},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference","description":"Optional reference field used to store an external or contextual identifier related to the entry. For purchase invoices, it typically contains the invoice number issued by the supplier. For sales invoices, it may reference a quote number or any other relevant document. Unlike number, this field is not subject to specific format or character restrictions and can hold free-form text."},"payment_communication":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Communication","description":"Field containing the payment reference or communication associated with the invoice (e.g., bank transfer reference, SEPA remittance message). Often used for reconciliation purposes."},"customer_memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Memo","description":"Internal or external note associated with the invoice, typically intended for the customer. Can include additional context, comments, or special instructions related to the transaction."},"payment_term_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Term Id","description":"Technical ID of the payment term associated with the invoice."},"withholding_tax":{"anyOf":[{"$ref":"#/components/schemas/WithholdingTax"},{"type":"null"}],"description":"Withholding tax information for the invoice."},"invoice_date":{"type":"string","format":"date","title":"Invoice Date","description":"Accounting date of the invoice (format: YYYY-MM-DD)."},"due_date":{"type":"string","format":"date","title":"Due Date","description":"Due date for payment or settlement (format: YYYY-MM-DD)."},"partner_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Partner Id","description":"Id of the related third party (supplier or customer) in the accounting software. Used to link the invoice to the corresponding client or supplier record in the accounting system."},"journal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Journal Id","description":"Identifier of the journal for the invoice. If not provided, the journal will be set automatically if only one exists; otherwise, an error will be thrown."},"status":{"anyOf":[{"$ref":"#/components/schemas/InvoiceStatusIn"},{"type":"null"}],"description":"string indicating if invoice has been posted (finalized) in the accounting system.","default":"posted"},"pdf":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pdf","description":"Base 64 string representing the PDF attached to the invoice."},"pdf_name":{"anyOf":[{"type":"string","maxLength":200,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_ ]{1,196}(?:.pdf)?$"},{"type":"null"}],"title":"Pdf Name","description":"A name for the PDF file to be created for accounting software that support it."},"currency_exchange_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Currency Exchange Rate","description":"Exchange rate applicable at the date of the invoice. Required when the invoice currency is different from the folder's default currency.","default":1},"invoice_correction":{"anyOf":[{"$ref":"#/components/schemas/InvoiceCorrection"},{"type":"null"}],"description":"Information used to add a correction line when roundings have an impact on the total amount of the invoice."},"nl_payment_terms_split":{"anyOf":[{"$ref":"#/components/schemas/NlPaymentTermsSplit"},{"type":"null"}],"description":"NL only - For Dutch split payment compliance (G/N-rekening): use to specify how invoice amounts are divided between a blocked (G) and normal (N) account in high-risk sectors (e.g., construction, staffing)."},"shipping_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Shipping Country","description":"Format: ISO 3166-1 codes."},"partner_info":{"anyOf":[{"$ref":"#/components/schemas/AccountToCreate"},{"type":"null"}],"description":"Information about the client/supplier that must be created. In some tools we cannot create a client/supplier by API. Missing clients/suppliers must be explicitly provided during the invoice creation and will be automatically created by the accounting software. This is for example the case for Tiime."},"lines":{"items":{"$ref":"#/components/schemas/InvoiceLineItemInMultiAnalyticPlans"},"type":"array","title":"Lines"},"start_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Start Date","description":"Start date of the period covered by the invoice (format: YYYY-MM-DD). This field should be used when the invoice relates to prepaid income or expenses (accruals and deferrals), indicating when the covered period begins."},"end_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"End Date","description":"End date of the period covered by the invoice (format: YYYY-MM-DD). This field should be used when the invoice relates to prepaid income or expenses (accruals and deferrals), indicating when the covered period ends."},"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Id","description":"Technical ID of the payment method in the accounting system. This is an indication of the payment method that will be used to pay the invoice. It is not necessarily the payment method that will eventually be used to pay the invoice."}},"type":"object","required":["invoice_type","currency","untaxed_amount","tax_amount","total","invoice_date","due_date","lines"],"title":"InvoiceItemInMultiAnalyticPlans"},"InvoiceItemOut":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"currency":{"type":"string","title":"Currency","description":"Currency matching target sofware name"},"invoice_type":{"$ref":"#/components/schemas/InvoicingInvoiceType","description":"Invoice type"},"status":{"$ref":"#/components/schemas/InvoiceStatus","description":"Status"},"invoice_date":{"type":"string","format":"date","title":"Invoice Date","description":"Invoicing date"},"tax_amount":{"type":"number","title":"Tax Amount","description":"Taxes amount"},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Untaxed amount"},"total":{"type":"number","title":"Total","description":"Total amount incl. taxes"},"lines":{"items":{"$ref":"#/components/schemas/InvoiceLineItemOut"},"type":"array","title":"Lines","description":"Invoice lines","default":[]},"partner_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Id","description":"Technical id of the vendor/customer in Chift"},"invoice_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Number","description":"Number/sequence"},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date","description":"Due date"},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference","description":"Reference"},"payment_communication":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Communication","description":"Payment communication"},"customer_memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Memo","description":"Customer note/memo"},"journal_ref":{"anyOf":[{"$ref":"#/components/schemas/FieldRef"},{"type":"null"}],"description":"Journal"},"italian_specificities":{"anyOf":[{"$ref":"#/components/schemas/ItalianSpecificities-Output"},{"type":"null"}],"description":"Specificities for Italy"},"last_updated_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Updated On"},"outstanding_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Outstanding Amount","description":"Amount left to be paid"},"last_payment_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Last Payment Date","description":"Date of the last payment linked to the invoice"},"accounting_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Accounting Date","description":"Accounting date"},"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Id","description":"Technical id of the payment method in Chift"},"currency_exchange_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Currency Exchange Rate","description":"Indicates the exchange rate at the date of the invoice.","default":1}},"type":"object","required":["id","source_ref","currency","invoice_type","status","invoice_date","tax_amount","untaxed_amount","total"],"title":"InvoiceItemOut"},"InvoiceItemOutMonoAnalyticPlan":{"properties":{"invoice_type":{"$ref":"#/components/schemas/InvoiceType","description":"Specifies the type of invoice"},"invoice_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Number","description":"Unique 'number' of the invoice instance in the accounting software. This is an internal reference number. if not specified, will be automatically generated according to the system’s numbering rules. It does not necessarily match the number displayed on an invoice.It is recommended to use this number for idempotency to prevent duplicate entries. Refer to the idempotency documentation in the Developer Guides for more details"},"currency":{"type":"string","title":"Currency","description":"Code (e.g., USD, EUR) of the currency used for invoice amounts."},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Total amount of the invoice excluding taxes."},"tax_amount":{"type":"number","title":"Tax Amount","description":"Total amount of tax applied to the invoice"},"total":{"type":"number","title":"Total","description":"Total amount of the invoice, including taxes (untaxed_amount + tax_amount)."},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference","description":"Optional reference field used to store an external or contextual identifier related to the entry. For purchase invoices, it typically contains the invoice number issued by the supplier. For sales invoices, it may reference a quote number or any other relevant document. Unlike number, this field is not subject to specific format or character restrictions and can hold free-form text."},"payment_communication":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Communication","description":"Field containing the payment reference or communication associated with the invoice (e.g., bank transfer reference, SEPA remittance message). Often used for reconciliation purposes."},"customer_memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Memo","description":"Internal or external note associated with the invoice, typically intended for the customer. Can include additional context, comments, or special instructions related to the transaction."},"payment_term_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Term Id","description":"Technical ID of the payment term associated with the invoice."},"withholding_tax":{"anyOf":[{"$ref":"#/components/schemas/WithholdingTax"},{"type":"null"}],"description":"Withholding tax information for the invoice."},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"invoice_date":{"type":"string","format":"date","title":"Invoice Date","description":"Accounting invoice date. It is automatically set to '1970-01-01' if the value is empty in the accounting system."},"due_date":{"type":"string","format":"date","title":"Due Date","description":"Last Due date of the invoice. The invoice date is used when this information is not given by the software."},"partner_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Id"},"journal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Journal Id","description":"Indicates the journal used in for the invoice. If the journal is not given, the journal will be automatically set if only one journal exists otherwise an error will be thrown."},"payments":{"anyOf":[{"items":{"$ref":"#/components/schemas/Payment"},"type":"array"},{"type":"null"}],"title":"Payments"},"status":{"anyOf":[{"$ref":"#/components/schemas/InvoiceStatusOut"},{"type":"null"}],"default":"posted"},"last_updated_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Updated On","description":"The last time the invoice has been updated."},"partner":{"anyOf":[{"$ref":"#/components/schemas/Partner"},{"type":"null"}],"description":"Extra information about the partner (client/supplier) linked to the invoice. To ensure this information is returned, you need to use the include_partner_info query parameter."},"due_dates":{"anyOf":[{"items":{"$ref":"#/components/schemas/InvoiceItemDueDatesOut"},"type":"array"},{"type":"null"}],"title":"Due Dates","description":"List of all due dates of the invoice.","default":[]},"attachments_info":{"$ref":"#/components/schemas/ItemAttachmentInfoOut","description":"Indicates whether a file attachment (e.g. PDF or image) is linked to this invoice and how to retrieve it. Check the status field: 'yes' means a direct download URL is available in the attachments array; 'yes_to_request' means the file exists but must be fetched separately via GET /accounting/attachments?type=invoice&document_id={id}, which returns the file as a base64-encoded string. 'no' means no attachment is linked. 'unknown' means the connector does not support this."},"accounting_info":{"anyOf":[{"$ref":"#/components/schemas/AccountingInfoOut"},{"type":"null"}],"description":"Additional information about the invoice."},"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Id","description":"Technical ID of the payment method in the accounting system. This is the payment method currently linked to the invoice. It is not necessarily the payment method that will eventually be used to pay the invoice."},"approval_status":{"$ref":"#/components/schemas/InvoiceApprovalStatus","description":"Approval status of the invoice.","default":"unknown"},"lines":{"items":{"$ref":"#/components/schemas/InvoiceLineItemOutMonoAnalyticPlan"},"type":"array","title":"Lines"}},"type":"object","required":["invoice_type","currency","untaxed_amount","tax_amount","total","invoice_date","due_date","partner_id","lines"],"title":"InvoiceItemOutMonoAnalyticPlan"},"InvoiceItemOutMultiAnalyticPlans":{"properties":{"invoice_type":{"$ref":"#/components/schemas/InvoiceType","description":"Specifies the type of invoice"},"invoice_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Number","description":"Unique 'number' of the invoice instance in the accounting software. This is an internal reference number. if not specified, will be automatically generated according to the system’s numbering rules. It does not necessarily match the number displayed on an invoice.It is recommended to use this number for idempotency to prevent duplicate entries. Refer to the idempotency documentation in the Developer Guides for more details"},"currency":{"type":"string","title":"Currency","description":"Code (e.g., USD, EUR) of the currency used for invoice amounts."},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Total amount of the invoice excluding taxes."},"tax_amount":{"type":"number","title":"Tax Amount","description":"Total amount of tax applied to the invoice"},"total":{"type":"number","title":"Total","description":"Total amount of the invoice, including taxes (untaxed_amount + tax_amount)."},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference","description":"Optional reference field used to store an external or contextual identifier related to the entry. For purchase invoices, it typically contains the invoice number issued by the supplier. For sales invoices, it may reference a quote number or any other relevant document. Unlike number, this field is not subject to specific format or character restrictions and can hold free-form text."},"payment_communication":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Communication","description":"Field containing the payment reference or communication associated with the invoice (e.g., bank transfer reference, SEPA remittance message). Often used for reconciliation purposes."},"customer_memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Memo","description":"Internal or external note associated with the invoice, typically intended for the customer. Can include additional context, comments, or special instructions related to the transaction."},"payment_term_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Term Id","description":"Technical ID of the payment term associated with the invoice."},"withholding_tax":{"anyOf":[{"$ref":"#/components/schemas/WithholdingTax"},{"type":"null"}],"description":"Withholding tax information for the invoice."},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"invoice_date":{"type":"string","format":"date","title":"Invoice Date","description":"Accounting invoice date. It is automatically set to '1970-01-01' if the value is empty in the accounting system."},"due_date":{"type":"string","format":"date","title":"Due Date","description":"Last Due date of the invoice. The invoice date is used when this information is not given by the software."},"partner_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Id"},"journal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Journal Id","description":"Indicates the journal used in for the invoice. If the journal is not given, the journal will be automatically set if only one journal exists otherwise an error will be thrown."},"payments":{"anyOf":[{"items":{"$ref":"#/components/schemas/Payment"},"type":"array"},{"type":"null"}],"title":"Payments"},"status":{"anyOf":[{"$ref":"#/components/schemas/InvoiceStatusOut"},{"type":"null"}],"default":"posted"},"last_updated_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Updated On","description":"The last time the invoice has been updated."},"partner":{"anyOf":[{"$ref":"#/components/schemas/Partner"},{"type":"null"}],"description":"Extra information about the partner (client/supplier) linked to the invoice. To ensure this information is returned, you need to use the include_partner_info query parameter."},"due_dates":{"anyOf":[{"items":{"$ref":"#/components/schemas/InvoiceItemDueDatesOut"},"type":"array"},{"type":"null"}],"title":"Due Dates","description":"List of all due dates of the invoice.","default":[]},"attachments_info":{"$ref":"#/components/schemas/ItemAttachmentInfoOut","description":"Indicates whether a file attachment (e.g. PDF or image) is linked to this invoice and how to retrieve it. Check the status field: 'yes' means a direct download URL is available in the attachments array; 'yes_to_request' means the file exists but must be fetched separately via GET /accounting/attachments?type=invoice&document_id={id}, which returns the file as a base64-encoded string. 'no' means no attachment is linked. 'unknown' means the connector does not support this."},"accounting_info":{"anyOf":[{"$ref":"#/components/schemas/AccountingInfoOut"},{"type":"null"}],"description":"Additional information about the invoice."},"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Id","description":"Technical ID of the payment method in the accounting system. This is the payment method currently linked to the invoice. It is not necessarily the payment method that will eventually be used to pay the invoice."},"approval_status":{"$ref":"#/components/schemas/InvoiceApprovalStatus","description":"Approval status of the invoice.","default":"unknown"},"lines":{"items":{"$ref":"#/components/schemas/InvoiceLineItemOutMultiAnalyticPlans"},"type":"array","title":"Lines"}},"type":"object","required":["invoice_type","currency","untaxed_amount","tax_amount","total","invoice_date","due_date","partner_id","lines"],"title":"InvoiceItemOutMultiAnalyticPlans"},"InvoiceItemOutSingle":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"currency":{"type":"string","title":"Currency","description":"Currency matching target sofware name"},"invoice_type":{"$ref":"#/components/schemas/InvoicingInvoiceType","description":"Invoice type"},"status":{"$ref":"#/components/schemas/InvoiceStatus","description":"Status"},"invoice_date":{"type":"string","format":"date","title":"Invoice Date","description":"Invoicing date"},"tax_amount":{"type":"number","title":"Tax Amount","description":"Taxes amount"},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Untaxed amount"},"total":{"type":"number","title":"Total","description":"Total amount incl. taxes"},"lines":{"items":{"$ref":"#/components/schemas/InvoiceLineItemOut"},"type":"array","title":"Lines","description":"Invoice lines","default":[]},"partner_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Id","description":"Technical id of the vendor/customer in Chift"},"invoice_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Number","description":"Number/sequence"},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date","description":"Due date"},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference","description":"Reference"},"payment_communication":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Communication","description":"Payment communication"},"customer_memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Memo","description":"Customer note/memo"},"journal_ref":{"anyOf":[{"$ref":"#/components/schemas/FieldRef"},{"type":"null"}],"description":"Journal"},"italian_specificities":{"anyOf":[{"$ref":"#/components/schemas/ItalianSpecificities-Output"},{"type":"null"}],"description":"Specificities for Italy"},"last_updated_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Updated On"},"outstanding_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Outstanding Amount","description":"Amount left to be paid"},"last_payment_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Last Payment Date","description":"Date of the last payment linked to the invoice"},"accounting_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Accounting Date","description":"Accounting date"},"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Id","description":"Technical id of the payment method in Chift"},"currency_exchange_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Currency Exchange Rate","description":"Indicates the exchange rate at the date of the invoice.","default":1},"pdf":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pdf","description":"PDF document in base64"}},"type":"object","required":["id","source_ref","currency","invoice_type","status","invoice_date","tax_amount","untaxed_amount","total"],"title":"InvoiceItemOutSingle","description":"Invoice item returned in get 1 invoice"},"InvoiceLineItem":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Line description"},"unit_price":{"type":"number","title":"Unit Price","description":"Unit price excl. taxes"},"quantity":{"type":"number","title":"Quantity","description":"Quantity"},"discount_amount":{"type":"number","title":"Discount Amount","description":"Line discount amount excl. taxes, (unit_price * quantity) - discount_amount = untaxed_amount","default":0.0},"tax_amount":{"type":"number","title":"Tax Amount","description":"Line total taxes amount"},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Line total untaxed amount"},"total":{"type":"number","title":"Total","description":"Line total amount incl. taxes, total = tax_amount + untaxed_amount"},"tax_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Tax Rate","description":"Tax rate (e.g. 21.0)"},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number","description":"Number of the accounting account used (e.g. 701000)"},"tax_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Id","description":"Technical id of the tax in Chift"},"tax_exemption_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Exemption Reason","description":"Tax exemption reason"},"unit_of_measure":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit Of Measure","description":"Unit of measure matching target sofware name"},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product Id","description":"Technical id of the product in Chift"},"product_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product Code","description":"Product reference"},"product_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product Name","description":"Product name"}},"type":"object","required":["unit_price","quantity","tax_amount","untaxed_amount","total"],"title":"InvoiceLineItem"},"InvoiceLineItemInMonoAnalyticPlan":{"properties":{"line_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Line Number","description":"Optional line sequence number used to preserve the order of invoice items.","default":1},"unit_price":{"type":"number","title":"Unit Price","description":"Unit price of the item, before tax."},"unit_of_measure":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit Of Measure","description":"A list of default units can be used for which an advanced mapping has been done (units: 'hour', 'day', 'cm', 'm2', 'm3', 'm', 'km', 'mile', 'g', 'kg', 'ton', 'box', 'pallet', 'roll', 'liter', 'unit'). Custom units of measure must have an identical name in the target software."},"quantity":{"type":"number","title":"Quantity","description":"Quantity of items. This is the amount of units sold or purchased."},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Amount excluding tax for the line item (i.e., unit_price × quantity)."},"tax_rate":{"type":"number","title":"Tax Rate","description":"Tax rate used for the line (e.g., 21.0)."},"tax_amount":{"type":"number","title":"Tax Amount","description":"Tax amount calculated for the line (i.e. untaxed_amount * tax_rate)."},"total":{"type":"number","title":"Total","description":"Total amount for the item, including tax (untaxed_amount + tax_amount)."},"account_number":{"type":"string","minLength":1,"title":"Account Number","description":"Ledger account number (of type general) used for the line (e.g., 701000)."},"tax_code":{"type":"string","minLength":1,"title":"Tax Code","description":"Indicates the tax code used for the line. This is the Id of the Tax Code in the accounting software."},"description":{"type":"string","title":"Description","description":"Text description for this line item.","default":""},"analytic_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Analytic Account","description":"Analytic account in the default analytic plan."}},"type":"object","required":["unit_price","quantity","untaxed_amount","tax_rate","tax_amount","total","account_number","tax_code"],"title":"InvoiceLineItemInMonoAnalyticPlan"},"InvoiceLineItemInMultiAnalyticPlans":{"properties":{"line_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Line Number","description":"Optional line sequence number used to preserve the order of invoice items.","default":1},"unit_price":{"type":"number","title":"Unit Price","description":"Unit price of the item, before tax."},"unit_of_measure":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit Of Measure","description":"A list of default units can be used for which an advanced mapping has been done (units: 'hour', 'day', 'cm', 'm2', 'm3', 'm', 'km', 'mile', 'g', 'kg', 'ton', 'box', 'pallet', 'roll', 'liter', 'unit'). Custom units of measure must have an identical name in the target software."},"quantity":{"type":"number","title":"Quantity","description":"Quantity of items. This is the amount of units sold or purchased."},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Amount excluding tax for the line item (i.e., unit_price × quantity)."},"tax_rate":{"type":"number","title":"Tax Rate","description":"Tax rate used for the line (e.g., 21.0)."},"tax_amount":{"type":"number","title":"Tax Amount","description":"Tax amount calculated for the line (i.e. untaxed_amount * tax_rate)."},"total":{"type":"number","title":"Total","description":"Total amount for the item, including tax (untaxed_amount + tax_amount)."},"account_number":{"type":"string","minLength":1,"title":"Account Number","description":"Ledger account number (of type general) used for the line (e.g., 701000)."},"tax_code":{"type":"string","minLength":1,"title":"Tax Code","description":"Indicates the tax code used for the line. This is the Id of the Tax Code in the accounting software."},"description":{"type":"string","title":"Description","description":"Text description for this line item.","default":""},"analytic_distribution":{"anyOf":[{"items":{"$ref":"#/components/schemas/AnalyticDistribution"},"type":"array"},{"type":"null"}],"title":"Analytic Distribution","default":[]}},"type":"object","required":["unit_price","quantity","untaxed_amount","tax_rate","tax_amount","total","account_number","tax_code"],"title":"InvoiceLineItemInMultiAnalyticPlans"},"InvoiceLineItemOut":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Line description"},"unit_price":{"type":"number","title":"Unit Price","description":"Unit price excl. taxes"},"quantity":{"type":"number","title":"Quantity","description":"Quantity"},"discount_amount":{"type":"number","title":"Discount Amount","description":"Line discount amount excl. taxes, (unit_price * quantity) - discount_amount = untaxed_amount","default":0.0},"tax_amount":{"type":"number","title":"Tax Amount","description":"Line total taxes amount"},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Line total untaxed amount"},"total":{"type":"number","title":"Total","description":"Line total amount incl. taxes, total = tax_amount + untaxed_amount"},"tax_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Tax Rate","description":"Tax rate (e.g. 21.0)"},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number","description":"Number of the accounting account used (e.g. 701000)"},"tax_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Id","description":"Technical id of the tax in Chift"},"tax_exemption_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Exemption Reason","description":"Tax exemption reason"},"unit_of_measure":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit Of Measure","description":"Unit of measure matching target sofware name"},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product Id","description":"Technical id of the product in Chift"},"product_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product Code","description":"Product reference"},"product_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product Name","description":"Product name"},"analytic_distribution":{"anyOf":[{"items":{"$ref":"#/components/schemas/AnalyticDistributionInvoicing"},"type":"array"},{"type":"null"}],"title":"Analytic Distribution","description":"List of analytic distributions for the line item. Each distribution specifies an analytic plan and the associated analytic accounts with their percentages.","default":[]}},"type":"object","required":["unit_price","quantity","tax_amount","untaxed_amount","total"],"title":"InvoiceLineItemOut"},"InvoiceLineItemOutMonoAnalyticPlan":{"properties":{"line_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Line Number","description":"Optional line sequence number used to preserve the order of invoice items.","default":1},"unit_price":{"type":"number","title":"Unit Price","description":"Unit price of the item, before tax."},"unit_of_measure":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit Of Measure","description":"A list of default units can be used for which an advanced mapping has been done (units: 'hour', 'day', 'cm', 'm2', 'm3', 'm', 'km', 'mile', 'g', 'kg', 'ton', 'box', 'pallet', 'roll', 'liter', 'unit'). Custom units of measure must have an identical name in the target software."},"quantity":{"type":"number","title":"Quantity","description":"Quantity of items. This is the amount of units sold or purchased."},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Amount excluding tax for the line item (i.e., unit_price × quantity)."},"tax_rate":{"type":"number","title":"Tax Rate","description":"Tax rate used for the line (e.g., 21.0)."},"tax_amount":{"type":"number","title":"Tax Amount","description":"Tax amount calculated for the line (i.e. untaxed_amount * tax_rate)."},"total":{"type":"number","title":"Total","description":"Total amount for the item, including tax (untaxed_amount + tax_amount)."},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number","description":"Ledger account number (of type general) used for the line (e.g., 701000)."},"tax_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Code","description":"Indicates the tax code used for the line. This is the Id of the Tax Code in the accounting software."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Text description for this line.","default":""},"analytic_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Analytic Account","description":"Analytic account in the default analytic plan."}},"type":"object","required":["unit_price","quantity","untaxed_amount","tax_rate","tax_amount","total"],"title":"InvoiceLineItemOutMonoAnalyticPlan"},"InvoiceLineItemOutMultiAnalyticPlans":{"properties":{"line_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Line Number","description":"Optional line sequence number used to preserve the order of invoice items.","default":1},"unit_price":{"type":"number","title":"Unit Price","description":"Unit price of the item, before tax."},"unit_of_measure":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit Of Measure","description":"A list of default units can be used for which an advanced mapping has been done (units: 'hour', 'day', 'cm', 'm2', 'm3', 'm', 'km', 'mile', 'g', 'kg', 'ton', 'box', 'pallet', 'roll', 'liter', 'unit'). Custom units of measure must have an identical name in the target software."},"quantity":{"type":"number","title":"Quantity","description":"Quantity of items. This is the amount of units sold or purchased."},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Amount excluding tax for the line item (i.e., unit_price × quantity)."},"tax_rate":{"type":"number","title":"Tax Rate","description":"Tax rate used for the line (e.g., 21.0)."},"tax_amount":{"type":"number","title":"Tax Amount","description":"Tax amount calculated for the line (i.e. untaxed_amount * tax_rate)."},"total":{"type":"number","title":"Total","description":"Total amount for the item, including tax (untaxed_amount + tax_amount)."},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number","description":"Ledger account number (of type general) used for the line (e.g., 701000)."},"tax_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Code","description":"Indicates the tax code used for the line. This is the Id of the Tax Code in the accounting software."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Text description for this line.","default":""},"analytic_distribution":{"anyOf":[{"items":{"$ref":"#/components/schemas/AnalyticDistribution"},"type":"array"},{"type":"null"}],"title":"Analytic Distribution","description":"List of analytic distributions for the line item. Each distribution specifies an analytic plan and the associated analytic accounts with their percentages.","default":[]}},"type":"object","required":["unit_price","quantity","untaxed_amount","tax_rate","tax_amount","total"],"title":"InvoiceLineItemOutMultiAnalyticPlans"},"InvoicePartnerItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"type":{"$ref":"#/components/schemas/PartnerType-Output","description":"Type of the partner","examples":["account"]},"address":{"anyOf":[{"$ref":"#/components/schemas/AddressItem"},{"type":"null"}],"description":"Address of the partner"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"First name of the partner. In case the partner is an individual.","examples":["John"]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Last name of the partner. In case the partner is an individual.","examples":["Doe"]},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name","description":"Company name of the partner. In case the partner is a company.","examples":["Acme Corp"]}},"type":"object","required":["id","source_ref","type"],"title":"InvoicePartnerItem"},"InvoiceStatus":{"type":"string","enum":["cancelled","draft","posted","paid"],"title":"InvoiceStatus"},"InvoiceStatusIn":{"type":"string","enum":["draft","posted"],"title":"InvoiceStatusIn"},"InvoiceStatusOut":{"type":"string","enum":["cancelled","draft","posted","paid"],"title":"InvoiceStatusOut"},"InvoiceType":{"type":"string","enum":["customer_invoice","customer_refund","supplier_invoice","supplier_refund"],"title":"InvoiceType"},"InvoicingBankAccountItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"name":{"type":"string","title":"Name","description":"Bank account name"},"iban":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Iban","description":"IBAN"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Currency of the bank account"},"balance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Balance","description":"Current balance of the bank account"}},"type":"object","required":["id","source_ref","name"],"title":"InvoicingBankAccountItem"},"InvoicingBankTransactionItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"status":{"$ref":"#/components/schemas/BankTransactionStatus","description":"Status of the bank transaction"},"bank_account_id":{"type":"string","title":"Bank Account Id","description":"Technical id of the bank account in Chift"},"amount":{"type":"number","title":"Amount","description":"Transaction amount"},"date":{"type":"string","format":"date","title":"Date","description":"Transaction date"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Transaction description"},"currency":{"type":"string","title":"Currency","description":"Currency of the transaction"},"currency_exchange_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Currency Exchange Rate","description":"Exchange rate at the date of the transaction","default":1.0},"accounting_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accounting Code","description":"Accounting code"},"linked_documents":{"anyOf":[{"items":{"$ref":"#/components/schemas/LinkedDocument"},"type":"array"},{"type":"null"}],"title":"Linked Documents","description":"List of linked documents","default":[]}},"type":"object","required":["id","source_ref","status","bank_account_id","amount","date","currency"],"title":"InvoicingBankTransactionItem"},"InvoicingCreateInvoiceType":{"type":"string","enum":["customer_invoice","customer_refund","supplier_invoice","supplier_refund"],"title":"InvoicingCreateInvoiceType"},"InvoicingDocumentType":{"type":"string","enum":["customer_document","supplier_document","employee_expense"],"title":"InvoicingDocumentType"},"InvoicingInvoiceType":{"type":"string","enum":["customer_invoice","customer_refund","supplier_invoice","supplier_refund","all"],"title":"InvoicingInvoiceType"},"InvoicingPaymentItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"status":{"$ref":"#/components/schemas/PaymentPaymentStatus","description":"Payment status"},"description":{"type":"string","title":"Description","description":"Description"},"amount":{"type":"number","title":"Amount","description":"Amount"},"currency":{"type":"string","title":"Currency","description":"Currency"},"payment_date":{"type":"string","format":"date-time","title":"Payment Date","description":"Date of creation"},"partner_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Id","description":"Partner ID"},"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Id","description":"Technical id of the payment method in Chift"},"payment_method_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Name","description":"Payment method name"},"invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Id","description":"Technical id of the invoice in Chift"},"invoice_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Number","description":"Invoice number"}},"type":"object","required":["id","source_ref","status","description","amount","currency","payment_date"],"title":"InvoicingPaymentItem"},"InvoicingPaymentItemIn":{"properties":{"amount":{"type":"number","title":"Amount","description":"Payment amount"},"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Id","description":"The technical ID of the payment method in the invoicing system"},"invoice_id":{"type":"string","title":"Invoice Id","description":"The technical ID of the invoice in the invoicing system to which the payment will be linked"},"date":{"type":"string","format":"date","title":"Date","description":"The date of the payment"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the payment"},"currency":{"type":"string","title":"Currency","description":"Currency of the payment"}},"type":"object","required":["amount","invoice_id","date","currency"],"title":"InvoicingPaymentItemIn"},"InvoicingPaymentItemUpdate":{"properties":{"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount","description":"Payment amount"},"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Id","description":"The technical ID of the payment method in the invoicing system"},"date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date","description":"The date of the payment"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the payment"}},"type":"object","title":"InvoicingPaymentItemUpdate"},"InvoicingPaymentMethodItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"name":{"type":"string","title":"Name","description":"Payment method name"}},"type":"object","required":["id","source_ref","name"],"title":"InvoicingPaymentMethodItem"},"InvoicingVatCode":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"label":{"type":"string","title":"Label","description":"Label"},"rate":{"type":"number","title":"Rate","description":"Tax rate (e.g. 21.0)"},"type":{"$ref":"#/components/schemas/VatCodeType","description":"Type"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code"},"scope":{"anyOf":[{"$ref":"#/components/schemas/VatCodeScope"},{"type":"null"}],"description":"Scope","default":"unknown"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Is the tax active?","default":true}},"type":"object","required":["id","source_ref","label","rate","type"],"title":"InvoicingVatCode"},"InvoicingWithholdingTax":{"properties":{"rate":{"type":"number","title":"Rate","description":"Rate"},"amount":{"type":"number","title":"Amount","description":"Amount"},"reason":{"anyOf":[{"$ref":"#/components/schemas/WithholdingTaxReason"},{"type":"null"}],"description":"Reason"},"payment_reason":{"anyOf":[{"$ref":"#/components/schemas/WithholdingTaxPaymentReason"},{"type":"null"}],"description":"Payment reason"}},"type":"object","required":["rate","amount"],"title":"InvoicingWithholdingTax"},"IssueEvent":{"properties":{"id":{"type":"string","title":"Id"},"execution_id":{"type":"string","title":"Execution Id"},"created_on":{"type":"string","format":"date-time","title":"Created On"},"context":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Context"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"}},"type":"object","required":["id","execution_id","created_on"],"title":"IssueEvent"},"IssueItem":{"properties":{"id":{"type":"string","title":"Id"},"consumer_id":{"type":"string","title":"Consumer Id"},"connection_id":{"type":"string","title":"Connection Id"},"integration_id":{"type":"integer","title":"Integration Id"},"integration_name":{"type":"string","title":"Integration Name"},"created_on":{"type":"string","format":"date-time","title":"Created On"},"updated_on":{"type":"string","format":"date-time","title":"Updated On"},"last_seen":{"type":"string","format":"date-time","title":"Last Seen"},"error":{"$ref":"#/components/schemas/ErrorInfo"},"occurrences":{"type":"integer","title":"Occurrences"},"level":{"$ref":"#/components/schemas/IssueLevel"}},"type":"object","required":["id","consumer_id","connection_id","integration_id","integration_name","created_on","updated_on","last_seen","error","occurrences","level"],"title":"IssueItem"},"IssueLevel":{"type":"string","enum":["error","warning"],"title":"IssueLevel"},"IssueStatus":{"type":"string","enum":["open","closed","all"],"title":"IssueStatus"},"ItalianSpecificities-Input":{"properties":{"stamp_duty_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Stamp Duty Amount","description":"Documentary stamp tax (specific to Italy)"},"withholding_tax":{"anyOf":[{"$ref":"#/components/schemas/InvoicingWithholdingTax"},{"type":"null"}],"description":"Withholding tax (specific to Italy)"},"welfare_fund":{"anyOf":[{"$ref":"#/components/schemas/WelfareFund"},{"type":"null"}],"description":"Welfare fund (specific to Italy)"},"payment_reporting":{"anyOf":[{"$ref":"#/components/schemas/PaymentReporting"},{"type":"null"}],"description":"Payment reporting (specific to Italy)"}},"type":"object","title":"ItalianSpecificities"},"ItalianSpecificities-Output":{"properties":{"stamp_duty_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Stamp Duty Amount","description":"Documentary stamp tax (specific to Italy)"},"withholding_tax":{"anyOf":[{"$ref":"#/components/schemas/InvoicingWithholdingTax"},{"type":"null"}],"description":"Withholding tax (specific to Italy)"},"welfare_fund":{"anyOf":[{"$ref":"#/components/schemas/WelfareFund"},{"type":"null"}],"description":"Welfare fund (specific to Italy)"},"payment_reporting":{"anyOf":[{"$ref":"#/components/schemas/PaymentReporting"},{"type":"null"}],"description":"Payment reporting (specific to Italy)"}},"type":"object","title":"ItalianSpecificities"},"ItemAttachmentInfoAttachment":{"properties":{"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filename","description":"The name of the attachment."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"Direct download URL for the attachment file. Only populated when the parent attachments_info.status is 'yes'. When status is 'yes_to_request', this field is null and the file must be retrieved via GET /accounting/attachments with the appropriate type and document_id, which returns the content as a base64-encoded string."}},"type":"object","title":"ItemAttachmentInfoAttachment"},"ItemAttachmentInfoOut":{"properties":{"status":{"$ref":"#/components/schemas/ItemAttachmentInfoStatus","description":"Indicates whether an attachment (e.g. PDF or image) is available for this entry, and how to retrieve it. 'yes': one or more attachments are available directly — each entry in the attachments array contains a filename and a download URL. 'yes_to_request': an attachment exists but cannot be returned inline. Call GET /accounting/attachments with type and document_id to retrieve the file as a base64-encoded string. The attachments array may be empty in this case. 'no': no attachment is linked to this entry. 'unknown': the connector does not support attachment detection for this provider."},"attachments":{"anyOf":[{"items":{"$ref":"#/components/schemas/ItemAttachmentInfoAttachment"},"type":"array"},{"type":"null"}],"title":"Attachments","description":"List of attachments available directly for this entry. Populated only when status is 'yes'. When status is 'yes_to_request', this list is empty — use GET /accounting/attachments to fetch the file content.","default":[]}},"type":"object","required":["status"],"title":"ItemAttachmentInfoOut"},"ItemAttachmentInfoStatus":{"type":"string","enum":["unknown","yes","yes_to_request","no"],"title":"ItemAttachmentInfoStatus"},"Journal":{"properties":{"id":{"type":"string","title":"Id"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"name":{"type":"string","title":"Name"},"journal_type":{"$ref":"#/components/schemas/JournalType"},"counterpart_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterpart Account","description":"When journal is of type bank or cash, this is account number of the counterpart account used for the journal."},"unallocated_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unallocated Account","description":"Unallocated ledger account used to book entries when the final ledger account / client / supplier / employee is not yet known (specific to bank and cash journals)"},"next_document_numbers":{"anyOf":[{"items":{"$ref":"#/components/schemas/NextDocumentNumber"},"type":"array"},{"type":"null"}],"title":"Next Document Numbers","default":[]},"iban":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Iban","description":"When the journal is of type bank, IBAN of the bank account linked to the journal "},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Currency of the journal (e.g., EUR). If empty, the journal follows the currency of the accounting folder."},"other_currencies_allowed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Other Currencies Allowed","description":"Indicates if the journal allows other currencies. If it doesn't allow other currencies an exchange rate must be provided for Chift to convert the amounts to the journal currency. This only applicable if the journal currency is the same as the accounting folder currency.","default":true},"blocked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Blocked","description":"Indicates if the journal is blocked for creating entries.","default":false}},"type":"object","required":["id","name","journal_type"],"title":"Journal"},"JournalEntryMonoAnalyticPlan":{"properties":{"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference","description":"Optional reference field used to store an external or contextual identifier related to the entry. For example, it can be used to store a reference number, the invoice number issued by the suppllier or any other relevant information."},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date","description":"If the journal entry relates to an invoice, this is the due date for payment or settlement (format: YYYY-MM-DD)."},"journal_id":{"type":"string","title":"Journal Id","description":"Id of the journal instance in the accounting system in which the journal entry is recorded."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"journal_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Journal Name","description":"Name of the journal in which the journal entry is recorded."},"date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date","description":"Accounting date of the journal entry. It is automatically set to '1970-01-01' if the value is not available/empty in the accounting system.","default":"1970-01-01"},"posted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Posted","description":"Indicates if the journal entry has been posted (finalized) in the accounting system.","default":false},"id":{"type":"string","title":"Id","description":"Unique id of the journal entry instance in the accounting system."},"due_dates":{"anyOf":[{"items":{"$ref":"#/components/schemas/JournalItemDueDatesOut"},"type":"array"},{"type":"null"}],"title":"Due Dates","description":"List of all due dates of a journal entry.","default":[]},"attachments_info":{"$ref":"#/components/schemas/ItemAttachmentInfoOut","description":"Indicates whether a file attachment (e.g. PDF or image) is linked to this journal entry and how to retrieve it. Check the status field: 'yes' means a direct download URL is available in the attachments array; 'yes_to_request' means the file exists but must be fetched separately via GET /accounting/attachments?type=entry&document_id={id}, which returns the file as a base64-encoded string. 'no' means no attachment is linked. 'unknown' means the connector does not support this."},"items":{"anyOf":[{"items":{"$ref":"#/components/schemas/JournalItemMonoAnalyticPlan"},"type":"array"},{"type":"null"}],"title":"Items","description":"List of journal items that make up the journal entry. Each item represents a line in the journal entry, and the sum of debits must equal the sum of credits to ensure the entry is balanced.","default":[]}},"type":"object","required":["journal_id","id"],"title":"JournalEntryMonoAnalyticPlan"},"JournalEntryMultiAnalyticPlan":{"properties":{"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference","description":"Optional reference field used to store an external or contextual identifier related to the entry. For example, it can be used to store a reference number, the invoice number issued by the suppllier or any other relevant information."},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date","description":"If the journal entry relates to an invoice, this is the due date for payment or settlement (format: YYYY-MM-DD)."},"journal_id":{"type":"string","title":"Journal Id","description":"Id of the journal instance in the accounting system in which the journal entry is recorded."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"journal_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Journal Name","description":"Name of the journal in which the journal entry is recorded."},"date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date","description":"Accounting date of the journal entry. It is automatically set to '1970-01-01' if the value is not available/empty in the accounting system.","default":"1970-01-01"},"posted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Posted","description":"Indicates if the journal entry has been posted (finalized) in the accounting system.","default":false},"id":{"type":"string","title":"Id","description":"Unique id of the journal entry instance in the accounting system."},"due_dates":{"anyOf":[{"items":{"$ref":"#/components/schemas/JournalItemDueDatesOut"},"type":"array"},{"type":"null"}],"title":"Due Dates","description":"List of all due dates of a journal entry.","default":[]},"attachments_info":{"$ref":"#/components/schemas/ItemAttachmentInfoOut","description":"Indicates whether a file attachment (e.g. PDF or image) is linked to this journal entry and how to retrieve it. Check the status field: 'yes' means a direct download URL is available in the attachments array; 'yes_to_request' means the file exists but must be fetched separately via GET /accounting/attachments?type=entry&document_id={id}, which returns the file as a base64-encoded string. 'no' means no attachment is linked. 'unknown' means the connector does not support this."},"items":{"anyOf":[{"items":{"$ref":"#/components/schemas/JournalItemMultiAnalyticPlan"},"type":"array"},{"type":"null"}],"title":"Items","description":"List of journal items that make up the journal entry. Each item represents a line in the journal entry, and the sum of debits must equal the sum of credits to ensure the entry is balanced.","default":[]}},"type":"object","required":["journal_id","id"],"title":"JournalEntryMultiAnalyticPlan"},"JournalIn":{"properties":{"code":{"type":"string","minLength":2,"title":"Code","description":"Short code or identifier of the journal (e.g., 'BNK', 'INV')."},"name":{"type":"string","minLength":1,"title":"Name","description":"Name or label of the journal as it appears in the accounting system."},"journal_type":{"$ref":"#/components/schemas/JournalInType","description":"Type of journal. "},"counterpart_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterpart Account","description":"When journal is of type bank or cash, this is account number of the counterpart account used for the journal."}},"type":"object","required":["code","name","journal_type"],"title":"JournalIn"},"JournalInType":{"type":"string","enum":["customer_invoice","customer_refund","supplier_invoice","supplier_refund","bank","cash","miscellaneous_operation"],"title":"JournalInType"},"JournalItemDueDatesOut":{"properties":{"due_date":{"type":"string","format":"date","title":"Due Date","description":"Due date of the item."},"payment_method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method","description":"Payment method used to pay the entry on that due date."},"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Id","description":"Technical ID of the payment method used to pay the entry on that due date."},"debit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Debit","description":"Debit of the item on this due date.","default":0},"credit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit","description":"Credit of the item on this due date.","default":0}},"type":"object","required":["due_date"],"title":"JournalItemDueDatesOut"},"JournalItemMonoAnalyticPlan":{"properties":{"account_number":{"type":"string","minLength":1,"title":"Account Number","description":"Depending on account_type, if the account_type is 'general_account', this is the general ledger account number used to book the journal item against. If the account_type is 'customer_account', 'supplier_account' or 'employee_account', this is the thirdparty_id (id of the customer, supplier or employee in the accounting system)."},"partner_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Id","description":"Id of the thirdparty (customer, supplier or employee) in the accounting system if the journal item relates to a thirdparty (e.g., an invoice)."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Text description for this journal item. This is typically used to provide additional context or information."},"debit":{"type":"number","title":"Debit","description":"Amount to debit on the account. Must be 0 if credit field is not 0"},"credit":{"type":"number","title":"Credit","description":"Amount to credit on the account. Must be 0 if debit field is not 0"},"currency":{"type":"string","minLength":1,"title":"Currency","description":"Currency code (e.g., USD, EUR) used for the journal item amounts."},"currency_exchange_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Currency Exchange Rate","description":"Exchange rate applicable at the date of the journal item. Required when currency is different from the folder's default currency.","default":1},"id":{"type":"string","title":"Id","description":"Unique id of the journal item instance in the accounting system."},"partner_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Name","description":"Name of the thirdparty (customer, supplier or employee) linked to the journal item if journal item relates to a thirdparty (e.g., an invoice)."},"account_name":{"type":"string","title":"Account Name","description":"Name or label of the ledger account used to book the journal item against."},"matching_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Matching Numbers","description":"List of matching numbers used to link this journal item to other entries in the accounting system. This is used for reconciliation/lettering purposes.","default":[]},"analytic_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Analytic Account","description":"Analytic account in the default analytic plan."},"analytic_account_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Analytic Account Name","description":"Name of the analytic account in the default analytic plan."}},"type":"object","required":["account_number","debit","credit","currency","id","account_name"],"title":"JournalItemMonoAnalyticPlan"},"JournalItemMultiAnalyticPlan":{"properties":{"account_number":{"type":"string","minLength":1,"title":"Account Number","description":"Depending on account_type, if the account_type is 'general_account', this is the general ledger account number used to book the journal item against. If the account_type is 'customer_account', 'supplier_account' or 'employee_account', this is the thirdparty_id (id of the customer, supplier or employee in the accounting system)."},"partner_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Id","description":"Id of the thirdparty (customer, supplier or employee) in the accounting system if the journal item relates to a thirdparty (e.g., an invoice)."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Text description for this journal item. This is typically used to provide additional context or information."},"debit":{"type":"number","title":"Debit","description":"Amount to debit on the account. Must be 0 if credit field is not 0"},"credit":{"type":"number","title":"Credit","description":"Amount to credit on the account. Must be 0 if debit field is not 0"},"currency":{"type":"string","minLength":1,"title":"Currency","description":"Currency code (e.g., USD, EUR) used for the journal item amounts."},"currency_exchange_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Currency Exchange Rate","description":"Exchange rate applicable at the date of the journal item. Required when currency is different from the folder's default currency.","default":1},"id":{"type":"string","title":"Id","description":"Unique id of the journal item instance in the accounting system."},"partner_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Name","description":"Name of the thirdparty (customer, supplier or employee) linked to the journal item if journal item relates to a thirdparty (e.g., an invoice)."},"account_name":{"type":"string","title":"Account Name","description":"Name or label of the ledger account used to book the journal item against."},"matching_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Matching Numbers","description":"List of matching numbers used to link this journal item to other entries in the accounting system. This is used for reconciliation/lettering purposes.","default":[]},"analytic_distribution":{"anyOf":[{"items":{"$ref":"#/components/schemas/AnalyticDistribution"},"type":"array"},{"type":"null"}],"title":"Analytic Distribution","description":"List of analytic distributions for the journal item. Each distribution specifies an analytic plan and the allocation of the journal entry item's amount across analytic accounts using percentages.","default":[]}},"type":"object","required":["account_number","debit","credit","currency","id","account_name"],"title":"JournalItemMultiAnalyticPlan"},"JournalType":{"type":"string","enum":["customer_invoice","customer_refund","supplier_invoice","supplier_refund","financial_operation","miscellaneous_operation","unknown"],"title":"JournalType"},"LedgerAccountItemIn":{"properties":{"name":{"type":"string","minLength":1,"title":"Name","description":"Name or label of the ledger account as it appears in the accounting system."},"number":{"type":"string","minLength":3,"title":"Number","description":"The account number in the chart of accounts. Must be unique within the accounting folder. In some countries (e.g., France, Belgium, Spain), the number structure is constrained by local accounting rules and must follow official charts of accounts (e.g., Plan Comptable Général)."},"type":{"anyOf":[{"$ref":"#/components/schemas/AccountItemType"},{"type":"null"}],"default":"other"}},"type":"object","required":["name","number"],"title":"LedgerAccountItemIn"},"LinkItem":{"properties":{"url":{"type":"string","title":"Url"}},"type":"object","required":["url"],"title":"LinkItem"},"LinkSyncItem":{"properties":{"url":{"type":"string","title":"Url"}},"type":"object","required":["url"],"title":"LinkSyncItem"},"LinkedDocument":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"amount":{"type":"number","title":"Amount","description":"Amount linked to the document"},"type":{"$ref":"#/components/schemas/LinkedDocumentType","description":"Type of linked document"}},"type":"object","required":["id","source_ref","amount","type"],"title":"LinkedDocument"},"LinkedDocumentType":{"type":"string","enum":["invoice","other"],"title":"LinkedDocumentType"},"LocalAgentInfo":{"properties":{"status":{"$ref":"#/components/schemas/LocalAgentStatus"}},"type":"object","required":["status"],"title":"LocalAgentInfo"},"LocalAgentStatus":{"type":"string","enum":["up","down"],"title":"LocalAgentStatus"},"LogoImage":{"properties":{"integrationid":{"type":"integer","title":"Integrationid"},"data":{"type":"string","title":"Data"}},"type":"object","required":["integrationid","data"],"title":"LogoImage"},"MCPAuthItem":{"properties":{"clientId":{"type":"string","title":"Clientid"},"clientSecret":{"type":"string","title":"Clientsecret"},"accountId":{"type":"string","format":"uuid","title":"Accountid"},"envId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Envid"},"marketplaceId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Marketplaceid"},"consumerId":{"type":"string","format":"uuid","title":"Consumerid"}},"type":"object","required":["clientId","clientSecret","accountId","consumerId"],"title":"MCPAuthItem"},"MatchingIn":{"properties":{"entries":{"items":{"type":"string"},"type":"array","minItems":2,"title":"Entries","description":"List of entries to match. Must contain at least 2 entries. Entries are typically journal entry id, invoice id or financial entry id."},"partner_id":{"type":"string","title":"Partner Id","description":"Id of the thirdparty (customer, supplier or employee) in the accounting system . All entries are must be linked to one same partner."}},"type":"object","required":["entries","partner_id"],"title":"MatchingIn"},"MatchingOut":{"properties":{"matching_number":{"type":"string","title":"Matching Number","description":"Unique 'number' of the matching operation in the accounting system."},"balance":{"type":"number","title":"Balance","description":"Balance of the matching operation. This is the sum of all entries in the matching operation. It should be zero if the matching is complete."}},"type":"object","required":["matching_number","balance"],"title":"MatchingOut"},"MiscellaneousOperationIn":{"properties":{"operation_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Operation Number"},"currency":{"type":"string","title":"Currency","description":"Indicates the currency of the operation (e.g., EUR, USD)."},"currency_exchange_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Currency Exchange Rate","description":"Indicates the exchange rate at the date of the operation. Must be filled in when creating the operation in another currency from the folder's default currency.","default":1},"lines":{"items":{"$ref":"#/components/schemas/MiscellaneousOperationLine"},"type":"array","title":"Lines"},"operation_date":{"type":"string","format":"date","title":"Operation Date"},"journal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Journal Id","description":"Indicates the journal used in for the operation. If the journal is not given, the journal will be automatically set if only one journal exists otherwise an error will be thrown."},"status":{"anyOf":[{"$ref":"#/components/schemas/MiscellaneousOperationStatusIn"},{"type":"null"}],"default":"posted"}},"type":"object","required":["currency","lines","operation_date"],"title":"MiscellaneousOperationIn"},"MiscellaneousOperationLine":{"properties":{"line_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Line Number","description":"Line number of the operation line. This is used to order the lines in the operation. It is automatically set to 1 if not provided.","default":1},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Text description used to provide additional context or information about the operation line."},"amount":{"type":"number","title":"Amount","description":"Positive for Credit and negative for Debit."},"type":{"$ref":"#/components/schemas/MiscellaneousOperationLineType"},"account_number":{"type":"string","title":"Account Number","description":"Indicates the account number used in the operation line. This is the ledger account number in the chart of accounts."},"partner_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Id","description":"Must be filled in if it is a 'customer_account' or 'supplier_account' line type."},"analytic_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Analytic Account","description":"Analytic account used in the operation line. This is the id of a analytic account - no distribution possible. It is used to track the operation line in the analytic accounting system."}},"type":"object","required":["amount","type","account_number"],"title":"MiscellaneousOperationLine"},"MiscellaneousOperationLineType":{"type":"string","enum":["customer_account","supplier_account","general_account"],"title":"MiscellaneousOperationLineType"},"MiscellaneousOperationOut":{"properties":{"operation_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Operation Number"},"currency":{"type":"string","title":"Currency","description":"Indicates the currency of the operation (e.g., EUR, USD)."},"currency_exchange_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Currency Exchange Rate","description":"Indicates the exchange rate at the date of the operation. Must be filled in when creating the operation in another currency from the folder's default currency.","default":1},"lines":{"items":{"$ref":"#/components/schemas/MiscellaneousOperationLine"},"type":"array","title":"Lines"},"operation_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Operation Date","description":"Accounting date of the miscellaneous operation. It is automatically set to '1970-01-01' if the value is not available/empty in the accounting system.","default":"1970-01-01"},"journal_id":{"type":"string","title":"Journal Id","description":"Indicates the journal used in for the operation."},"status":{"$ref":"#/components/schemas/MiscellaneousOperationStatusOut"},"id":{"type":"string","title":"Id"}},"type":"object","required":["currency","lines","journal_id","status","id"],"title":"MiscellaneousOperationOut"},"MiscellaneousOperationStatusIn":{"type":"string","enum":["draft","posted"],"title":"MiscellaneousOperationStatusIn"},"MiscellaneousOperationStatusOut":{"type":"string","enum":["cancelled","draft","posted","matched"],"title":"MiscellaneousOperationStatusOut"},"Mode":{"type":"string","enum":["EAT_IN","TAKEAWAY","DELIVERY","UNKNOWN"],"title":"Mode"},"MultipleMatchingIn":{"properties":{"matchings":{"items":{"$ref":"#/components/schemas/MatchingIn"},"type":"array","title":"Matchings"}},"type":"object","required":["matchings"],"title":"MultipleMatchingIn"},"MultipleMatchingOut":{"properties":{"matching_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Matching Number"},"processed":{"type":"boolean","title":"Processed"},"error_msg":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Error Msg"}},"type":"object","required":["processed"],"title":"MultipleMatchingOut"},"NextDocumentNumber":{"properties":{"bookyear_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bookyear Name"},"next_document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Document Number"},"start_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Start Date"},"end_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"End Date"}},"type":"object","title":"NextDocumentNumber"},"NlPaymentTermsSplit":{"properties":{"g_account":{"$ref":"#/components/schemas/PaymentTermAccountInfo","description":"This is the 'Geblokkeerde rekening' in Dutch. It is a blocked bank account used only for tax-related payments, such as VAT and payroll tax."},"n_account":{"$ref":"#/components/schemas/PaymentTermAccountInfo","description":"This is the 'Normale rekening' in Dutch. It is a regular bank account used for standard business operations and unrestricted funds. The non-tax portion of the invoice is paid here."}},"type":"object","required":["g_account","n_account"],"title":"NlPaymentTermsSplit"},"ObjectivesItem":{"properties":{"total":{"type":"number","title":"Total","description":"Total amount including tax of the sales","examples":[10]},"tax_amount":{"type":"number","title":"Tax Amount","description":"Total amount of the taxes","examples":[1]},"date":{"type":"string","format":"date","title":"Date","description":"Date of the objective","examples":["2025-01-01"]}},"type":"object","required":["total","tax_amount","date"],"title":"ObjectivesItem"},"OperationType":{"type":"string","enum":["incoming_transfer","outgoing_transfer","card","direct_debit","direct_debit_collection","direct_debit_hold","fee","cheque","recall","swift_income","pay_later","financing_installment","cashback","interest","other"],"title":"OperationType"},"OpportunityItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"name":{"type":"string","title":"Name","description":"Name"},"total":{"type":"number","title":"Total","description":"Total"},"probability":{"type":"number","title":"Probability","description":"Probability of success"},"status":{"$ref":"#/components/schemas/OpportunityStatus","description":"Status"},"partner_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Id","description":"Technical id of the customer in Chift"},"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Comment","description":"Comment"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Currency matching target sofware name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description"},"pipe_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pipe Status","description":"Current stage in pipeline"},"pipe_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pipe Name","description":"Pipeline name"},"created_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Created Date","description":"Date creation"},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date","description":"Due Date"},"end_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"End Date","description":"End Date"},"is_won":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Won","description":"Is won?"},"owner_ref":{"anyOf":[{"$ref":"#/components/schemas/FieldRef"},{"type":"null"}],"description":"Employee/User"}},"type":"object","required":["id","source_ref","name","total","probability","status"],"title":"OpportunityItem"},"OpportunityStatus":{"type":"string","enum":["open","won","lost","cancelled","closed"],"title":"OpportunityStatus"},"OrderCustomerItem":{"properties":{"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"internal_notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Notes"},"email":{"type":"string","title":"Email"}},"type":"object","required":["email"],"title":"OrderCustomerItem"},"OrderCustomerItemOut":{"properties":{"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"internal_notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Notes"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"id":{"type":"string","title":"Id","description":"Technical id of the customer in Chift"}},"type":"object","required":["id"],"title":"OrderCustomerItemOut"},"OrderItemIn":{"properties":{"customer":{"$ref":"#/components/schemas/OrderCustomerItem"},"billing_address":{"$ref":"#/components/schemas/CommerceAddressItemIn"},"shipping_address":{"$ref":"#/components/schemas/CommerceAddressItemIn"},"currency":{"type":"string","title":"Currency","description":"Indicates the currency of the order (e.g. EUR)."},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"},"lines":{"items":{"$ref":"#/components/schemas/OrderLineItemIn"},"type":"array","minItems":1,"title":"Lines"},"payment_method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method","description":"If filled in the order will be marked as paid and processed by this payment method."}},"type":"object","required":["customer","billing_address","shipping_address","currency","lines"],"title":"OrderItemIn"},"OrderItemOut":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"order_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Number"},"customer":{"anyOf":[{"$ref":"#/components/schemas/OrderCustomerItemOut"},{"type":"null"}]},"billing_address":{"anyOf":[{"$ref":"#/components/schemas/CommerceAddressItemOut"},{"type":"null"}]},"shipping_address":{"anyOf":[{"$ref":"#/components/schemas/CommerceAddressItemOut"},{"type":"null"}]},"created_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created On"},"last_updated_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Updated On"},"confirmed_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Confirmed On"},"delivery_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Delivery Date"},"cancelled_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Cancelled On"},"status":{"$ref":"#/components/schemas/OrderStatus"},"fulfillment":{"anyOf":[{"$ref":"#/components/schemas/EcommerceFulfillmentObject"},{"type":"null"}]},"discount_amount":{"type":"number","title":"Discount Amount"},"untaxed_amount_without_fees":{"type":"number","title":"Untaxed Amount Without Fees","description":"Untaxed amount without fees (e.g. shipping) but with discout. Refunds and returns are not included."},"tax_amount_without_fees":{"type":"number","title":"Tax Amount Without Fees","description":"Total taxes applied to the order without taxes linked to fees (e.g. shipping)."},"total_without_fees":{"type":"number","title":"Total Without Fees","description":"Total of the order without fees (e.g. shipping) but with discount. Refunds and returns are not included."},"current_untaxed_amount":{"type":"number","title":"Current Untaxed Amount","description":"Untaxed amount with discout and any kind of fee (e.g. shipping). After returns, removes and returns."},"current_tax_amount":{"type":"number","title":"Current Tax Amount","description":"Total taxes applied to the order. After returns, removes and returns."},"current_total":{"type":"number","title":"Current Total","description":"Current total of the order with discount. After returns, removes and returns."},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Untaxed amount with discout and any kind of fee (e.g. shipping). Refunds and returns are not included."},"tax_amount":{"type":"number","title":"Tax Amount","description":"Total taxes applied to the order. Refunds and returns are not included."},"total":{"type":"number","title":"Total","description":"Total of the order with discount. Refunds and returns are not included."},"refunded_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Refunded Amount","default":0},"currency":{"type":"string","title":"Currency","description":"Indicates the currency of the order (e.g. EUR)."},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags","default":[]},"lines":{"items":{"$ref":"#/components/schemas/OrderLineItemOut"},"type":"array","title":"Lines"},"other_fees":{"anyOf":[{"items":{"$ref":"#/components/schemas/FeesItem"},"type":"array"},{"type":"null"}],"title":"Other Fees","default":[]},"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Id","description":"Technical id of the payment method in the eCommerce"},"transactions":{"anyOf":[{"items":{"$ref":"#/components/schemas/OrderTransactions"},"type":"array"},{"type":"null"}],"title":"Transactions","default":[]},"payment_methods":{"anyOf":[{"items":{"$ref":"#/components/schemas/OrderPaymentMethods"},"type":"array"},{"type":"null"}],"title":"Payment Methods","default":[]},"detailed_refunds":{"anyOf":[{"items":{"$ref":"#/components/schemas/OrderRefundItem"},"type":"array"},{"type":"null"}],"title":"Detailed Refunds"},"returns":{"anyOf":[{"items":{"$ref":"#/components/schemas/OrderReturnItem"},"type":"array"},{"type":"null"}],"title":"Returns","default":[]}},"type":"object","required":["id","source_ref","status","discount_amount","untaxed_amount_without_fees","tax_amount_without_fees","total_without_fees","current_untaxed_amount","current_tax_amount","current_total","untaxed_amount","tax_amount","total","currency","lines"],"title":"OrderItemOut"},"OrderLineItemIn":{"properties":{"variant_id":{"type":"string","title":"Variant Id","description":"Technical id of the product variant in Chift"},"quantity":{"type":"integer","title":"Quantity"},"tax_rate":{"type":"number","title":"Tax Rate","description":"Indicates the tax rate used for the line (e.g. 21.0)."},"unit_price":{"type":"number","title":"Unit Price","description":"Unit price of the product without taxes."}},"type":"object","required":["variant_id","quantity","tax_rate","unit_price"],"title":"OrderLineItemIn"},"OrderLineItemOut":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"created_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created On"},"variant":{"anyOf":[{"$ref":"#/components/schemas/OrderLineProductVariantItem"},{"type":"null"}],"description":"Product variant"},"quantity":{"type":"integer","title":"Quantity"},"current_quantity":{"type":"integer","title":"Current Quantity","description":"Quantity without refunds and returns."},"unit_price":{"type":"number","title":"Unit Price","description":"Unit price of the product without taxes."},"description":{"type":"string","title":"Description"},"tax_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Id","description":"Technical id of the tax rate in Chift"},"tax_rate":{"type":"number","title":"Tax Rate","description":"Indicates the tax rate used for the line (e.g. 21.0)."},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Untaxed amount of the order line with discount."},"tax_amount":{"type":"number","title":"Tax Amount","description":"Total taxes applied to the order line."},"total":{"type":"number","title":"Total","description":"Total of the order line with discount."},"discounts":{"anyOf":[{"items":{"$ref":"#/components/schemas/CommerceDiscountItem"},"type":"array"},{"type":"null"}],"title":"Discounts","default":[]},"gift_card":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Gift Card","default":false},"is_gift":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Gift","default":false}},"type":"object","required":["id","source_ref","quantity","current_quantity","unit_price","description","tax_rate","untaxed_amount","tax_amount","total"],"title":"OrderLineItemOut"},"OrderLineProductVariantItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the product variant in Chift"},"sku":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sku"},"name":{"type":"string","title":"Name"},"categories":{"anyOf":[{"items":{"$ref":"#/components/schemas/CommerceProductCategoryItem"},"type":"array"},{"type":"null"}],"title":"Categories","default":[]}},"type":"object","required":["id","name"],"title":"OrderLineProductVariantItem"},"OrderPaymentMethods":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the payment method in the eCommerce"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the payment method"}},"type":"object","required":["id"],"title":"OrderPaymentMethods"},"OrderRefundItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"created_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created On"},"total":{"type":"number","title":"Total"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"order_lines":{"anyOf":[{"items":{"$ref":"#/components/schemas/RefundOrderLineItem"},"type":"array"},{"type":"null"}],"title":"Order Lines","default":[]},"other":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Other","default":0},"shipping_refunds":{"anyOf":[{"items":{"$ref":"#/components/schemas/ShippingRefund"},"type":"array"},{"type":"null"}],"title":"Shipping Refunds","default":[]},"other_fees":{"anyOf":[{"items":{"$ref":"#/components/schemas/RefundFeesItem"},"type":"array"},{"type":"null"}],"title":"Other Fees","default":[]},"transactions":{"anyOf":[{"items":{"$ref":"#/components/schemas/OrderTransactions"},"type":"array"},{"type":"null"}],"title":"Transactions","default":[]}},"type":"object","required":["id","source_ref","total"],"title":"OrderRefundItem"},"OrderReturnItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the return in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"created_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created On"},"order_lines":{"anyOf":[{"items":{"$ref":"#/components/schemas/ReturnOrderLineItem"},"type":"array"},{"type":"null"}],"title":"Order Lines","default":[]},"new_lines":{"anyOf":[{"items":{"$ref":"#/components/schemas/ReturnOrderLineItem"},"type":"array"},{"type":"null"}],"title":"New Lines","default":[]},"linked_fees":{"anyOf":[{"items":{"$ref":"#/components/schemas/ReturnFeesItem"},"type":"array"},{"type":"null"}],"title":"Linked Fees","default":[]}},"type":"object","required":["id","source_ref"],"title":"OrderReturnItem"},"OrderStatus":{"type":"string","enum":["cancelled_unpaid","cancelled","draft","confirmed","shipped","refunded"],"title":"OrderStatus"},"OrderTransactions":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the transaction in the eCommerce"},"created_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created On"},"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Id","description":"Technical id of the payment method in the eCommerce"},"payment_method_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Name","description":"Name of the payment method"},"amount":{"type":"number","title":"Amount"},"status":{"$ref":"#/components/schemas/CommerceTransactionStatus"}},"type":"object","required":["id","amount","status"],"title":"OrderTransactions"},"OriginalOutstandingItem":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"Unique id of the original outstanding item in the accounting system."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number","description":"Number of the original outstanding item."},"journal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Journal Id","description":"Id of the journal associated with the original outstanding item."},"journal_type":{"anyOf":[{"$ref":"#/components/schemas/JournalType"},{"type":"null"}],"description":"Type of the journal associated with the original outstanding item."},"date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date","description":"Date of the original outstanding item."},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date","description":"Due date of the original outstanding item."},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference","description":"Reference of the original outstanding item."}},"type":"object","title":"OriginalOutstandingItem"},"OutstandingItem":{"properties":{"id":{"type":"string","title":"Id","description":"Unique id of the outstanding item instance in the accounting system."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number","description":"Invoice, Journal entry or Financial entry number of the outstanding item."},"journal_id":{"type":"string","title":"Journal Id","description":"Id of the journal instance associated with the outstanding item."},"journal_type":{"$ref":"#/components/schemas/JournalType","description":"Type of the journal associated with the outstanding item. This indicates the type of journal in which the outstanding item is recorded, such as 'sales', 'purchases', 'bank', etc. It helps in categorizing the outstanding item based on the nature of the transaction."},"date":{"type":"string","format":"date","title":"Date","description":"Accounting date of the outstanding item."},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date","description":"Due date of the outstanding item."},"currency":{"type":"string","title":"Currency","description":"Currency of the outstanding item (e.g., EUR, USD)."},"currency_exchange_rate":{"type":"number","title":"Currency Exchange Rate","description":"Exchange rate applicable at the date of the outstanding item if currency different from folder's default currency."},"amount":{"type":"number","title":"Amount","description":"Total amount"},"open_amount":{"type":"number","title":"Open Amount","description":"Open amount."},"partner_id":{"type":"string","title":"Partner Id","description":"Id of the thirdparty (customer, supplier or employee) in the accounting system linked to the outstanding item. This is used to identify the entity associated with the outstanding item."},"account_number":{"type":"string","title":"Account Number","description":"Account number in the chart of accounts associated with the outstanding item. This is typically used to book the outstanding item against a specific ledger account."},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference","description":"Reference of the outstanding item. This is an optional field that can be used to store additional information or context related to the outstanding item, such as an invoice number or a transaction reference."},"matching_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Matching Numbers","description":"List of matching numbers associated with the outstanding item. This is used to track any matching operations that have been performed on the outstanding item, such as payments or adjustments.","default":[]},"payment_communication":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Communication","description":"Payment communication associated with the outstanding item. This is an optional field that can be used to store additional information related to the payment"},"posted":{"type":"boolean","title":"Posted","description":"Indicates if the outstanding item has been posted (finalized) in the accounting system. If not provided, it defaults to True."},"original_document":{"anyOf":[{"$ref":"#/components/schemas/OriginalOutstandingItem"},{"type":"null"}],"description":"Details of the original document associated with the outstanding item. This is used to link the outstanding item to its original source when oustanding item was initially posted in previous bookyear."}},"type":"object","required":["id","journal_id","journal_type","date","currency","currency_exchange_rate","amount","open_amount","partner_id","account_number","posted"],"title":"OutstandingItem"},"OutstandingType":{"type":"string","enum":["client","supplier"],"title":"OutstandingType"},"PMSAccountingCategoryItem":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the accounting category","examples":["371ca583-d218-4900-b236-397532cf0e2"]},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"name":{"type":"string","title":"Name","description":"Name given to the accounting category","examples":["Beverages"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code assigned to the category","examples":["123456"]},"ledger_account_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ledger Account Code","description":"Ledger account code assigned to the category","examples":["123456"]},"posting_account_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Posting Account Code","description":"Posting account code assigned to the category","examples":["123456"]}},"type":"object","required":["id","source_ref","name"],"title":"PMSAccountingCategoryItem"},"PMSAccountingTransactionItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"group_id":{"type":"string","title":"Group Id","description":"Group id of the transaction"},"date":{"type":"string","format":"date-time","title":"Date","description":"Datetime of the transaction.This is the date when the transaction is recorded in the pms system."},"amount":{"type":"number","title":"Amount","description":"Total amount"},"is_tax_line":{"type":"boolean","title":"Is Tax Line","description":"Indicates the transaction is tax line"},"sub_group_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sub Group Id","description":"Sub group id of the transaction"},"tax_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Code","description":"Indicates the tax code used for the transaction. This is the Id of the Tax Code in the pms software."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Text description for this transaction.","default":""},"currency_exchange_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Currency Exchange Rate","description":"Exchange rate applicable at the transaction date.","default":1},"currency":{"type":"string","title":"Currency","description":"Indicates the currency of the operation (e.g., EUR, USD)."},"transaction_type":{"$ref":"#/components/schemas/PMSAccountingTransactionType","description":"Type of transaction","examples":["pos"]},"accounting_category_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accounting Category Id","description":"Used by a PMS to give specific accounting categories to a transaction item.","examples":["371ca583-d218-4900-b236-397532cf0e2"]},"ledger_account_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ledger Account Code","description":"Ledger account code assigned to the category","examples":["123456"]},"status":{"$ref":"#/components/schemas/PMSAccountingTransactionStatus","description":"string indicating if invoice has been posted (finalized) in the pms system.","examples":["posted"]},"origin":{"anyOf":[{"$ref":"#/components/schemas/PMSAccountingTransactionOrigin"},{"type":"null"}],"description":"Type of origin of the transaction item","examples":[{"id":"1","type":"payment"}]},"partner_id":{"anyOf":[{"$ref":"#/components/schemas/ChiftId"},{"type":"null"}],"description":"Reference to the partner related to this transaction"},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference","description":"Optional reference field used to store an external or contextual identifier related to the transaction."},"location_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Id","description":"ID of the location this transaction belongs to"}},"type":"object","required":["id","source_ref","group_id","date","amount","is_tax_line","currency","transaction_type","status","origin"],"title":"PMSAccountingTransactionItem"},"PMSAccountingTransactionOrigin":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in the target software","examples":["1"]},"type":{"$ref":"#/components/schemas/PMSAccountingTransactionOriginType","description":"Type of the transaction","examples":["invoice"]}},"type":"object","required":["id","type"],"title":"PMSAccountingTransactionOrigin"},"PMSAccountingTransactionOriginType":{"type":"string","enum":["payment","invoice","order"],"title":"PMSAccountingTransactionOriginType"},"PMSAccountingTransactionStatus":{"type":"string","enum":["draft","posted"],"title":"PMSAccountingTransactionStatus"},"PMSAccountingTransactionType":{"type":"string","enum":["payment","room","addon","invoice","pos","fee","tax","reservation","other"],"title":"PMSAccountingTransactionType"},"PMSClosureItem":{"properties":{"date":{"type":"string","format":"date","title":"Date","description":"Date of the closure","examples":["2025-01-01"]},"status":{"$ref":"#/components/schemas/ClosureStates","description":"Status of the closure","examples":["closed"]},"closures":{"anyOf":[{"items":{"$ref":"#/components/schemas/POSClosureInformationItem"},"type":"array"},{"type":"null"}],"title":"Closures","description":"Info about closures related to specific day","default":[]}},"type":"object","required":["date","status"],"title":"PMSClosureItem"},"PMSCustomerItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"First name of the customer. In case the customer is an individual.","examples":["John"]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Last name of the customer. In case the customer is an individual.","examples":["Doe"]},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name","description":"Company name of the customer. In case the customer is a company.","examples":["Acme Corp"]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone","description":"Phone number of the customer","examples":["+1234567890"]},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Email address of the customer","examples":["john.doe@example.com"]},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number","description":"Number of the accounting account used (e.g. 701000)","examples":["701000"]},"created_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created On","description":"Creation date of the customer","examples":["2023-09-25T12:00:00"]},"addresses":{"anyOf":[{"items":{"$ref":"#/components/schemas/AddressItem"},"type":"array"},{"type":"null"}],"title":"Addresses","description":"List of addresses related to the customer"}},"type":"object","required":["id","source_ref"],"title":"PMSCustomerItem"},"PMSInvoiceFullItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"invoice_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Number","description":"Number/sequence","examples":["INV-12345"]},"creation_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Creation Date","description":"Creation date of the invoice","examples":["2023-10-01T12:00:00"]},"closing_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Closing Date","description":"Closing date of the invoice","examples":["2023-10-10T12:00:00"]},"partners":{"anyOf":[{"items":{"$ref":"#/components/schemas/InvoicePartnerItem"},"type":"array"},{"type":"null"}],"title":"Partners","description":"List of partners related to the invoice"},"items":{"items":{"$ref":"#/components/schemas/PMSOrderLineItem"},"type":"array","title":"Items","description":"List of items related to the invoice"},"payments":{"items":{"$ref":"#/components/schemas/PMSPaymentItem"},"type":"array","title":"Payments","description":"List of payments related to the invoice"},"service_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Service Id","description":"Reference to the service related to this order"},"reservation":{"anyOf":[{"$ref":"#/components/schemas/ReservationItem"},{"type":"null"}],"description":"Reference to the reservation related to this order"},"tax_amount":{"type":"number","title":"Tax Amount","description":"Taxes amount","examples":[21.0]},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Untaxed amount","examples":[100.0]},"total":{"type":"number","title":"Total","description":"Total amount incl. taxes","examples":[121.0]}},"type":"object","required":["id","source_ref","invoice_number","items","payments","tax_amount","untaxed_amount","total"],"title":"PMSInvoiceFullItem"},"PMSLocationItem":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the location","examples":["371ca583-d218-4900-b236-397532cf0e52"]},"name":{"type":"string","title":"Name","description":"Name given to the location","examples":["Restaurant de la Paix"]},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone","description":"Indicates the timezone of the location. TZ notation, e.g. Europe/Brussels .","examples":["Europe/Paris"]},"address":{"anyOf":[{"$ref":"#/components/schemas/AddressItem"},{"type":"null"}],"description":"Address of the location"}},"type":"object","required":["id","name"],"title":"PMSLocationItem"},"PMSOrderItem":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the order","examples":["123"]},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"order_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Number","description":"Order number (often unique reference during the day)","examples":["1"]},"creation_date":{"type":"string","format":"date-time","title":"Creation Date","description":"Creation date of the order","examples":["2025-01-01T00:00:00Z"]},"closing_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Closing Date","description":"Closing date of the order","examples":["2025-01-01T00:00:00Z"]},"service_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Service Date","description":"Indicates the date of the service to which the order belongs (can be used to group orders by closure date)","examples":["2025-01-01T00:00:00Z"]},"device_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Device Id","description":"ID of device that created the order","examples":["device-123"]},"total":{"type":"number","title":"Total","description":"Total amount including tax of the order","examples":[11]},"tax_amount":{"type":"number","title":"Tax Amount","description":"Total amount of the taxes of the order","examples":[1]},"total_discount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Discount","description":"Total amount of the discounts of the order","default":"0","examples":[10]},"total_refund":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Refund","description":"Total amount of the refunds of the order","default":"0","examples":[5]},"total_tip":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Tip","description":"Total amount of the tips of the order. Tips are not part of the total of the order","default":"0","examples":[1]},"delivery_fee":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Delivery Fee","description":"Total amount of the delivery fees of the order","default":"0","examples":[1]},"mode":{"anyOf":[{"$ref":"#/components/schemas/Mode"},{"type":"null"}],"description":"Delivery Mode","default":"UNKNOWN","examples":["eat_in"]},"source":{"anyOf":[{"$ref":"#/components/schemas/Source"},{"type":"null"}],"description":"Source of the order","default":"UNKNOWN","examples":["web"]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Currency of the order","examples":["EUR"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country of the order, format: ISO 3166-1 codes.","examples":["FR"]},"loyalty":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Loyalty","description":"Loyalty points of the order","examples":[100]},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id","description":"Unique identifier of the customer","examples":["customer-123"]},"location_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Id","description":"Unique identifier of the location","examples":["location-123"]},"taxes":{"anyOf":[{"items":{"$ref":"#/components/schemas/TotalTaxItem"},"type":"array"},{"type":"null"}],"title":"Taxes","description":"List of taxes of the order","default":[]},"guests":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Guests","description":"Number of guests linked to the order","examples":[1]},"items":{"items":{"$ref":"#/components/schemas/PMSOrderLineItem"},"type":"array","title":"Items","description":"List of items related to the order"},"service_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Service Id","description":"Reference to the service related to this order"},"reservation":{"anyOf":[{"$ref":"#/components/schemas/ReservationItem"},{"type":"null"}],"description":"Reference to the reservation related to this order"},"bills":{"anyOf":[{"items":{"$ref":"#/components/schemas/InvoiceItem"},"type":"array"},{"type":"null"}],"title":"Bills","description":"Reference to the bills related to this order"}},"type":"object","required":["id","source_ref","creation_date","total","tax_amount","items"],"title":"PMSOrderItem"},"PMSOrderLineItem":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the order line item","examples":["123"]},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"type":{"anyOf":[{"$ref":"#/components/schemas/POSLineItemType"},{"type":"null"}],"description":"Type of the order line item","examples":["product"]},"menu_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Menu Id","description":"Unique identifier of the menu","examples":["456"]},"quantity":{"type":"number","title":"Quantity","description":"Quantity of the order line item","examples":[1]},"unit_price":{"type":"number","title":"Unit Price","description":"Unit price (without tax) of the order line item","examples":[10]},"total":{"type":"number","title":"Total","description":"Total amount including tax of the order line item","examples":[11]},"tax_amount":{"type":"number","title":"Tax Amount","description":"Total amount of the taxes of the order line item","examples":[1]},"tax_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Tax Rate","description":"Tax rate of the order line item","examples":[10]},"tax_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Id","description":"Unique identifier of the tax of the order line item","examples":["371ca583-d218-4900-b236-397532cf0e39"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the order line item","examples":["Pizza"]},"discounts":{"anyOf":[{"items":{"$ref":"#/components/schemas/DiscountItem"},"type":"array"},{"type":"null"}],"title":"Discounts","description":"List of discounts of the order line item. Discounts of items are always part of the total discount of the order","default":[],"examples":[[]]},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product Id","description":"Reference to the product related to this item","examples":["789"]},"accounting_category_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accounting Category Id","description":"Sometimes used by a POS to give a specific accounting category to an order item","examples":["123"]}},"type":"object","required":["id","source_ref","quantity","unit_price","total","tax_amount"],"title":"PMSOrderLineItem"},"PMSPaymentItem":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"Unique identifier of the payment","examples":["payment-123"]},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Id","description":"Unique identifier of the payment method used for the payment","examples":["payment-method-123"]},"payment_method_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Name","description":"Chift's name of the payment method used for the payment","examples":["Cash"]},"total":{"type":"number","title":"Total","description":"Total amount of the payment","examples":[11]},"tip":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Tip","description":"Total amount of the tips of the payment. Tips are not part of the total of the payment","default":"0","examples":[1]},"status":{"anyOf":[{"$ref":"#/components/schemas/POSPaymentStatus"},{"type":"null"}],"description":"Status of the payment","default":"Unknown","examples":["Completed"]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Currency of the payment","examples":["EUR"]},"date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Date","description":"Date of the payment","examples":["2025-01-01T00:00:00Z"]},"partner_id":{"anyOf":[{"$ref":"#/components/schemas/ChiftId"},{"type":"null"}],"description":"Reference to the customer related to this payment"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the payment","examples":["Payment for invoice INV-12345"]}},"type":"object","required":["source_ref","total"],"title":"PMSPaymentItem"},"PMSPaymentMethods":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the payment method","examples":["371ca583-d218-4900-b236-397532cf0e52"]},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"name":{"type":"string","title":"Name","description":"Chift's name of the payment method (e.g. 'Cash', 'Card', 'Transfer', ...)","examples":["Cash"]},"extra":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Extra","description":"Original name of the payment method","examples":["Espèces"]},"ledger_account_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ledger Account Code","description":"Ledger account code assigned to the category","examples":["4000"]}},"type":"object","required":["id","source_ref","name"],"title":"PMSPaymentMethods"},"PMSStates":{"type":"string","enum":["consumed","closed"],"title":"PMSStates"},"PMSTaxRateItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label","description":"Label of the tax rate","examples":["VAT 21%"]},"rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rate","description":"Percentage of the tax rate","examples":[21.0]},"is_city_tax":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is City Tax","description":"Indicates if the tax is a city tax (or tourist tax)","examples":[false]}},"type":"object","required":["id","source_ref"],"title":"PMSTaxRateItem"},"POSClosureInformationItem":{"properties":{"id":{"type":"string","title":"Id"},"total":{"type":"number","title":"Total","description":"Total amount of the payments in current closure"},"tax_amount":{"type":"number","title":"Tax Amount","description":"Total tax amount the in current closure"},"payments":{"anyOf":[{"items":{"$ref":"#/components/schemas/ClosurePaymentItem"},"type":"array"},{"type":"null"}],"title":"Payments","description":"List of payments related to current closure","default":[]},"taxes":{"anyOf":[{"items":{"$ref":"#/components/schemas/TotalTaxItem"},"type":"array"},{"type":"null"}],"title":"Taxes","description":"List of taxes related to current closure","default":[]}},"type":"object","required":["id","total","tax_amount"],"title":"POSClosureInformationItem"},"POSCreateCustomerItem":{"properties":{"first_name":{"type":"string","minLength":1,"title":"First Name","description":"First name of the customer","examples":["John"]},"last_name":{"type":"string","minLength":1,"title":"Last Name","description":"Last name of the customer","examples":["Doe"]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone","description":"Phone number (mobile, home, work, ...) of the customer","examples":["+32475123456"]},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Email address of the customer","examples":["john.doe@gmail.com"]},"address":{"anyOf":[{"$ref":"#/components/schemas/PostAddressItem"},{"type":"null"}],"description":"Address of the customer"}},"type":"object","required":["first_name","last_name"],"title":"POSCreateCustomerItem"},"POSCustomerItem":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the customer","examples":["371ca583-d218-8000-b236-397532cf0e52"]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"First name of the customer","examples":["John"]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Last name of the customer","examples":["Doe"]},"name":{"type":"string","title":"Name","description":"Name (first name + last name) of the customer","examples":["John Doe"]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone","description":"Phone number (mobile, home, work, ...) of the customer","examples":["+32475123456"]},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Email address of the customer","examples":["john.doe@gmail.com"]},"created_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created On","description":"Date and time when the customer was created","examples":["2025-01-01T00:00:00Z"]},"addresses":{"anyOf":[{"items":{"$ref":"#/components/schemas/AddressItem"},"type":"array"},{"type":"null"}],"title":"Addresses","description":"List of addresses of the customer","default":[]},"loyalty":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Loyalty","description":"Loyalty points of the customer","examples":[100]},"birthdate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Birthdate","description":"Birthdate of the customer","examples":["1990-01-01"]}},"type":"object","required":["id","name"],"title":"POSCustomerItem"},"POSItem":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the order line item","examples":["123"]},"type":{"anyOf":[{"$ref":"#/components/schemas/POSLineItemType"},{"type":"null"}],"description":"Type of the order line item","examples":["product"]},"menu_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Menu Id","description":"Unique identifier of the menu","examples":["456"]},"quantity":{"type":"number","title":"Quantity","description":"Quantity of the order line item","examples":[1]},"unit_price":{"type":"number","title":"Unit Price","description":"Unit price (without tax) of the order line item","examples":[10]},"total":{"type":"number","title":"Total","description":"Total amount including tax of the order line item","examples":[11]},"tax_amount":{"type":"number","title":"Tax Amount","description":"Total amount of the taxes of the order line item","examples":[1]},"tax_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Tax Rate","description":"Tax rate of the order line item","examples":[10]},"tax_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Id","description":"Unique identifier of the tax of the order line item","examples":["371ca583-d218-4900-b236-397532cf0e39"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the order line item","examples":["Pizza"]},"discounts":{"anyOf":[{"items":{"$ref":"#/components/schemas/DiscountItem"},"type":"array"},{"type":"null"}],"title":"Discounts","description":"List of discounts of the order line item. Discounts of items are always part of the total discount of the order","default":[],"examples":[[]]},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product Id","description":"Reference to the product related to this item","examples":["789"]},"accounting_category_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accounting Category Id","description":"Sometimes used by a POS to give a specific accounting category to an order item","examples":["123"]}},"type":"object","required":["id","quantity","unit_price","total","tax_amount"],"title":"POSItem"},"POSLineItemType":{"type":"string","enum":["menu","product","service","general_discount"],"title":"POSLineItemType"},"POSLocationItem":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the location","examples":["371ca583-d218-4900-b236-397532cf0e52"]},"name":{"type":"string","title":"Name","description":"Name given to the location","examples":["Restaurant de la Paix"]},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone","description":"Indicates the timezone of the location. TZ notation, e.g. Europe/Brussels .","examples":["Europe/Paris"]},"address":{"anyOf":[{"$ref":"#/components/schemas/AddressItem"},{"type":"null"}],"description":"Address of the location"}},"type":"object","required":["id","name"],"title":"POSLocationItem"},"POSOrderItem":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the order","examples":["371ca583-d218-4900-b236-397532cf0e52"]},"order_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Number","description":"Order number (often unique reference during the day)","examples":["1"]},"creation_date":{"type":"string","format":"date-time","title":"Creation Date","description":"Creation date of the order","examples":["2025-01-01T00:00:00Z"]},"closing_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Closing Date","description":"Closing date of the order","examples":["2025-01-01T00:00:00Z"]},"service_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Service Date","description":"Indicates the date of the service to which the order belongs (can be used to group orders by closure date)","examples":["2025-01-01T00:00:00Z"]},"device_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Device Id","description":"ID of device that created the order","examples":["device-123"]},"total":{"type":"number","title":"Total","description":"Total amount including tax of the order","examples":[11]},"tax_amount":{"type":"number","title":"Tax Amount","description":"Total amount of the taxes of the order","examples":[1]},"total_discount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Discount","description":"Total amount of the discounts of the order","default":"0","examples":[10]},"total_refund":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Refund","description":"Total amount of the refunds of the order","default":"0","examples":[5]},"total_tip":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Tip","description":"Total amount of the tips of the order. Tips are not part of the total of the order","default":"0","examples":[1]},"delivery_fee":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Delivery Fee","description":"Total amount of the delivery fees of the order","default":"0","examples":[1]},"mode":{"anyOf":[{"$ref":"#/components/schemas/Mode"},{"type":"null"}],"description":"Delivery Mode","default":"UNKNOWN","examples":["eat_in"]},"source":{"anyOf":[{"$ref":"#/components/schemas/Source"},{"type":"null"}],"description":"Source of the order","default":"UNKNOWN","examples":["web"]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Currency of the order","examples":["EUR"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country of the order, format: ISO 3166-1 codes.","examples":["FR"]},"loyalty":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Loyalty","description":"Loyalty points of the order","examples":[100]},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id","description":"Unique identifier of the customer","examples":["customer-123"]},"location_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Id","description":"Unique identifier of the location","examples":["location-123"]},"taxes":{"anyOf":[{"items":{"$ref":"#/components/schemas/TotalTaxItem"},"type":"array"},{"type":"null"}],"title":"Taxes","description":"List of taxes of the order","default":[]},"guests":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Guests","description":"Number of guests linked to the order","examples":[1]},"payments":{"items":{"$ref":"#/components/schemas/POSPaymentItem"},"type":"array","title":"Payments","description":"List of payments made for the order"},"items":{"items":{"$ref":"#/components/schemas/POSItem"},"type":"array","title":"Items","description":"List of item lines in the order"}},"type":"object","required":["id","creation_date","total","tax_amount","payments","items"],"title":"POSOrderItem"},"POSPaymentItem":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"Unique identifier of the payment","examples":["payment-123"]},"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Id","description":"Unique identifier of the payment method used for the payment","examples":["payment-method-123"]},"payment_method_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Name","description":"Chift's name of the payment method used for the payment","examples":["Cash"]},"total":{"type":"number","title":"Total","description":"Total amount of the payment","examples":[11]},"tip":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Tip","description":"Total amount of the tips of the payment. Tips are not part of the total of the payment","default":"0","examples":[1]},"status":{"anyOf":[{"$ref":"#/components/schemas/POSPaymentStatus"},{"type":"null"}],"description":"Status of the payment","default":"Unknown","examples":["Completed"]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Currency of the payment","examples":["EUR"]},"date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Date","description":"Date of the payment","examples":["2025-01-01T00:00:00Z"]}},"type":"object","required":["total"],"title":"POSPaymentItem"},"POSPaymentStatus":{"type":"string","enum":["Pending","Completed","Canceled","Failed","Unknown","Authorised"],"title":"POSPaymentStatus"},"POSProductItem":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the product","examples":["371ca583-d218-4900-b236-397532cf0e39"]},"categories":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Categories","description":"List of categories the product belongs to","default":[],"examples":["371ca583-d218-4900-b236-397532cf0e52"]},"name":{"type":"string","title":"Name","description":"Name ofthe product","examples":["Pizza margheritta"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the product","examples":["Pizza margheritta"]},"prices":{"items":{"$ref":"#/components/schemas/ProductPriceItem"},"type":"array","title":"Prices","description":"List of prices for the product"},"accounting_category_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Accounting Category Ids","description":"Used by a POS to give one or more specific accounting categories to a product item. If not available it will use the category ids","examples":["371ca583-d218-4900-b236-397532cf0e2"]}},"type":"object","required":["id","name","prices"],"title":"POSProductItem"},"POSTaxRateItem":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the tax rate","examples":["371ca583-d218-4900-b236-397532cf0e39"]},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label","description":"Label of the tax rate","examples":["VAT 21%"]},"rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rate","description":"Percentage of the tax rate","examples":[21.0]},"tax_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Code","description":"VAT code of the tax rate","examples":["VAT21"]}},"type":"object","required":["id"],"title":"POSTaxRateItem"},"Partner":{"properties":{"external_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Reference","description":"External identifier used to link the client in the accounting system with the corresponding client reference in your own system."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"Only used when the client is an individual (is_company=false). Indicates the first name of the client."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Only used when the client is an individual (is_company=false). Indicates the last name of the client."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Full name or legal name of the client (individual or company). This is the name displayed in the accounting software."},"function":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Function","description":"Only used when the client is an individual (is_company=false). Indicates the function of the client."},"is_company":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Company","description":"Indicates if the client is an individual or a company.","default":true},"company_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Id","description":"Only used when the client is an individual (is_company=false). Indicates the id of the company linked to the client."},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone","description":"Phone number of the client."},"mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile","description":"Mobile phone number of the client."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Email address of the client."},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language","description":"Language of the client. Format: ISO 639-1 codes."},"internal_notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Notes","description":"Internal notes about the client."},"website":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website","description":"Website of the client."},"vat":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vat","description":"VAT number of the client."},"iban":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Iban","description":"IBAN account number of the client. DEPRECATED see bank_accounts"},"bank_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Account","description":"Bank account number of the client. DEPRECATED see bank_accounts"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Indicates the currency of the client (e.g., EUR)."},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Indicates if the client is active.","default":true},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number","description":"Ledger account number assigned to the customer in the accounting system as it will appear in the official accounting export file (FEC, SIE, iXBRL, etc.)."},"company_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Number","description":"Id of the associated company, used when the record is a contact person linked to a company."},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"Id of the client in the accounting software. This is the unique identifier used to reference the client in the system."},"last_updated_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Updated On","description":"The last time the client has been updated."},"addresses":{"anyOf":[{"items":{"$ref":"#/components/schemas/AddressItemOut"},"type":"array"},{"type":"null"}],"title":"Addresses","description":"List of addresses associated with the client.","default":[]},"third_party_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Third Party Account","description":"Third party account number/code representing the client in the accounting software."},"bank_accounts":{"anyOf":[{"items":{"$ref":"#/components/schemas/BankAccountsItem"},"type":"array"},{"type":"null"}],"title":"Bank Accounts","description":"List of bank accounts information associated with the client."}},"type":"object","title":"Partner"},"PartnerType-Input":{"type":"string","enum":["client","supplier"],"title":"PartnerType"},"PartnerType-Output":{"type":"string","enum":["owner","account"],"title":"PartnerType"},"PatchConnectionItem":{"properties":{"redirect":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Redirect","description":"Indicates whether you want to return to the consumer's redirectUrl after update (true) or whether you want to return on the connection page (false)","default":false},"name":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}],"title":"Name","description":"Can be used to update the name of an existing connection"},"credentials":{"anyOf":[{"items":{"$ref":"#/components/schemas/CredentialItem"},"type":"array"},{"type":"null"}],"title":"Credentials","description":"Can be used to update the credentials of an existing connection. Please use the getIntegrations route to see the available credentials for each integration. Note: The preferred approach to let a consumer change their credentials is to call this endpoint without passing credentials in the body of the request, which will return a link that can be reshared with the consumer to update their credentials through the Chift UI."}},"type":"object","title":"PatchConnectionItem"},"Payment":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"currency":{"type":"string","title":"Currency"},"amount":{"type":"number","title":"Amount","description":"Total amount of the payment. A part of this amount could be reconciled with another invoice."},"dedicated_amount":{"type":"number","title":"Dedicated Amount","description":"Amount of the payment dedicated to the invoice. ","default":0},"payment_date":{"type":"string","format":"date","title":"Payment Date"},"journal_type":{"$ref":"#/components/schemas/JournalType"},"journal_id":{"type":"string","title":"Journal Id"},"journal_name":{"type":"string","title":"Journal Name"},"reconciled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Reconciled","default":false},"communication":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Communication"},"matching_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Matching Number"}},"type":"object","required":["id","name","currency","amount","payment_date","journal_type","journal_id","journal_name"],"title":"Payment"},"PaymentItemOut":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"status":{"$ref":"#/components/schemas/PaymentPaymentStatus","description":"Payment status"},"description":{"type":"string","title":"Description","description":"Description"},"amount":{"type":"number","title":"Amount","description":"Amount"},"currency":{"type":"string","title":"Currency","description":"Currency"},"payment_date":{"type":"string","format":"date-time","title":"Payment Date","description":"Date of creation"},"partner_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Id","description":"Partner ID"}},"type":"object","required":["id","source_ref","status","description","amount","currency","payment_date"],"title":"PaymentItemOut"},"PaymentLocationItem":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the location","examples":["371ca583-d218-4900-b236-397532cf0e52"]},"name":{"type":"string","title":"Name","description":"Name given to the location","examples":["Restaurant de la Paix"]}},"type":"object","required":["id","name"],"title":"PaymentLocationItem"},"PaymentMethodItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"name":{"type":"string","title":"Name"},"active":{"type":"boolean","title":"Active"}},"type":"object","required":["id","source_ref","name","active"],"title":"PaymentMethodItem"},"PaymentMethods":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the payment method","examples":["371ca583-d218-4900-b236-397532cf0e52"]},"name":{"type":"string","title":"Name","description":"Chift's name of the payment method (e.g. 'Cash', 'Card', 'Transfer', ...)","examples":["Cash"]},"extra":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Extra","description":"Original name of the payment method","examples":["Espèces"]}},"type":"object","required":["id","name"],"title":"PaymentMethods"},"PaymentPaymentStatus":{"type":"string","enum":["pending","completed","partially_completed","canceled","failed","unknown","authorized"],"title":"PaymentPaymentStatus"},"PaymentReporting":{"properties":{"method":{"anyOf":[{"$ref":"#/components/schemas/PaymentReportingMethod"},{"type":"null"}],"description":"Payment method"},"conditions":{"anyOf":[{"$ref":"#/components/schemas/PaymentReportingConditions"},{"type":"null"}],"description":"Payment conditions"}},"type":"object","title":"PaymentReporting"},"PaymentReportingConditions":{"type":"string","enum":["TP01","TP02","TP03"],"title":"PaymentReportingConditions"},"PaymentReportingMethod":{"type":"string","enum":["MP01","MP02","MP03","MP04","MP05","MP06","MP07","MP08","MP09","MP10","MP11","MP12","MP13","MP14","MP15","MP16","MP17","MP18","MP19","MP20","MP21","MP22","MP23"],"title":"PaymentReportingMethod"},"PaymentStatus":{"type":"string","enum":["all","unpaid","paid"],"title":"PaymentStatus"},"PaymentTermAccountInfo":{"properties":{"amount":{"type":"number","title":"Amount","description":"Amount to be paid to the G or N account"},"iban":{"type":"string","title":"Iban","description":"IBAN of the G or R account"}},"type":"object","required":["amount","iban"],"title":"PaymentTermAccountInfo"},"PayoutItemOut":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"status":{"$ref":"#/components/schemas/PayoutStatus","description":"Payout status"},"type":{"$ref":"#/components/schemas/PayoutType","description":"Payout type"},"amount":{"type":"number","title":"Amount","description":"Amount transferred to the merchant"},"currency":{"type":"string","title":"Currency","description":"Currency"},"fee":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fee","description":"Total fee applied by the processor"},"extra_fee":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Extra Fee","description":"Extra fee, if exposed by the processor"},"payment_date":{"type":"string","format":"date","title":"Payment Date","description":"Date at which the payout was made"}},"type":"object","required":["id","source_ref","status","type","amount","currency","payment_date"],"title":"PayoutItemOut"},"PayoutStatus":{"type":"string","enum":["scheduled","in_transit","paid","failed","canceled"],"title":"PayoutStatus"},"PayoutType":{"type":"string","enum":["payout","bank_account","other"],"title":"PayoutType"},"PostAddressItem":{"properties":{"name":{"type":"string","minLength":1,"title":"Name","description":"Name given to the address (e.g. 'home')","examples":["home"]},"street":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street","description":"Street name","examples":["Avenue de la République"]},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number","description":"Number of the address","examples":["123"]},"box":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box","description":"Box of the address","examples":["A"]},"city":{"type":"string","minLength":1,"title":"City","description":"City name","examples":["Paris"]},"postal_code":{"type":"string","minLength":1,"title":"Postal Code","description":"Postal code of the address","examples":["75000"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country, format: ISO 3166-1 codes.","examples":["FR"]}},"type":"object","required":["name","city","postal_code"],"title":"PostAddressItem"},"PostConnectionItem":{"properties":{"integrationid":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Integrationid","description":"Can be used to specify the integration code of a specific connector. If specified, the url will point directly to the connection page of the connector and will redirect on save to the redirect url of the consumer if specified."},"name":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}],"title":"Name","description":"Can be used to specify the name of the connection. Must be used in combination with an integrationid."},"credentials":{"anyOf":[{"items":{"$ref":"#/components/schemas/CredentialItem"},"type":"array"},{"type":"null"}],"title":"Credentials","description":"Can be used to specify the credentials of your connection. Must be used in combination with an integrationid and a name. Please use the getIntegrations route to see the available credentials for each integration"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"ISO 3166-1 alpha-2 country code to filter connectors by country. Ignored if integrationid is provided."},"redirect":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Redirect","description":"Indicates whether you want to return to the consumer's redirectUrl after creation (true) or whether you want to stay on the connection selection page (false)(This field is ignored if integrationid is provided)","default":false},"apis":{"anyOf":[{"items":{"type":"string","enum":["Point of Sale","eCommerce","Accounting","Invoicing","Banking","Custom","Payment","Property Management System"]},"type":"array"},{"type":"null"}],"title":"Apis","description":"Can be used to filter connectors by APIs. Ignored if integrationid is provided."}},"type":"object","title":"PostConnectionItem"},"PostConsumerItem":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"Name of the consumer as it will appear in your Chift platform. This name may be used for automated communications, such as automatic mailings if you enable this feature."},"email":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}],"title":"Email","description":"Optional - Email address of the consumer. It can be used for sending automated reminders (if feature enabled) and deployment by mail of local agent (when on-premise connector)."},"internal_reference":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Internal Reference","description":"Your internal reference for the client (e.g., customer ID or unique identifier in your system)."},"redirect_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Redirect Url","description":"URL to redirect the user after completing the activation via our link. Useful for directing customers to a dynamic or personalized url. You can also set up a default static URL in Chift's back office for all consumers."}},"type":"object","required":["name"],"title":"PostConsumerItem"},"PostSyncFlowEvent":{"properties":{"consumers":{"items":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string"}]},"type":"array","title":"Consumers"},"data":{"$ref":"#/components/schemas/PostSyncFlowEventData"}},"type":"object","title":"PostSyncFlowEvent"},"PostSyncFlowEventData":{"properties":{"is_preview":{"type":"boolean","title":"Is Preview","description":"Whether to preview the sync","default":false},"force_restart":{"type":"boolean","title":"Force Restart","description":"Whether to force restart the sync from the specified dates","default":false},"start_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Start Date","description":"Start date for sync range"},"end_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"End Date","description":"End date for sync range"},"force_from_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Force From Date","description":"Force sync from this specific date, overriding flow configuration"},"import_mode":{"anyOf":[{"$ref":"#/components/schemas/ImportMode"},{"type":"null"}],"description":"Import mode: reimport all data or only missing days"}},"additionalProperties":true,"type":"object","title":"PostSyncFlowEventData"},"ProductCategoryItem":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the category","examples":["371ca583-d218-4900-b236-397532cf0e52"]},"name":{"type":"string","title":"Name","description":"Name given to the category","examples":["Pizza"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the category","examples":["Delicious pizza"]},"id_parent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id Parent","description":"Indicates if the category belongs to a parent category","examples":["371ca583-d218-4900-b236-397532cf0e55"]}},"type":"object","required":["id","name"],"title":"ProductCategoryItem"},"ProductCostItem":{"properties":{"amount":{"type":"number","title":"Amount"},"currency":{"type":"string","title":"Currency"}},"type":"object","required":["amount","currency"],"title":"ProductCostItem"},"ProductItem":{"properties":{"name":{"type":"string","title":"Name","description":"Name"},"unit_price":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Price","description":"Unit price"},"tax_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Id","description":"Technical id of the tax in Chift"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Reference/code"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit","description":"Unit of measure matching target software name"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category","description":"Category matching target software name"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Currency matching target software name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description"},"cost":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Cost","description":"Cost of the product","default":0}},"type":"object","required":["name"],"title":"ProductItem"},"ProductItemOut":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"name":{"type":"string","title":"Name","description":"Name"},"unit_price":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Price","description":"Unit price"},"tax_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Id","description":"Technical id of the tax in Chift"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Reference/code"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit","description":"Unit of measure matching target software name"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category","description":"Category matching target software name"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Currency matching target software name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description"},"cost":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Cost","description":"Cost of the product","default":0},"available_quantity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Available Quantity","description":"Available quanity of the product in stock. Will only be used for products that have an inventory (services will always be 0)","default":0}},"type":"object","required":["id","source_ref","name"],"title":"ProductItemOut"},"ProductPriceItem":{"properties":{"unit_price":{"type":"number","title":"Unit Price","description":"Unit price (without tax) of the product","examples":[10]},"tax_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Tax Rate","description":"Tax rate applied to the product","examples":[10]}},"type":"object","required":["unit_price"],"title":"ProductPriceItem"},"ProductStatus":{"type":"string","enum":["unknown","archived","unpublished","published"],"title":"ProductStatus"},"ProductVariantItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"parent_id":{"type":"string","title":"Parent Id","description":"Technical id of the parent product in Chift"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"description_html":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description Html"},"categories":{"anyOf":[{"items":{"$ref":"#/components/schemas/CommerceProductCategoryItem"},"type":"array"},{"type":"null"}],"title":"Categories","default":[]},"created_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created On"},"sku":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sku"},"taxable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Taxable"},"barcode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Barcode"},"available_quantity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Available Quantity","default":0},"prices":{"anyOf":[{"items":{"$ref":"#/components/schemas/CommerceProductPriceItem"},"type":"array"},{"type":"null"}],"title":"Prices","default":[]},"unit_cost":{"anyOf":[{"$ref":"#/components/schemas/ProductCostItem"},{"type":"null"}]},"unit_of_measure":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit Of Measure"},"weight":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Weight","default":0},"weight_unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Weight Unit"},"status":{"anyOf":[{"$ref":"#/components/schemas/ProductStatus"},{"type":"null"}]},"variant_attributes":{"anyOf":[{"items":{"$ref":"#/components/schemas/VariantAttributeItem"},"type":"array"},{"type":"null"}],"title":"Variant Attributes","description":"List of attributes that are specific to the variant of the product.","default":[]},"variant_images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageItem"},"type":"array"},{"type":"null"}],"title":"Variant Images","description":"List of images that are specific to the variant of the product.","default":[]}},"type":"object","required":["id","source_ref","parent_id","name"],"title":"ProductVariantItem"},"ReadFlowConsumerItem":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"id":{"type":"string","title":"Id"},"config":{"anyOf":[{"$ref":"#/components/schemas/FlowConfig-Output"},{"type":"null"}]},"values":{"additionalProperties":true,"type":"object","title":"Values"},"enabled_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Enabled On","description":"Date on which the flow was enabled for this consumer"},"trigger":{"$ref":"#/components/schemas/ReadFlowTrigger"}},"type":"object","required":["name","id","values","trigger"],"title":"ReadFlowConsumerItem"},"ReadFlowItem":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"id":{"type":"string","title":"Id"},"execution":{"anyOf":[{"$ref":"#/components/schemas/FlowExecution"},{"type":"null"}]},"config":{"anyOf":[{"$ref":"#/components/schemas/FlowConfig-Output"},{"type":"null"}],"default":{"datastores":[]}},"triggers":{"anyOf":[{"items":{"$ref":"#/components/schemas/FlowTrigger"},"type":"array"},{"type":"null"}],"title":"Triggers"}},"type":"object","required":["name","id"],"title":"ReadFlowItem"},"ReadFlowTrigger":{"properties":{"id":{"type":"string","title":"Id"},"type":{"$ref":"#/components/schemas/TriggerType"},"cronschedule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cronschedule"}},"type":"object","required":["id","type"],"title":"ReadFlowTrigger"},"ReadMappingItem":{"properties":{"source_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Id"},"target_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target Id"}},"type":"object","title":"ReadMappingItem"},"ReadSyncItem":{"properties":{"name":{"type":"string","minLength":1,"title":"Name"},"config":{"anyOf":[{"additionalProperties":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"propertyNames":{"const":"presync"},"type":"object"},{"type":"null"}],"title":"Config"},"connections":{"items":{"$ref":"#/components/schemas/SyncsConnectionItem"},"type":"array","title":"Connections"},"mappings":{"items":{"$ref":"#/components/schemas/CreateSyncMappingItem-Output"},"type":"array","title":"Mappings","default":[]},"syncid":{"type":"string","format":"uuid","title":"Syncid"},"consumers":{"items":{"type":"string"},"type":"array","title":"Consumers"},"flows":{"items":{"$ref":"#/components/schemas/ReadFlowItem"},"type":"array","title":"Flows"}},"type":"object","required":["name","connections","syncid","consumers","flows"],"title":"ReadSyncItem"},"ReadSyncMappingItem":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"display_order":{"type":"integer","title":"Display Order","default":0},"challenge_question":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Challenge Question"},"conditions":{"anyOf":[{"additionalProperties":{"additionalProperties":true,"type":"object"},"propertyNames":{"const":"hideIf"},"type":"object"},{"type":"null"}],"title":"Conditions"},"values":{"items":{"$ref":"#/components/schemas/ReadMappingItem"},"type":"array","title":"Values"},"hidden_source_ids":{"items":{"type":"string"},"type":"array","title":"Hidden Source Ids"},"sub_mapping_name":{"type":"string","title":"Sub Mapping Name"},"sub_mapping_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sub Mapping Description"}},"type":"object","required":["name","values","hidden_source_ids","sub_mapping_name"],"title":"ReadSyncMappingItem"},"ReadSyncSkipMappingItem":{"properties":{"name":{"type":"string","title":"Name"},"skip_reason":{"$ref":"#/components/schemas/SyncSkipReason"}},"type":"object","required":["name","skip_reason"],"title":"ReadSyncSkipMappingItem"},"Ref":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"Technical id in the target software"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Name of the model/entity in the target software"}},"type":"object","title":"Ref"},"RefundFeesItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the fee in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"type":{"$ref":"#/components/schemas/FeesType"},"untaxed_amount":{"type":"number","title":"Untaxed Amount"},"tax_amount":{"type":"number","title":"Tax Amount"},"total":{"type":"number","title":"Total"}},"type":"object","required":["id","source_ref","type","untaxed_amount","tax_amount","total"],"title":"RefundFeesItem"},"RefundItemOut":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"status":{"$ref":"#/components/schemas/PaymentPaymentStatus","description":"Payment status"},"description":{"type":"string","title":"Description","description":"Description"},"amount":{"type":"number","title":"Amount","description":"Amount"},"currency":{"type":"string","title":"Currency","description":"Currency"},"refund_date":{"type":"string","format":"date-time","title":"Refund Date","description":"Date of creation"},"payment_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Id","description":"ID of the payment being refunded"}},"type":"object","required":["id","source_ref","status","description","amount","currency","refund_date"],"title":"RefundItemOut"},"RefundOrderLineItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the order line in Chift"},"variant":{"anyOf":[{"$ref":"#/components/schemas/OrderLineProductVariantItem"},{"type":"null"}],"description":"Product variant"},"quantity":{"type":"integer","title":"Quantity"},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Untaxed amount refunded (after discount)."},"tax_amount":{"type":"number","title":"Tax Amount","description":"Total taxes refunded (after discount)."},"total":{"type":"number","title":"Total","description":"Total refunded (after discount)."}},"type":"object","required":["id","quantity","untaxed_amount","tax_amount","total"],"title":"RefundOrderLineItem"},"ReportCategory":{"type":"string","enum":["Supply of goods subject to value-added tax.","Services subject to value-added tax.","Supply of goods and provision of services not subject to value-added tax in France, including intra-Community distance sales mentioned in 1° of I of Article 258 A and in Article 259 B of the French General Tax Code.","Transactions subject to the regimes provided for in e) of 1 of Article 266 and in Articles 268 and 297 A of the French General Tax Code (VAT margin scheme)."],"title":"ReportCategory"},"ReportItem":{"properties":{"date":{"type":"string","format":"date","title":"Date","description":"Date of the report","examples":["2025-01-01"]},"location_id":{"type":"string","title":"Location Id","description":"Unique identifier of the location","examples":["371ca583-d218-4900-b236-397532cf0e52"]},"orders":{"anyOf":[{"items":{"$ref":"#/components/schemas/ReportOrders"},"type":"array"},{"type":"null"}],"title":"Orders","description":"List of orders related to the report","default":[]},"payments":{"anyOf":[{"items":{"$ref":"#/components/schemas/ReportPayments"},"type":"array"},{"type":"null"}],"title":"Payments","description":"List of payments related to the report","default":[]}},"type":"object","required":["date","location_id"],"title":"ReportItem"},"ReportOrders":{"properties":{"currency":{"type":"string","title":"Currency","description":"Currency of the report (ISO 4217)","examples":["EUR"]},"total":{"type":"number","title":"Total","description":"Total amount including tax of the sales","examples":[10]},"tax_amount":{"type":"number","title":"Tax Amount","description":"Total amount of the taxes","examples":[1]},"tax_duedatetypecode":{"anyOf":[{"type":"string","maxLength":3},{"type":"null"}],"title":"Tax Duedatetypecode","description":"Code giving specific meaning to a date, time or period","examples":["4"]},"category":{"$ref":"#/components/schemas/ReportCategory","description":"Category of the orders","examples":["TLB1"]},"total_orders":{"type":"integer","title":"Total Orders","description":"Total number of orders for the period","examples":[10]},"taxes":{"anyOf":[{"items":{"$ref":"#/components/schemas/TotalTaxItem"},"type":"array"},{"type":"null"}],"title":"Taxes","description":"List of taxes related to the report","default":[]}},"type":"object","required":["currency","total","tax_amount","category","total_orders"],"title":"ReportOrders"},"ReportPayments":{"properties":{"tax_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Id","description":"Unique identifier of the tax","examples":["371ca583-d218-4900-b236-397532cf0e39"]},"tax_rate":{"type":"number","title":"Tax Rate","description":"Tax rate","examples":["10"]},"tax_amount":{"type":"number","title":"Tax Amount","description":"Tax amount","examples":["1"]},"total":{"type":"number","title":"Total","description":"Total amount including tax","examples":["11"]},"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Id","description":"Unique identifier of the payment method used for the payment","examples":["payment_method-1"]},"payment_method_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Name","description":"Chift's name of the payment method used for the payment","examples":["Cash"]},"currency":{"type":"string","title":"Currency","description":"Currency of the payment (ISO 4217)","examples":["EUR"]}},"type":"object","required":["tax_rate","tax_amount","total","currency"],"title":"ReportPayments"},"ReservationItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"start_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Date","description":"Start date of the reservation","examples":["2024-10-01T12:00:00"]},"end_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Date","description":"End date of the reservation","examples":["2024-10-10T12:00:00"]},"creation_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Creation Date","description":"Creation date of the reservation","examples":["2024-09-25T12:00:00"]},"resource_id":{"anyOf":[{"$ref":"#/components/schemas/ChiftId"},{"type":"null"}],"description":"Unique reference to the resource related to the reservation"},"resource_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resource Name","description":"Name of the resource related to the reservation","examples":["Room 101"]},"resource_identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resource Identifier","description":"Identifier of the resource related to the reservation","examples":["R101"]}},"type":"object","required":["id","source_ref"],"title":"ReservationItem"},"ReturnFeesItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the fee in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"type":{"$ref":"#/components/schemas/FeesType"},"untaxed_amount":{"type":"number","title":"Untaxed Amount"},"tax_amount":{"type":"number","title":"Tax Amount"},"total":{"type":"number","title":"Total"}},"type":"object","required":["id","source_ref","type","untaxed_amount","tax_amount","total"],"title":"ReturnFeesItem"},"ReturnOrderLineItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id of the order line in Chift"},"variant":{"anyOf":[{"$ref":"#/components/schemas/OrderLineProductVariantItem"},{"type":"null"}],"description":"Product variant"},"quantity":{"type":"integer","title":"Quantity"},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Untaxed amount refunded (after discount)."},"tax_amount":{"type":"number","title":"Tax Amount","description":"Total taxes refunded (after discount)."},"total":{"type":"number","title":"Total","description":"Total refunded (after discount)."}},"type":"object","required":["id","quantity","untaxed_amount","tax_amount","total"],"title":"ReturnOrderLineItem"},"RoutingCodeItem":{"properties":{"type":{"$ref":"#/components/schemas/BankAccountRoutingType","description":"The routing format. Possible values: ach (US), sort_code (UK), bsb (AU), transit (CA), ifsc (IN), clabe (MX).","default":"unknown"},"value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value","description":"The raw routing code value, without spaces or dashes."}},"type":"object","title":"RoutingCodeItem"},"SalesItem":{"properties":{"total":{"type":"number","title":"Total","description":"Total amount including tax of the sales","examples":[10]},"tax_amount":{"type":"number","title":"Tax Amount","description":"Total amount of the taxes","examples":[1]},"taxes":{"anyOf":[{"items":{"$ref":"#/components/schemas/TotalTaxItem"},"type":"array"},{"type":"null"}],"title":"Taxes","description":"List of taxes grouped by tax rateapplied to the sales","default":[]}},"type":"object","required":["total","tax_amount"],"title":"SalesItem"},"SchemeItem":{"properties":{"id":{"type":"string","title":"Id","description":"Unique id of the scheme instance in the accounting system."},"code":{"type":"string","title":"Code","description":"Short code or identifier of the scheme (e.g., 'RGS', 'SBR')."},"name":{"type":"string","title":"Name","description":"Name or description of the scheme as it appears in the accounting system."}},"type":"object","required":["id","code","name"],"title":"SchemeItem"},"ShippingRefund":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"untaxed_amount":{"type":"number","title":"Untaxed Amount","description":"Untaxed amount refunded (after discount)."},"tax_amount":{"type":"number","title":"Tax Amount","description":"Total taxes refunded (after discount)."},"total":{"type":"number","title":"Total","description":"Total refunded (after discount)."}},"type":"object","required":["id","source_ref","untaxed_amount","tax_amount","total"],"title":"ShippingRefund"},"Source":{"type":"string","enum":["WEB","MOBILE","KIOSK","POS","REMOTE_POS","JUSTEAT","FOODORA","UBEREATS","GLOVO","DELIVEROO","SMILEIN","UNKNOWN"],"title":"Source"},"States":{"type":"string","enum":["open","closed","all"],"title":"States"},"Status":{"type":"string","enum":["active","inactive"],"title":"Status"},"SupplierItemIn":{"properties":{"external_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Reference","description":"External identifier used to link the supplier in the accounting system with the corresponding supplier reference in your own system."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"Only used when the supplier is an individual (is_company=false). Indicates the first name of the supplier."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Only used when the supplier is an individual (is_company=false). Indicates the last name of the supplier."},"name":{"type":"string","minLength":1,"title":"Name","description":"Full name or legal name of the supplier (individual or company). This is the name that will be displayed in the accounting software."},"function":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Function","description":"Only used when the supplier is an individual (is_company=false). Indicates the function of the supplier."},"is_company":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Company","description":"Indicates if the supplier is an individual or a company.","default":true},"company_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Id","description":"Only used when the supplier is an individual (is_company=false). Indicates the id of the company linked to the supplier."},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone","description":"Phone number of the supplier."},"mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile","description":"Mobile phone number of the supplier."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Email address of the supplier."},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language","description":"Language of the supplier. Format: ISO 639-1 codes."},"internal_notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Notes","description":"Internal notes about the supplier."},"website":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website","description":"Website of the supplier."},"vat":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vat","description":"VAT number of the supplier."},"iban":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Iban","description":"IBAN account number of the supplier."},"bank_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Account","description":"Bank account number of the supplier."},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Indicates the currency of the supplier (e.g., EUR)."},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Indicates if the supplier is active.","default":true},"addresses":{"items":{"$ref":"#/components/schemas/AddressItemIn"},"type":"array","title":"Addresses","description":"List of addresses associated with the supplier."},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number","description":"Number of ledger account assigned to the supplier in the accounting system as it will appear in the official accounting export file (FEC, SIE, iXBRL, etc.). This is typically the ledger account used for posting payables. In some systems, each supplier has a dedicated account; in others, a shared control account is used and supplier balances are tracked in a subledger."}},"type":"object","required":["name","addresses"],"title":"SupplierItemIn"},"SupplierItemOut":{"properties":{"external_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Reference","description":"External identifier used to link the supplier in the accounting system with the corresponding supplier reference in your own system."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"Only used when the supplier is an individual (is_company=false). Indicates the first name of the supplier."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Only used when the supplier is an individual (is_company=false). Indicates the last name of the supplier."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Full name or legal name of the supplier (individual or company). This is the name displayed in the accounting software."},"function":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Function","description":"Only used when the supplier is an individual (is_company=false). Indicates the function of the supplier."},"is_company":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Company","description":"Indicates if the supplier is an individual or a company.","default":true},"company_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Id","description":"Only used when the supplier is an individual (is_company=false). Indicates the id of the company linked to the supplier."},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone","description":"Phone number of the supplier."},"mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile","description":"Mobile phone number of the supplier."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Email address of the supplier."},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language","description":"Language of the supplier. Format: ISO 639-1 codes."},"internal_notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Notes","description":"Internal notes about the supplier."},"website":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website","description":"Website of the supplier."},"vat":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vat","description":"VAT number of the supplier."},"iban":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Iban","description":"IBAN account number of the supplier. DEPRECATED see bank_accounts"},"bank_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Account","description":"Bank account number of the supplier. DEPRECATED see bank_accounts"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Indicates the currency of the supplier (e.g., EUR)."},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Indicates if the supplier is active.","default":true},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number","description":"Ledger account number assigned to the supplier in the accounting system as it will appear in the official accounting export file (FEC, SIE, iXBRL, etc.)."},"company_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Number","description":"Id of the associated company, used when the record is a contact person linked to a company."},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"Id of the supplier in the accounting software. This is the unique identifier used to reference the supplier in the system."},"last_updated_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Updated On","description":"The last time the supplier has been updated."},"addresses":{"anyOf":[{"items":{"$ref":"#/components/schemas/AddressItemOut"},"type":"array"},{"type":"null"}],"title":"Addresses","description":"List of addresses associated with the supplier.","default":[]},"third_party_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Third Party Account","description":"Third party account number/code representing the client in the accounting software."},"bank_accounts":{"anyOf":[{"items":{"$ref":"#/components/schemas/BankAccountsItem"},"type":"array"},{"type":"null"}],"title":"Bank Accounts","description":"List of bank accounts information associated with the suppliers."}},"type":"object","title":"SupplierItemOut"},"SupplierItemUpdate":{"properties":{"external_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Reference","description":"External identifier used to link the supplier in the accounting system with the corresponding supplier reference in your own system."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"Only used when the supplier is an individual (is_company=false). Indicates the first name of the supplier."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Only used when the supplier is an individual (is_company=false). Indicates the last name of the supplier."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Full name or legal name of the supplier (individual or company). This is the name that will be displayed in the accounting software."},"function":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Function","description":"Only used when the supplier is an individual (is_company=false). Indicates the function of the supplier."},"is_company":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Company","description":"Indicates if the supplier is an individual or a company.","default":true},"company_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Id","description":"Only used when the supplier is an individual (is_company=false). Indicates the id of the company linked to the supplier."},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone","description":"Phone number of the supplier."},"mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile","description":"Mobile phone number of the supplier."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Email address of the supplier."},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language","description":"Language of the supplier. Format: ISO 639-1 codes."},"internal_notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Notes","description":"Internal notes about the supplier."},"website":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website","description":"Website of the supplier."},"vat":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vat","description":"VAT number of the supplier."},"iban":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Iban","description":"IBAN account number of the supplier."},"bank_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Account","description":"Bank account number of the supplier."},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Indicates the currency of the supplier (e.g., EUR)."},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Indicates if the supplier is active.","default":true},"addresses":{"anyOf":[{"items":{"$ref":"#/components/schemas/AddressItemOut"},"type":"array"},{"type":"null"}],"title":"Addresses","description":"List of addresses associated with the supplier.","default":[]}},"type":"object","title":"SupplierItemUpdate"},"SyncConsumerItem":{"properties":{"syncid":{"type":"string","format":"uuid","title":"Syncid"},"sync_name":{"type":"string","title":"Sync Name","description":"Name of the sync"},"status":{"$ref":"#/components/schemas/SyncConsumerStatus","description":"Indicates whether the consumer has setup the sync. If the setup is complete, it will return 'active'. Otherwise 'inactive'.","default":"inactive"},"status_details":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status Details","description":"Gives additional information if the status is inactive"},"link_createdon":{"type":"string","format":"date-time","title":"Link Createdon","description":"Date on which the consumer first navigated to the link to setup the sync"},"link_mappings":{"anyOf":[{"items":{"$ref":"#/components/schemas/ReadSyncMappingItem"},"type":"array"},{"type":"null"}],"title":"Link Mappings","description":"Values of the mappings requested for the sync for the specific consumer"},"skip_mappings":{"anyOf":[{"items":{"$ref":"#/components/schemas/ReadSyncSkipMappingItem"},"type":"array"},{"type":"null"}],"title":"Skip Mappings","description":"List of mappings which are ignored due to specific configuration of the consumer"},"link_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Link Metadata","description":"Metadata passed during creation"},"link_presync":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Link Presync","description":"Values of the presync configuration for the sync for the specific consumer"},"enabled_flows":{"anyOf":[{"items":{"$ref":"#/components/schemas/ReadFlowConsumerItem"},"type":"array"},{"type":"null"}],"title":"Enabled Flows","description":"List of flows that the consumer has enabled"}},"type":"object","required":["syncid","sync_name","link_createdon"],"title":"SyncConsumerItem"},"SyncConsumerStatus":{"type":"string","enum":["active","inactive"],"title":"SyncConsumerStatus"},"SyncExecutionItem":{"properties":{"id":{"type":"string","title":"Id","description":"Execution id"},"parentexecutionid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentexecutionid","description":"Parent execution id. An execution is linked to multiple child executions linked to consumers."},"start":{"type":"string","format":"date-time","title":"Start"},"end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End"},"status":{"type":"string","title":"Status"},"consumer_id":{"type":"string","title":"Consumer Id"},"flow_id":{"type":"string","title":"Flow Id"}},"type":"object","required":["id","parentexecutionid","start","end","status","consumer_id","flow_id"],"title":"SyncExecutionItem"},"SyncSkipReason":{"type":"string","enum":["presync","connector_feature","challenge"],"title":"SyncSkipReason"},"SyncsConnectionItem":{"properties":{"one_api":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"One Api"},"connection_type":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Connection Type"},"display_order":{"type":"integer","title":"Display Order","default":0},"display_hidden":{"type":"boolean","title":"Display Hidden","default":false}},"type":"object","title":"SyncsConnectionItem"},"TaxInfo":{"properties":{"tax_code":{"type":"string","title":"Tax Code","description":"VAT code of the tax line. This is the Id of the Tax code instance in the accounting software."},"tax_amount":{"type":"number","title":"Tax Amount","description":"Amount of the tax line. The amount must be positive and is required even with reversed VAT."},"vat_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vat Account","description":"VAT ledger account of the tax line. This is the ledger account number used to book the tax amount. The account is mandatory if tax amount is different from 0. The ledger account will ONLY be used when it is mandatory to pass this information to the accounting software."},"reversed_vat_account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reversed Vat Account","description":"Reversed VAT ledger account of the tax line. This is the ledger account number used to book the reversed tax amount. The account is mandatory if you are using a reversed VAT code. The ledger account will ONLY be used when it is mandatory to pass this information to the accounting software."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Optional extra description of the tax line."}},"type":"object","required":["tax_code","tax_amount"],"title":"TaxInfo"},"TaxRateItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"label":{"type":"string","title":"Label"},"rate":{"type":"number","title":"Rate"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country"}},"type":"object","required":["id","source_ref","label","rate"],"title":"TaxRateItem"},"Token":{"properties":{"access_token":{"type":"string","title":"Access Token"},"token_type":{"type":"string","title":"Token Type"},"expires_in":{"type":"integer","title":"Expires In"},"expires_on":{"type":"integer","title":"Expires On"}},"type":"object","required":["access_token","token_type","expires_in","expires_on"],"title":"Token"},"TotalTaxItem":{"properties":{"tax_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Id","description":"Unique identifier of the tax","examples":["371ca583-d218-4900-b236-397532cf0e39"]},"tax_rate":{"type":"number","title":"Tax Rate","description":"Tax rate","examples":["10"]},"tax_amount":{"type":"number","title":"Tax Amount","description":"Tax amount","examples":["1"]},"total":{"type":"number","title":"Total","description":"Total amount including tax","examples":["11"]}},"type":"object","required":["tax_rate","tax_amount","total"],"title":"TotalTaxItem"},"TransactionAccountingCategory":{"type":"string","enum":["all","unknown","payout","payout_cancel","payment","payment_cancel","fee","fee_cancel","invoice","internal_move"],"title":"TransactionAccountingCategory"},"TransactionFilterDateType":{"type":"string","enum":["value_date","execution_date"],"title":"TransactionFilterDateType"},"TransactionItemOut":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"amount":{"type":"number","title":"Amount","description":"Total amount incl. fee"},"fee":{"type":"number","title":"Fee","description":"Total fee"},"currency":{"type":"string","title":"Currency","description":"Currency"},"exchange_rate":{"type":"number","title":"Exchange Rate","description":"Exchange rate"},"create_date":{"type":"string","format":"date-time","title":"Create Date","description":"Create Date"},"application_type":{"type":"string","title":"Application Type","description":"Type of the transaction as recorded in the target software"},"accounting_category":{"$ref":"#/components/schemas/TransactionAccountingCategory","description":"Accounting category"},"refund_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Refund Id"},"payment_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description linked to the transaction"}},"type":"object","required":["id","source_ref","amount","fee","currency","exchange_rate","create_date","application_type","accounting_category"],"title":"TransactionItemOut"},"TriggerPriority":{"type":"string","enum":["NORMAL","MEDIUM","HIGH"],"title":"TriggerPriority"},"TriggerResponse":{"properties":{"status":{"type":"string","title":"Status"},"message":{"type":"string","title":"Message"},"data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Data"}},"type":"object","required":["status","message"],"title":"TriggerResponse"},"TriggerType":{"type":"string","enum":["timer","event"],"title":"TriggerType"},"UpdateConsumerItem":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Name","description":"Name of the consumer as it will appear in your Chift platform. This name may be used for automated communications, such as automatic mailings if you enable this feature."},"email":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}],"title":"Email","description":"Optional - Email address of the consumer. It can be used for sending automated reminders (if feature enabled) and deployment by mail of local agent (when on-premise connector)."},"internal_reference":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Internal Reference","description":"Your internal reference for the client (e.g., customer ID or unique identifier in your system)."},"redirect_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Redirect Url","description":"URL to redirect the user after completing the activation via our link. Useful for directing customers to a dynamic or personalized url. You can also set up a default static URL in Chift's back office for all consumers."}},"type":"object","title":"UpdateConsumerItem"},"UpdateFlowConsumer":{"properties":{"triggerid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Triggerid","default":"trigger-1"},"data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Data","description":"Object containing the configuration of the flow for the consumer","default":{}}},"type":"object","title":"UpdateFlowConsumer"},"UpdateOrderItem":{"properties":{"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id","description":"Unique identifier of the customer","examples":["371ca583-d218-4900-b236-397532cf0e52"]}},"type":"object","title":"UpdateOrderItem"},"UploadDocumentItemOut":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Currency of the uploaded document"},"invoice_type":{"anyOf":[{"$ref":"#/components/schemas/InvoicingInvoiceType"},{"type":"null"}],"description":"Invoice type of the uploaded document"},"status":{"anyOf":[{"$ref":"#/components/schemas/InvoiceStatus"},{"type":"null"}],"description":"Status of the uploaded document"},"invoice_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Invoice Date","description":"Invoicing date"},"tax_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Tax Amount","description":"Taxes amount"},"untaxed_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Untaxed Amount","description":"Untaxed amount"},"total":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total","description":"Total amount incl. taxes"},"lines":{"anyOf":[{"items":{"$ref":"#/components/schemas/InvoiceLineItem"},"type":"array"},{"type":"null"}],"title":"Lines","description":"Invoice lines","default":[]},"partner_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Id","description":"Technical id of the vendor/customer in Chift"},"invoice_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Number","description":"Number/sequence"},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date","description":"Due date"},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference","description":"Reference"},"payment_communication":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Communication","description":"Payment communication"},"customer_memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Memo","description":"Customer note/memo"},"journal_ref":{"anyOf":[{"$ref":"#/components/schemas/FieldRef"},{"type":"null"}],"description":"Journal"},"italian_specificities":{"anyOf":[{"$ref":"#/components/schemas/ItalianSpecificities-Output"},{"type":"null"}],"description":"Specificities for Italy"},"last_updated_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Updated On"},"outstanding_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Outstanding Amount","description":"Amount left to be paid"},"last_payment_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Last Payment Date","description":"Date of the last payment linked to the invoice"},"accounting_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Accounting Date","description":"Accounting date"},"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Id","description":"Technical id of the payment method in Chift"},"currency_exchange_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Currency Exchange Rate","description":"Indicates the exchange rate at the date of the invoice.","default":1}},"type":"object","required":["id","source_ref"],"title":"UploadDocumentItemOut"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VariantAttributeItem":{"properties":{"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"}},"type":"object","required":["name","value"],"title":"VariantAttributeItem"},"VariantAttributeOptionItem":{"properties":{"name":{"type":"string","title":"Name"},"values":{"items":{"type":"string"},"type":"array","title":"Values"}},"type":"object","required":["name","values"],"title":"VariantAttributeOptionItem"},"VariantItem":{"properties":{"id":{"type":"string","title":"Id","description":"Technical id in Chift"},"source_ref":{"$ref":"#/components/schemas/Ref","description":"Technical id in the target software"},"parent_id":{"type":"string","title":"Parent Id","description":"Technical id of the parent product in Chift"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"description_html":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description Html"},"categories":{"anyOf":[{"items":{"$ref":"#/components/schemas/CommerceProductCategoryItem"},"type":"array"},{"type":"null"}],"title":"Categories","default":[]},"created_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created On"},"sku":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sku"},"taxable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Taxable"},"barcode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Barcode"},"available_quantity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Available Quantity","default":0},"prices":{"anyOf":[{"items":{"$ref":"#/components/schemas/CommerceProductPriceItem"},"type":"array"},{"type":"null"}],"title":"Prices","default":[]},"unit_cost":{"anyOf":[{"$ref":"#/components/schemas/ProductCostItem"},{"type":"null"}]},"unit_of_measure":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit Of Measure"},"weight":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Weight","default":0},"weight_unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Weight Unit"},"status":{"anyOf":[{"$ref":"#/components/schemas/ProductStatus"},{"type":"null"}]},"inventory_details":{"anyOf":[{"items":{"$ref":"#/components/schemas/InventoryDetailsItem"},"type":"array"},{"type":"null"}],"title":"Inventory Details","default":[]},"common_attributes":{"anyOf":[{"items":{"$ref":"#/components/schemas/CommonAttributeItem"},"type":"array"},{"type":"null"}],"title":"Common Attributes","description":"List of attributes that are shared by all variants of the product.","default":[]},"variant_attributes":{"anyOf":[{"items":{"$ref":"#/components/schemas/VariantAttributeItem"},"type":"array"},{"type":"null"}],"title":"Variant Attributes","description":"List of attributes that are specific to the variant of the product.","default":[]},"common_images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageItem"},"type":"array"},{"type":"null"}],"title":"Common Images","description":"List of images that are shared by all variants of the product.","default":[]},"variant_images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageItem"},"type":"array"},{"type":"null"}],"title":"Variant Images","description":"List of images that are specific to the variant of the product.","default":[]}},"type":"object","required":["id","source_ref","parent_id","name"],"title":"VariantItem"},"VatCodeScope":{"type":"string","enum":["nat","eu","int","unknown"],"title":"VatCodeScope"},"VatCodeType":{"type":"string","enum":["sale","purchase","both","unknown"],"title":"VatCodeType"},"Visibility":{"type":"string","enum":["consumer","connector","both"],"title":"Visibility"},"WebhookInstanceGetItem":{"properties":{"webhookid":{"type":"string","format":"uuid","title":"Webhookid"},"accountid":{"type":"string","format":"uuid","title":"Accountid"},"createdby":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Createdby"},"createdon":{"type":"string","format":"date-time","title":"Createdon"},"event":{"type":"string","title":"Event"},"url":{"type":"string","title":"Url"},"status":{"$ref":"#/components/schemas/Status"},"integrationid":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Integrationid"}},"type":"object","required":["webhookid","accountid","createdon","event","url","status"],"title":"WebhookInstanceGetItem"},"WebhookInstancePatchItem":{"properties":{"status":{"anyOf":[{"$ref":"#/components/schemas/Status"},{"type":"null"}]},"url":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Url"},"signingsecret":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Signingsecret"}},"type":"object","title":"WebhookInstancePatchItem"},"WebhookInstancePostItem":{"properties":{"event":{"type":"string","maxLength":80,"title":"Event"},"url":{"type":"string","maxLength":500,"title":"Url"},"signingsecret":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Signingsecret"},"integrationid":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Integrationid","description":"Can be used to specify the integration code of a specific connector. This is mandatory in case you create a webhook related to a specific One API."}},"type":"object","required":["event","url"],"title":"WebhookInstancePostItem"},"WebhookItem":{"properties":{"event":{"type":"string","title":"Event"},"api":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api"}},"type":"object","required":["event"],"title":"WebhookItem"},"WebhookLogItem":{"properties":{"webhooklogid":{"type":"string","format":"uuid","title":"Webhooklogid"},"webhookid":{"type":"string","format":"uuid","title":"Webhookid"},"event":{"type":"string","title":"Event"},"url":{"type":"string","title":"Url"},"accountid":{"type":"string","title":"Accountid"},"createdon":{"type":"string","format":"date-time","title":"Createdon"},"httpstatus":{"type":"integer","title":"Httpstatus"},"integrationid":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Integrationid"}},"type":"object","required":["webhooklogid","webhookid","event","url","accountid","createdon","httpstatus"],"title":"WebhookLogItem"},"WelfareFund":{"properties":{"rate":{"type":"number","title":"Rate","description":"Rate"},"amount":{"type":"number","title":"Amount","description":"Amount"},"type":{"anyOf":[{"$ref":"#/components/schemas/WelfareFundType"},{"type":"null"}],"description":"Type"}},"type":"object","required":["rate","amount"],"title":"WelfareFund"},"WelfareFundType":{"type":"string","enum":["TC01","TC02","TC03","TC04","TC05","TC06","TC07","TC08","TC09","TC10","TC11","TC12","TC13","TC14","TC15","TC16","TC17","TC18","TC19","TC20","TC21","TC22"],"title":"WelfareFundType"},"WithholdingTax":{"properties":{"tax_rate":{"type":"number","title":"Tax Rate","description":"Rate of the withholding tax. Normal withholding tax should have a negative tax rate."},"tax_code":{"type":"string","title":"Tax Code","description":"Tax code of the withholding tax. This is the Id of the Tax Code in the accounting software."},"tax_amount":{"type":"number","title":"Tax Amount","description":"Amount of the withholding tax. This is the amount of the withholding tax that will be applied to the invoice. It should be negative for normal withholding tax."}},"type":"object","required":["tax_rate","tax_code","tax_amount"],"title":"WithholdingTax"},"WithholdingTaxPaymentReason":{"type":"string","enum":["A","U","R","Q","H","V","V2","I","J","K","P","S","T","W","X","Y","B","C","D","E","F","G","L","L1","M","M1","M2","IN","O","O1","V1"],"title":"WithholdingTaxPaymentReason"},"WithholdingTaxReason":{"type":"string","enum":["RT01","RT02","RT03","RT04","RT05","RT06"],"title":"WithholdingTaxReason"}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"This access token needs to be included in each of your request to the Chift API."}}},"security":[{"bearerAuth":[]}]}