openapi.json

{"openapi":"3.1.0","info":{"title":"zenskar","version":"1.0.0"},"paths":{"/customers":{"get":{"tags":["Customers"],"summary":"List Customers","description":"List all customers given a `next` or `previous` cursor and a limit. If cursor is not provided you will get the beginning of the search set","operationId":"get_customer_list_customers_get","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","examples":["V2VsbCBhcmV1IGN1cmlvdxM="],"title":"Cursor"},"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of results to return - defaults to 10","examples":[10],"title":"Limit"},"description":"The number of results to return - defaults to 10"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["name=john,custom_data.key=john@zenskar.com"],"title":"Search"}},{"name":"order","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["order=created_at"],"default":"-created_at","title":"Order"}},{"name":"sort_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=id"],"title":"Sort Key"}},{"name":"sort_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=asc"],"title":"Sort Type"}},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["expand=contacts"],"title":"Expand"}},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"}},{"name":"id__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id  Ilike"}},{"name":"id__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id  Like"}},{"name":"id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id  In"}},{"name":"id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Id  Isnull"}},{"name":"external_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"}},{"name":"external_id__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id  Ilike"}},{"name":"external_id__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id  Like"}},{"name":"external_id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id  In"}},{"name":"external_id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"External Id  Isnull"}},{"name":"email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"}},{"name":"email__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email  Ilike"}},{"name":"email__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email  Like"}},{"name":"email__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email  In"}},{"name":"email__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Email  Isnull"}},{"name":"phone_number__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number  Ilike"}},{"name":"phone_number__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number  Like"}},{"name":"phone_number__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Phone Number  Isnull"}},{"name":"communications_enabled","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Communications Enabled"}},{"name":"auto_charge_enabled","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Auto Charge Enabled"}},{"name":"created_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"}},{"name":"created_at__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Neq"}},{"name":"created_at__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gt"}},{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gte"}},{"name":"created_at__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lt"}},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lte"}},{"name":"created_at__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Created At  Isnull"}},{"name":"created_at__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At  In"}},{"name":"customer_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Name"}},{"name":"customer_name__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Name  Ilike"}},{"name":"customer_name__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Name  Like"}},{"name":"customer_name__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Name  In"}},{"name":"customer_name__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Customer Name  Isnull"}},{"name":"business_entity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Business Entity Id"}},{"name":"business_entity_id__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Business Entity Id  Ilike"}},{"name":"business_entity_id__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Business Entity Id  Like"}},{"name":"business_entity_id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Business Entity Id  In"}},{"name":"business_entity_id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Business Entity Id  Isnull"}},{"name":"search_name_external_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Name External Id"}},{"name":"invoice__customer_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  Customer Id"}},{"name":"invoice__customer_id__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  Customer Id  Ilike"}},{"name":"invoice__customer_id__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  Customer Id  Like"}},{"name":"invoice__customer_id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  Customer Id  In"}},{"name":"invoice__customer_id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Invoice  Customer Id  Isnull"}},{"name":"invoice__contract_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  Contract Id"}},{"name":"invoice__contract_id__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  Contract Id  Ilike"}},{"name":"invoice__contract_id__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  Contract Id  Like"}},{"name":"invoice__contract_id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  Contract Id  In"}},{"name":"invoice__contract_id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Invoice  Contract Id  Isnull"}},{"name":"invoice__status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  Status"}},{"name":"invoice__status__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  Status  Ilike"}},{"name":"invoice__status__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  Status  Like"}},{"name":"invoice__status__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  Status  In"}},{"name":"invoice__status__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Invoice  Status  Isnull"}},{"name":"invoice__external_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  External Id"}},{"name":"invoice__external_id__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  External Id  Ilike"}},{"name":"invoice__external_id__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  External Id  Like"}},{"name":"invoice__external_id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  External Id  In"}},{"name":"invoice__external_id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Invoice  External Id  Isnull"}},{"name":"invoice__invoice_total","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Invoice  Invoice Total"}},{"name":"invoice__invoice_total__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Invoice  Invoice Total  Neq"}},{"name":"invoice__invoice_total__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Invoice  Invoice Total  Gt"}},{"name":"invoice__invoice_total__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Invoice  Invoice Total  Gte"}},{"name":"invoice__invoice_total__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Invoice  Invoice Total  Lt"}},{"name":"invoice__invoice_total__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Invoice  Invoice Total  Lte"}},{"name":"invoice__invoice_total__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Invoice  Invoice Total  Isnull"}},{"name":"invoice__invoice_total__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  Invoice Total  In"}},{"name":"invoice__amount_due","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Invoice  Amount Due"}},{"name":"invoice__amount_due__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Invoice  Amount Due  Neq"}},{"name":"invoice__amount_due__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Invoice  Amount Due  Gt"}},{"name":"invoice__amount_due__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Invoice  Amount Due  Gte"}},{"name":"invoice__amount_due__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Invoice  Amount Due  Lt"}},{"name":"invoice__amount_due__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Invoice  Amount Due  Lte"}},{"name":"invoice__amount_due__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Invoice  Amount Due  Isnull"}},{"name":"invoice__amount_due__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  Amount Due  In"}},{"name":"invoice__due_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Due Date"}},{"name":"invoice__due_date__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Due Date  Neq"}},{"name":"invoice__due_date__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Due Date  Gt"}},{"name":"invoice__due_date__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Due Date  Gte"}},{"name":"invoice__due_date__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Due Date  Lt"}},{"name":"invoice__due_date__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Due Date  Lte"}},{"name":"invoice__due_date__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Invoice  Due Date  Isnull"}},{"name":"invoice__due_date__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  Due Date  In"}},{"name":"invoice__created_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Created At"}},{"name":"invoice__created_at__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Created At  Neq"}},{"name":"invoice__created_at__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Created At  Gt"}},{"name":"invoice__created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Created At  Gte"}},{"name":"invoice__created_at__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Created At  Lt"}},{"name":"invoice__created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Created At  Lte"}},{"name":"invoice__created_at__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Invoice  Created At  Isnull"}},{"name":"invoice__created_at__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  Created At  In"}},{"name":"invoice__approved_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Approved At"}},{"name":"invoice__approved_at__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Approved At  Neq"}},{"name":"invoice__approved_at__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Approved At  Gt"}},{"name":"invoice__approved_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Approved At  Gte"}},{"name":"invoice__approved_at__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Approved At  Lt"}},{"name":"invoice__approved_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Approved At  Lte"}},{"name":"invoice__approved_at__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Invoice  Approved At  Isnull"}},{"name":"invoice__approved_at__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  Approved At  In"}},{"name":"invoice__sent_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Sent At"}},{"name":"invoice__sent_at__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Sent At  Neq"}},{"name":"invoice__sent_at__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Sent At  Gt"}},{"name":"invoice__sent_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Sent At  Gte"}},{"name":"invoice__sent_at__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Sent At  Lt"}},{"name":"invoice__sent_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Sent At  Lte"}},{"name":"invoice__sent_at__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Invoice  Sent At  Isnull"}},{"name":"invoice__sent_at__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  Sent At  In"}},{"name":"invoice__paid_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Paid At"}},{"name":"invoice__paid_at__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Paid At  Neq"}},{"name":"invoice__paid_at__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Paid At  Gt"}},{"name":"invoice__paid_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Paid At  Gte"}},{"name":"invoice__paid_at__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Paid At  Lt"}},{"name":"invoice__paid_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Paid At  Lte"}},{"name":"invoice__paid_at__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Invoice  Paid At  Isnull"}},{"name":"invoice__paid_at__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  Paid At  In"}},{"name":"payment_methods__id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Methods  Id"}},{"name":"payment_methods__id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Methods  Id  In"}},{"name":"payment_methods__id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Payment Methods  Id  Isnull"}},{"name":"payment_methods__connector_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Methods  Connector Id"}},{"name":"payment_methods__connector_id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Methods  Connector Id  In"}},{"name":"payment_methods__connector_id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Payment Methods  Connector Id  Isnull"}},{"name":"payment_methods__connector_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Methods  Connector Name"}},{"name":"payment_methods__connector_name__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Methods  Connector Name  Ilike"}},{"name":"payment_methods__connector_name__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Methods  Connector Name  Like"}},{"name":"payment_methods__connector_name__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Methods  Connector Name  In"}},{"name":"payment_methods__connector_name__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Payment Methods  Connector Name  Isnull"}},{"name":"payment_methods__connector_name__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Methods  Connector Name  Neq"}},{"name":"payment_methods__external_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Methods  External Id"}},{"name":"payment_methods__external_id__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Methods  External Id  Ilike"}},{"name":"payment_methods__external_id__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Methods  External Id  Like"}},{"name":"payment_methods__external_id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Methods  External Id  In"}},{"name":"payment_methods__external_id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Payment Methods  External Id  Isnull"}},{"name":"payment_methods__status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Methods  Status"}},{"name":"payment_methods__status__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Methods  Status  Ilike"}},{"name":"payment_methods__status__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Methods  Status  Like"}},{"name":"payment_methods__status__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Methods  Status  In"}},{"name":"payment_methods__status__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Payment Methods  Status  Isnull"}},{"name":"payment_methods__country","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Methods  Country"}},{"name":"payment_methods__country__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Methods  Country  Ilike"}},{"name":"payment_methods__country__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Methods  Country  Like"}},{"name":"payment_methods__country__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Methods  Country  In"}},{"name":"payment_methods__country__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Payment Methods  Country  Isnull"}},{"name":"payment_methods__is_default","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Payment Methods  Is Default"}},{"name":"payment_methods__is_default__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Payment Methods  Is Default  Isnull"}},{"name":"payment_methods__type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Methods  Type"}},{"name":"payment_methods__type__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Methods  Type  Ilike"}},{"name":"payment_methods__type__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Methods  Type  Like"}},{"name":"payment_methods__type__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Methods  Type  In"}},{"name":"payment_methods__type__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Payment Methods  Type  Isnull"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}},{"name":"apiversion","in":"header","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Apiversion"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResults_GetCustomerResponseSchema_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Customers"],"summary":"Create Customer","description":"Creates a new customer in the system. The customer can be created with various attributes.","operationId":"create_customer_customers_post","parameters":[{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomerRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/customers/{customer_id}":{"get":{"tags":["Customers"],"summary":"Get Customer by ID","description":"Get a customer by ID. This endpoint retrieves the details of a specific customer.","operationId":"get_customer_customers__customer_id__get","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Customer Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCustomerResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Customers"],"summary":"Update Customer","description":"Updates an existing customer in the system.","operationId":"patch_customer_customers__customer_id__patch","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","title":"Customer Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCustomerRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Customers"],"summary":"Delete Customer","description":"Deletes a customer by ID.","operationId":"delete_customer_customers__customer_id__delete","parameters":[{"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/DeleteCustomerResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/customers/{customer_id}/connector":{"patch":{"tags":["Customers"],"summary":"Update Customer Connector ID","description":"Updates the connector ID for a customer.","operationId":"patch_customer_connector_id_customers__customer_id__connector_patch","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Customer Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCustomerConnectorRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/customers/{customer_id}/payment_methods":{"post":{"tags":["Customers"],"summary":"Create Customer Payment Method","description":"Creates a new payment method given a `next` or `previous` cursor and a limit. If cursor is not provided you will get the beginning of the search set","operationId":"create_customer_payment_method_customers__customer_id__payment_methods_post","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","title":"Customer Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomerPaymentMethodsResponseSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerPaymentMethodsResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/customers/connector/{customer_id}":{"delete":{"tags":["Customers"],"summary":"Delete Customer Connector","description":"Deletes a specific connector for a customer.","operationId":"delete_connector_customers_connector__customer_id__delete","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","title":"Customer Id"}},{"name":"connector","in":"query","required":true,"schema":{"type":"string","examples":["connector=stripe"],"title":"Connector"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteConnectorForCustomerResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/contacts":{"get":{"tags":["Contacts"],"summary":"List contacts","description":"List contacts given a `next` or `previous` cursor and a limit. If cursor is not provided you will get the beginning of the search set","operationId":"get_contact_list_contacts_get","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","examples":["V2VsbCBhcmV1IGN1cmlvdxM="],"title":"Cursor"},"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of results to return - defaults to 10","examples":[10],"title":"Limit"},"description":"The number of results to return - defaults to 10"},{"name":"sort_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=id"],"title":"Sort Key"}},{"name":"sort_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=asc"],"title":"Sort Type"}},{"name":"first_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"}},{"name":"first_name__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name  Ilike"}},{"name":"first_name__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name  Like"}},{"name":"first_name__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name  In"}},{"name":"last_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name"}},{"name":"last_name__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name  Ilike"}},{"name":"last_name__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name  Like"}},{"name":"last_name__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name  In"}},{"name":"email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"}},{"name":"email__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email  Ilike"}},{"name":"email__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email  Like"}},{"name":"email__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email  In"}},{"name":"email__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Email  Isnull"}},{"name":"send_contract_enabled","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Contract Enabled"}},{"name":"send_invoice_enabled","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Invoice Enabled"}},{"name":"customer","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResults_ContactResponseSchema_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Contacts"],"summary":"Create a contact","description":"Creates a contact for the given organisation. The contact will be associated with the organisation.","operationId":"create_contact_contacts_post","parameters":[{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContactRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/contacts/{contact_id}":{"get":{"tags":["Contacts"],"summary":"Get contact by ID","description":"Fetch a contact by its ID. The contact will be associated with the organisation.","operationId":"get_contact_contacts__contact_id__get","parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contact Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Contacts"],"summary":"Update a contact","description":"Update an existing contact with the provided details. The contact will be associated with the organisation.","operationId":"patch_contact_contacts__contact_id__patch","parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contact Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContactRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Contacts"],"summary":"Delete a contact","description":"Delete a contact by its ID. The contact will be associated with the organisation.","operationId":"delete_contact_contacts__contact_id__delete","parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contact Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteContactResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/invoices/invoice_id/{invoice_id}":{"get":{"tags":["Invoices"],"summary":"Get Invoice by Invoice ID","description":"Get invoice details by its invoice ID. This endpoint is accessible to customers.","operationId":"get_invoice_by_invoice_id_invoices_invoice_id__invoice_id__get","parameters":[{"name":"invoice_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Invoice Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/invoices/pay/{payload}":{"get":{"tags":["Invoices"],"summary":"Pay Invoice","operationId":"pay_invoice_invoices_pay__payload__get","parameters":[{"name":"payload","in":"path","required":true,"schema":{"type":"string","title":"Payload"}}],"responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/invoices/{invoice_id}/line_items":{"get":{"tags":["Invoices"],"summary":"Get Invoice Line Items","description":"API to get details about the invoice line items, features and pricing models.\n        This endpoint is accessible to customers to view their invoice details.","operationId":"get_invoice_lines_invoices__invoice_id__line_items_get","parameters":[{"name":"invoice_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Invoice Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"examples":{"Multiple Pricing Models":{"summary":"Multiple pricing models with features at both line level and invoice level","value":{"lines":[{"name":"P1","quantity":{"value":7203,"unit":"unit","display":"7203 units"},"subtotal":{"value":710.3,"unit":"USD","display":"$710.30"},"pricing_model":"per-unit-pricing","features":[{"type":"free-units","name":"Free Units","free_quantity":{"value":100,"unit":"unit","display":"100 units"},"remaining_quantity":{"value":7103,"unit":"unit","display":"7103 units"},"currency":"USD","quantity_unit":"unit","free_units_granted":{"value":100,"unit":"unit","display":"100 units"},"free_units_remaining":{"value":0,"unit":"unit","display":"0 units"},"price":{"value":0,"unit":"USD/unit","display":"$0.00 per unit"},"quantity":{"value":100,"unit":"unit","display":"100 units"},"total":{"value":0,"unit":"USD","display":"$0.00"},"display":[{"name":"Free Units","price":"$0.00 per unit","quantity":"100 units / 100 units","total":"$0.00"}]},{"type":"per-unit-pricing","name":"Per Unit Pricing","price":{"value":0.1,"unit":"USD/unit","display":"$0.10 per unit"},"quantity":{"value":7103,"unit":"unit","display":"7103 units"},"total":{"value":710.3,"unit":"USD","display":"$710.30"},"currency":"USD","quantity_unit":"unit","display":[{"name":"Per Unit Pricing","price":"$0.10 per unit","quantity":"7103 units","total":"$710.30"}]}]},{"name":"Product Name Here","quantity":{"value":7203,"unit":"unit","display":"7203 units"},"subtotal":{"value":7203,"unit":"USD","display":"$7,203.00"},"pricing_model":"volume-pricing","features":[{"name":"Volume Pricing","type":"volume-pricing","price":{"value":1,"unit":"USD/unit","display":"$1.00 per unit"},"quantity":{"value":7203,"unit":"unit","display":"7203 units"},"total":{"value":7203,"unit":"USD","display":"$7,203.00"},"tiers":[2,1.5,1],"prices":[2,1.5,1],"currency":"USD","quantity_unit":"unit","display":[{"name":"Volume Pricing","price":"$1.00 per unit","quantity":"7203 units","total":"$7,203.00"}]},{"type":"discount","name":"Discount","total":{"value":-216.09,"unit":"USD","display":"-$216.09"},"discount_given":{"value":216.09,"unit":"USD","display":"$216.09"},"currency":"USD","discount_type":"percent","discount_percent":3,"display":[{"name":"Discount","price":"3% off","quantity":"","total":"-$216.09"}]}]},{"name":"P3","quantity":{"value":7203,"unit":"unit","display":"7203 units"},"subtotal":{"value":7503,"unit":"USD","display":"$7,503.00"},"pricing_model":"tiered-pricing","features":[{"name":"Tiered Pricing","type":"tiered-pricing","quantity":{"value":7203,"unit":"unit","display":"7203 units"},"total":{"value":7503,"unit":"USD","display":"$7,503.00"},"tiers":[0,200,400],"prices":[2,1.5,1],"currency":"USD","quantity_unit":"unit","tier_breakdown":[{"tier":1,"quantity":200,"price":2,"amount":400},{"tier":2,"quantity":200,"price":1.5,"amount":300},{"tier":3,"quantity":6803,"price":1,"amount":6803}],"display":[{"name":"Tiered Pricing Tier 1","price":"$2.00 per unit","quantity":"200 units","total":"$400.00"},{"name":"Tiered Pricing Tier 2","price":"$1.50 per unit","quantity":"200 units","total":"$300.00"},{"name":"Tiered Pricing Tier 3","price":"$1.00 per unit","quantity":"6803 units","total":"$6,803.00"}]},{"type":"simple-tax","name":"Sales Tax","tax_percent":2.7,"tax_amount":{"value":202.58,"unit":"USD","display":"$202.58"},"currency":"USD","amount_after_tax":{"value":7705.581,"unit":"USD","display":"$7,705.58"},"amount_before_tax":{"value":7503,"unit":"USD","display":"$7,503.00"},"total":{"value":202.58,"unit":"USD","display":"$202.58"},"display":[{"name":"Sales Tax","price":"2.7% tax","quantity":"","total":"$202.58"}]}]},{"name":"P4","quantity":{"value":7203,"unit":"unit","display":"7203 units"},"subtotal":{"value":165.67,"unit":"USD","display":"$165.67"},"pricing_model":"percent-pricing","features":[{"name":"Percent Pricing","type":"percent-pricing","price":{"value":2.3,"unit":"%","display":"2.30%"},"currency":"USD","quantity_unit":"unit","quantity":{"value":7203,"unit":"unit","display":"7203 units"},"total":{"value":165.67,"unit":"USD","display":"$165.67"},"display":[{"name":"Percent Pricing","price":"2.3%","quantity":"7203 units","total":"$165.67"}]},{"type":"minimum-amount-overages","name":"Minimum Amount Balance","balance":{"value":434.33,"unit":"USD","display":"$434.33"},"currency":"USD","minimum_amount":{"value":600,"unit":"USD","display":"$600.00"},"total":{"value":434.33,"unit":"USD","display":"$434.33"},"input_amount":{"value":165.67,"unit":"USD","display":"$165.67"},"display":[{"name":"Minimum Amount Balance","price":"600 Cap","quantity":"","amount":"$434.33"}]}]},{"name":"P5","quantity":{"unit":"unit","display":""},"subtotal":{"value":1000,"unit":"USD","display":"$1,000.00"},"pricing_model":"subscription-with-proration","features":[{"name":"Subscription","type":"subscription-pricing","price":{"value":1000,"unit":"USD","display":"$1,000.00"},"currency":"USD","subscription_amount":{"value":1000,"unit":"USD","display":"$1,000.00"},"total":{"value":1000,"unit":"USD","display":"$1,000.00"},"billed_days":31,"display":[{"name":"Subscription","price":"$1,000.00","quantity":"","total":"$1,000.00"}]}]},{"name":"P6","quantity":{"value":7203,"unit":"unit","display":"7203 units"},"subtotal":{"value":142,"unit":"USD","display":"$142.00"},"pricing_model":"package-pricing","features":[{"type":"free-units","name":"Free Units","free_quantity":{"value":200,"unit":"unit","display":"200 units"},"remaining_quantity":{"value":7003,"unit":"unit","display":"7003 units"},"currency":"USD","quantity_unit":"unit","free_units_granted":{"value":200,"unit":"unit","display":"200 units"},"free_units_remaining":{"value":0,"unit":"unit","display":"0 units"},"price":{"value":0,"unit":"USD/unit","display":"$0.00 per unit"},"quantity":{"value":200,"unit":"unit","display":"200 units"},"total":{"value":0,"unit":"USD","display":"$0.00"},"display":[{"name":"Free Units","price":"$0.00 per unit","quantity":"200 units / 200 units","total":"$0.00"}]},{"name":"Package Pricing","currency":"USD","quantity_unit":"unit","type":"package-pricing","price":{"value":2,"unit":"USD/unit","display":"$2.00 per 100 units"},"package_size":{"value":100,"unit":"unit","display":"100 units"},"quantity":{"value":7003,"unit":"unit","display":"7003 units"},"total":{"value":142,"unit":"USD","display":"$142.00"},"display":[{"name":"Package Pricing","price":"$2.00 per 100 units","quantity":"7003 units","total":"$142.00"}]}]}],"total":{"value":20520,"unit":"USD","display":"$20,520.00"},"features":[{"type":"discount","name":"Discount","total":{"value":-514.34,"unit":"USD","display":"-$514.34"},"discount_given":{"value":514.34,"unit":"USD","display":"$514.34"},"currency":"USD","discount_type":"percent","discount_percent":3,"display":[{"name":"Discount","price":"3% off","quantity":"","total":"-$514.34"}]},{"type":"minimum-amount-overages","name":"Minimum Amount Balance","balance":{"value":3369.55,"unit":"USD","display":"$3,369.55"},"currency":"USD","minimum_amount":{"value":20000,"unit":"USD","display":"$20,000.00"},"total":{"value":3369.55,"unit":"USD","display":"$3,369.55"},"input_amount":{"value":16630.45,"unit":"USD","display":"$16,630.45"},"display":[{"name":"Minimum Amount Balance","price":"20000 Cap","quantity":"","amount":"$3,369.55"}]},{"type":"simple-tax","name":"Sales Tax","tax_percent":2.6,"tax_amount":{"value":520,"unit":"USD","display":"$520.00"},"currency":"USD","amount_after_tax":{"value":20520,"unit":"USD","display":"$20,520.00"},"amount_before_tax":{"value":20000,"unit":"USD","display":"$20,000.00"},"total":{"value":520,"unit":"USD","display":"$520.00"},"display":[{"name":"Sales Tax","price":"2.6% tax","quantity":"","total":"$520.00"}]}]}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/datasources":{"get":{"tags":["Data Sources"],"summary":"List datasource from a given cursor and limit","description":"List datasource given a `next` or `previous` cursor and a limit. If cursor is not provided you will get the beginning of the search set","operationId":"get_datasources_datasources_get","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","examples":["V2VsbCBhcmV1IGN1cmlvdxM="],"title":"Cursor"},"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of results to return - defaults to 10","examples":[10],"title":"Limit"},"description":"The number of results to return - defaults to 10"},{"name":"order","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["order=created_at"],"default":"-created_at","title":"Order"}},{"name":"sort_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=id"],"title":"Sort Key"}},{"name":"sort_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=asc"],"title":"Sort Type"}},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"}},{"name":"id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id  In"}},{"name":"id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Id  Isnull"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"name__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name  Ilike"}},{"name":"name__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name  Like"}},{"name":"name__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name  In"}},{"name":"name__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Name  Isnull"}},{"name":"connector_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Connector Type"}},{"name":"connector_type__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Connector Type  Ilike"}},{"name":"connector_type__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Connector Type  Like"}},{"name":"connector_type__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Connector Type  In"}},{"name":"connector_type__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Connector Type  Isnull"}},{"name":"destination","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Destination"}},{"name":"destination__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Destination  Ilike"}},{"name":"destination__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Destination  Like"}},{"name":"destination__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Destination  In"}},{"name":"destination__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Destination  Isnull"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"status__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status  In"}},{"name":"status__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Status  Isnull"}},{"name":"remote_conn","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Remote Conn"}},{"name":"created_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"}},{"name":"created_at__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Neq"}},{"name":"created_at__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gt"}},{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gte"}},{"name":"created_at__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lt"}},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lte"}},{"name":"created_at__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Created At  Isnull"}},{"name":"created_at__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At  In"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}},{"name":"apiversion","in":"header","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":20230501,"title":"Apiversion"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResults_DataSourceSchema_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Data Sources"],"summary":"Create a data source","description":"Creates a data source for the given organisation. The data source will be associated with the organisation.","operationId":"create_datasource_datasources_post","parameters":[{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}},{"name":"apiversion","in":"header","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Apiversion"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDataSourceRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/datasources/{datasource_id}":{"get":{"tags":["Data Sources"],"summary":"Get a data source by ID","description":"Fetch a data source by its ID. The data source will be associated with the organisation.","operationId":"get_datasource_by_id_datasources__datasource_id__get","parameters":[{"name":"datasource_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Datasource Id"}},{"name":"with_refreshed_catalog","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"With Refreshed Catalog"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataSourceResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Data Sources"],"summary":"Update a data source","description":"Update an existing data source with the provided details. The data source will be associated with the organisation.","operationId":"update_connection_by_id_datasources__datasource_id__patch","parameters":[{"name":"datasource_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Datasource Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}},{"name":"apiversion","in":"header","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Apiversion"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/aggregates":{"get":{"tags":["Billable Metrics"],"summary":"List aggregates","description":"List aggregates with optional filtering, sorting, and pagination.","operationId":"get_aggregates_aggregates_get","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","examples":["V2VsbCBhcmV1IGN1cmlvdxM="],"title":"Cursor"},"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of results to return - defaults to 10","examples":[10],"title":"Limit"},"description":"The number of results to return - defaults to 10"},{"name":"order","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["order=created_at"],"default":"-created_at","title":"Order"}},{"name":"sort_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=id"],"default":"created_at","title":"Sort Key"}},{"name":"sort_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=asc"],"default":"DESC","title":"Sort Type"}},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"}},{"name":"id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id  In"}},{"name":"id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Id  Isnull"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"name__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name  Ilike"}},{"name":"name__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name  Like"}},{"name":"name__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name  In"}},{"name":"name__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Name  Isnull"}},{"name":"datasource","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Datasource"}},{"name":"datasource__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Datasource  In"}},{"name":"datasource__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Datasource  Isnull"}},{"name":"created_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"}},{"name":"created_at__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Neq"}},{"name":"created_at__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gt"}},{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gte"}},{"name":"created_at__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lt"}},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lte"}},{"name":"created_at__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Created At  Isnull"}},{"name":"created_at__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At  In"}},{"name":"parent_aggregate_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Aggregate Id"}},{"name":"parent_aggregate_id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Aggregate Id  In"}},{"name":"parent_aggregate_id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Parent Aggregate Id  Isnull"}},{"name":"aggregate_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/AggregateType"},{"type":"null"}],"title":"Aggregate Type"}},{"name":"aggregate_type__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Aggregate Type  In"}},{"name":"aggregate_type__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Aggregate Type  Isnull"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}},{"name":"apiversion","in":"header","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":20230501,"title":"Apiversion"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResults_GetAggregateResponseSchema_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Billable Metrics"],"summary":"Create aggregate","description":"Create a new aggregate with the provided details.","operationId":"create_aggregate_aggregates_post","parameters":[{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}},{"name":"apiversion","in":"header","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Apiversion"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAggregateRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggregateResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/aggregates/estimates":{"get":{"tags":["Billable Metrics"],"summary":"Get aggregate estimates for a period","description":"Get estimates for a specific aggregate and customer within a date range.","operationId":"get_aggregate_estimate_for_one_period_aggregates_estimates_get","parameters":[{"name":"aggregate_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"Aggregate Id"}},{"name":"customer_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"Customer Id"}},{"name":"start_date","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Start Date"}},{"name":"end_date","in":"query","required":true,"schema":{"type":"string","format":"date","title":"End Date"}},{"name":"get_single","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Get Single"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AggregateEstimateResponseSchema"},{"type":"array","items":{"$ref":"#/components/schemas/AggregateEstimateResponseSchema"}}],"title":"Response Get Aggregate Estimate For One Period Aggregates Estimates Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/aggregates/{aggregate_id}":{"get":{"tags":["Billable Metrics"],"summary":"Get aggregate by ID","description":"Fetch a specific aggregate by its ID.","operationId":"get_aggregate_by_id_aggregates__aggregate_id__get","parameters":[{"name":"aggregate_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Aggregate Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Billable Metrics"],"summary":"Update aggregate","description":"Update an existing aggregate by its ID.","operationId":"patch_aggregate_aggregates__aggregate_id__patch","parameters":[{"name":"aggregate_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Aggregate Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}},{"name":"apiversion","in":"header","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Apiversion"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAggregateRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Billable Metrics"],"summary":"Delete aggregate","description":"Delete an existing aggregate by its ID.","operationId":"delete_aggregate_by_id_aggregates__aggregate_id__delete","parameters":[{"name":"aggregate_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Aggregate Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/credit_notes":{"get":{"tags":["Credit Notes"],"summary":"List credit notes","description":"List credit notes given a `next` or `previous` cursor and a limit. If cursor is not provided you will get the beginning of the search set","operationId":"get_credit_note_list_credit_notes_get","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","examples":["V2VsbCBhcmV1IGN1cmlvdxM="],"title":"Cursor"},"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of results to return - defaults to 10","examples":[10],"title":"Limit"},"description":"The number of results to return - defaults to 10"},{"name":"order","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["-created_at"],"default":"-created_at","title":"Order"}},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["currency=inr,status=issued"],"title":"Search"}},{"name":"sort_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=id"],"title":"Sort Key"}},{"name":"sort_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=asc"],"title":"Sort Type"}},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"}},{"name":"id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id  In"}},{"name":"id__not_in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id  Not In"}},{"name":"customer_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"}},{"name":"customer_id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id  In"}},{"name":"customer_id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Customer Id  Isnull"}},{"name":"invoice_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Id"}},{"name":"invoice_id__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Id  Ilike"}},{"name":"invoice_id__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Id  Like"}},{"name":"invoice_id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Id  In"}},{"name":"invoice_id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Invoice Id  Isnull"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"status__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status  Ilike"}},{"name":"status__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status  Like"}},{"name":"status__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status  In"}},{"name":"status__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Status  Isnull"}},{"name":"amount","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount"}},{"name":"amount__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount  Neq"}},{"name":"amount__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount  Gt"}},{"name":"amount__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount  Gte"}},{"name":"amount__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount  Lt"}},{"name":"amount__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount  Lte"}},{"name":"amount__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Amount  Isnull"}},{"name":"amount__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Amount  In"}},{"name":"created_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"}},{"name":"created_at__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Neq"}},{"name":"created_at__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gt"}},{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gte"}},{"name":"created_at__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lt"}},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lte"}},{"name":"created_at__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Created At  Isnull"}},{"name":"created_at__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At  In"}},{"name":"credit_note_number__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credit Note Number  Ilike"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}},{"name":"apiversion","in":"header","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Apiversion"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResults_CreditNoteResponseSchema_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Credit Notes"],"summary":"Create a credit note","description":"Creates a credit note for the given organisation. The credit note will be associated with the organisation.","operationId":"create_credit_note_credit_notes_post","parameters":[{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreditNoteRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNoteResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/credit_notes/{credit_note_id}":{"get":{"tags":["Credit Notes"],"summary":"Get credit note by ID","description":"Fetch a credit note by its ID. The credit note will be associated with the organisation.","operationId":"get_credit_note_by_id_credit_notes__credit_note_id__get","parameters":[{"name":"credit_note_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Credit Note Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNoteResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Credit Notes"],"summary":"Update a credit note","description":"Update an existing credit note with the provided details. The credit note will be associated with the organisation.","operationId":"update_credit_note_by_id_credit_notes__credit_note_id__patch","parameters":[{"name":"credit_note_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Credit Note Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCreditNoteRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNoteResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/credit_notes/line_items/{credit_note_id}":{"get":{"tags":["Credit Notes"],"summary":"Get line items by credit note ID","description":"Fetch line items associated with a specific credit note ID.","operationId":"get_line_items_by_credit_note_id_credit_notes_line_items__credit_note_id__get","parameters":[{"name":"credit_note_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Credit Note Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/rawmetrics":{"get":{"tags":["Usage Events"],"summary":"List Usage Events","description":"List Usage Events given a `next` or `previous` cursor and a limit. If cursor is not provided you will get the beginning of the search set","operationId":"get_raw_metrics_list_rawmetrics_get","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","examples":["V2VsbCBhcmV1IGN1cmlvdxM="],"title":"Cursor"},"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of results to return - defaults to 10","examples":[10],"title":"Limit"},"description":"The number of results to return - defaults to 10"},{"name":"order","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["order=created_at"],"default":"-created_at","title":"Order"}},{"name":"sort_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=id"],"default":"created_at","title":"Sort Key"}},{"name":"sort_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=asc"],"default":"DESC","title":"Sort Type"}},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"}},{"name":"id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id  In"}},{"name":"id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Id  Isnull"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"name__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name  Ilike"}},{"name":"name__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name  Like"}},{"name":"name__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name  In"}},{"name":"name__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Name  Isnull"}},{"name":"api_slug","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Slug"}},{"name":"api_slug__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Slug  Ilike"}},{"name":"api_slug__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Slug  Like"}},{"name":"api_slug__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Slug  In"}},{"name":"api_slug__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Api Slug  Isnull"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}},{"name":"apiversion","in":"header","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":20230501,"title":"Apiversion"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResults_GetRawMetricResponseSchema_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Usage Events"],"summary":"Create Usage Event","description":"Create a new usage event","operationId":"create_raw_metric_rawmetrics_post","parameters":[{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}},{"name":"apiversion","in":"header","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Apiversion"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRawMetricRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RawMetricResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/rawmetrics/{raw_metric_id}":{"get":{"tags":["Usage Events"],"summary":"Get Usage Event by ID","description":"Get usage event details by its unique identifier","operationId":"get_raw_metric_by_id_rawmetrics__raw_metric_id__get","parameters":[{"name":"raw_metric_id","in":"path","required":true,"schema":{"type":"string","title":"Raw Metric Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RawMetricResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Usage Events"],"summary":"Update Usage Event","description":"Update an existing usage event","operationId":"patch_raw_metric_rawmetrics__raw_metric_id__patch","parameters":[{"name":"raw_metric_id","in":"path","required":true,"schema":{"type":"string","description":"The ID of the usage event to update","title":"Raw Metric Id"},"description":"The ID of the usage event to update"},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}},{"name":"apiversion","in":"header","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Apiversion"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRawMetricRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RawMetricResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/rawmetrics/slug/{raw_metric_slug}":{"get":{"tags":["Usage Events"],"summary":"Get Usage Event by Slug","description":"Get usage event details by its slug","operationId":"get_raw_metric_by_slug_rawmetrics_slug__raw_metric_slug__get","parameters":[{"name":"raw_metric_slug","in":"path","required":true,"schema":{"type":"string","title":"Raw Metric Slug"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/payments/invoice/{invoice_id}":{"get":{"tags":["Payments"],"summary":"Get Invoice Payments","description":"Get all payments for a specific invoice","operationId":"get_invoice_payments_payments_invoice__invoice_id__get","parameters":[{"name":"invoice_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Invoice Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/payments/invoice/{invoice_id}/without_refunds":{"get":{"tags":["Payments"],"summary":"Get Invoice Payments Without Refunds","description":"Get all payments for a specific invoice excluding refunds","operationId":"get_payments_for_invoice_without_refunds_payments_invoice__invoice_id__without_refunds_get","parameters":[{"name":"invoice_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Invoice Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/payments/{payment_id}":{"get":{"tags":["Payments"],"summary":"Get Payment by ID","description":"Get payment details by its unique identifier","operationId":"get_payment_by_id_payments__payment_id__get","parameters":[{"name":"payment_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Payment Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Payments"],"summary":"Update Payment","description":"Update an existing payment","operationId":"update_payment_payments__payment_id__patch","parameters":[{"name":"payment_id","in":"path","required":true,"schema":{"type":"string","title":"Payment Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePaymentRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Payments"],"summary":"Delete Manual Payment","description":"Delete an existing manual payment","operationId":"delete_manual_payment_payments__payment_id__delete","parameters":[{"name":"payment_id","in":"path","required":true,"schema":{"type":"string","title":"Payment Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/payments":{"get":{"tags":["Payments"],"summary":"List Payments","description":"Get a paginated list of all payments","operationId":"get_payments_payments_get","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","examples":["V2VsbCBhcmV1IGN1cmlvdxM="],"title":"Cursor"},"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of results to return - defaults to 10","examples":[10],"title":"Limit"},"description":"The number of results to return - defaults to 10"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"sort_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=id"],"title":"Sort Key"}},{"name":"sort_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=asc"],"title":"Sort Type"}},{"name":"order","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["order=created_at"],"default":"-created_at","title":"Order"}},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"}},{"name":"id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id  In"}},{"name":"id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Id  Isnull"}},{"name":"customer_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"}},{"name":"customer_id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id  In"}},{"name":"customer_id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Customer Id  Isnull"}},{"name":"connector_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Connector Id"}},{"name":"connector_id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Connector Id  In"}},{"name":"connector_id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Connector Id  Isnull"}},{"name":"external_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"}},{"name":"external_id__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id  Ilike"}},{"name":"external_id__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id  Like"}},{"name":"external_id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id  In"}},{"name":"external_id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"External Id  Isnull"}},{"name":"payment_method","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method"}},{"name":"payment_method__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method  In"}},{"name":"payment_method__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Payment Method  Isnull"}},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"}},{"name":"type__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type  In"}},{"name":"type__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Type  Isnull"}},{"name":"amount","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount"}},{"name":"amount__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount  Neq"}},{"name":"amount__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount  Gt"}},{"name":"amount__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount  Gte"}},{"name":"amount__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount  Lt"}},{"name":"amount__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount  Lte"}},{"name":"amount__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Amount  Isnull"}},{"name":"amount__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Amount  In"}},{"name":"amount_refunded","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount Refunded"}},{"name":"amount_refunded__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount Refunded  Neq"}},{"name":"amount_refunded__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount Refunded  Gt"}},{"name":"amount_refunded__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount Refunded  Gte"}},{"name":"amount_refunded__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount Refunded  Lt"}},{"name":"amount_refunded__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount Refunded  Lte"}},{"name":"amount_refunded__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Amount Refunded  Isnull"}},{"name":"amount_refunded__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Amount Refunded  In"}},{"name":"currency_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency Code"}},{"name":"currency_code__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency Code  Ilike"}},{"name":"currency_code__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency Code  Like"}},{"name":"currency_code__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency Code  In"}},{"name":"currency_code__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Currency Code  Isnull"}},{"name":"receipt_number","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Number"}},{"name":"receipt_number__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Number  Ilike"}},{"name":"receipt_number__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Number  Like"}},{"name":"receipt_number__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Number  In"}},{"name":"receipt_number__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Receipt Number  Isnull"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"status__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status  In"}},{"name":"status__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Status  Isnull"}},{"name":"autocharge","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Autocharge"}},{"name":"autocharge__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Autocharge  Isnull"}},{"name":"parent_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Id"}},{"name":"parent_id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Id  In"}},{"name":"parent_id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Parent Id  Isnull"}},{"name":"timestamp","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Timestamp"}},{"name":"timestamp__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Timestamp  Neq"}},{"name":"timestamp__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Timestamp  Gt"}},{"name":"timestamp__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Timestamp  Gte"}},{"name":"timestamp__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Timestamp  Lt"}},{"name":"timestamp__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Timestamp  Lte"}},{"name":"timestamp__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Timestamp  Isnull"}},{"name":"timestamp__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timestamp  In"}},{"name":"created_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"}},{"name":"created_at__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Neq"}},{"name":"created_at__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gt"}},{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gte"}},{"name":"created_at__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lt"}},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lte"}},{"name":"created_at__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Created At  Isnull"}},{"name":"created_at__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At  In"}},{"name":"invoice__id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  Id"}},{"name":"invoice__id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  Id  In"}},{"name":"invoice__id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Invoice  Id  Isnull"}},{"name":"invoice__bill_for_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Bill For Date"}},{"name":"invoice__bill_for_date__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Bill For Date  Neq"}},{"name":"invoice__bill_for_date__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Bill For Date  Gt"}},{"name":"invoice__bill_for_date__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Bill For Date  Gte"}},{"name":"invoice__bill_for_date__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Bill For Date  Lt"}},{"name":"invoice__bill_for_date__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Bill For Date  Lte"}},{"name":"invoice__bill_for_date__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Invoice  Bill For Date  Isnull"}},{"name":"invoice__bill_for_date__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  Bill For Date  In"}},{"name":"invoice__approved_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Approved At"}},{"name":"invoice__approved_at__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Approved At  Neq"}},{"name":"invoice__approved_at__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Approved At  Gt"}},{"name":"invoice__approved_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Approved At  Gte"}},{"name":"invoice__approved_at__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Approved At  Lt"}},{"name":"invoice__approved_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invoice  Approved At  Lte"}},{"name":"invoice__approved_at__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Invoice  Approved At  Isnull"}},{"name":"invoice__approved_at__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice  Approved At  In"}},{"name":"customer__business_entity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer  Business Entity Id"}},{"name":"customer__business_entity_id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer  Business Entity Id  In"}},{"name":"customer__business_entity_id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Customer  Business Entity Id  Isnull"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}},{"name":"apiversion","in":"header","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Apiversion"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResults_PaymentResponseSchema_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Payments"],"summary":"Create Payment","description":"Create a new payment","operationId":"create_payment_payments_post","parameters":[{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePaymentRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/payments/invoice/{invoice_id}/charge":{"post":{"tags":["Payments"],"summary":"Create Invoice Charge","description":"Create a new charge for a specific invoice","operationId":"create_invoice_charge_payments_invoice__invoice_id__charge_post","parameters":[{"name":"invoice_id","in":"path","required":true,"schema":{"type":"string","title":"Invoice Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInvoiceChargeRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/payments/manual_payment/{payment_id}":{"patch":{"tags":["Payments"],"summary":"Edit Manual Payment","description":"Edit an existing manual payment","operationId":"edit_manual_payment_payments_manual_payment__payment_id__patch","parameters":[{"name":"payment_id","in":"path","required":true,"schema":{"type":"string","title":"Payment Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateManualPaymentRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/payments/{payment_id}/refund":{"post":{"tags":["Payments"],"summary":"Refund Payment","description":"Create a refund for an existing payment","operationId":"refund_payment_payments__payment_id__refund_post","parameters":[{"name":"payment_id","in":"path","required":true,"schema":{"type":"string","title":"Payment Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRefundRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/accounting/get_accounts":{"post":{"tags":["Accounting"],"summary":"Get accounts for an organisation","description":"Get accounts for an organisation with optional sorting","operationId":"get_accounts_accounting_get_accounts_post","parameters":[{"name":"sort_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=id"],"title":"Sort Key"}},{"name":"sort_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=asc"],"title":"Sort Type"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAccountsRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/accounting/get_transactions":{"post":{"tags":["Accounting"],"summary":"Get transactions with entries","description":"Get transactions with entries for an organisation with optional sorting","operationId":"get_transactions_accounting_get_transactions_post","parameters":[{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTransactionsRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/accounting/get_account_balances":{"post":{"tags":["Accounting"],"summary":"Get account balances","description":"Get account balances for an organisation with optional sorting","operationId":"get_balance_sheet_accounting_get_account_balances_post","parameters":[{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBalanceSheetRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/jobs":{"get":{"tags":["Jobs"],"summary":"List Jobs","description":"List jobs given a `next` or `previous` cursor and a limit. If cursor is not provided you will get the beginning of the search set","operationId":"get_job_list_jobs_get","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","examples":["V2VsbCBhcmV1IGN1cmlvdxM="],"title":"Cursor"},"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of results to return - defaults to 10","examples":[10],"title":"Limit"},"description":"The number of results to return - defaults to 10"},{"name":"sort_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=id"],"title":"Sort Key"}},{"name":"sort_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=asc"],"title":"Sort Type"}},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"order","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["order=created_at"],"default":"-created_at","title":"Order"}},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"}},{"name":"id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id  In"}},{"name":"id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Id  Isnull"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"name__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name  Ilike"}},{"name":"name__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name  Like"}},{"name":"name__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name  In"}},{"name":"name__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Name  Isnull"}},{"name":"description","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},{"name":"description__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description  Ilike"}},{"name":"description__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description  Like"}},{"name":"description__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description  In"}},{"name":"description__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Description  Isnull"}},{"name":"resource","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resource"}},{"name":"resource__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resource  In"}},{"name":"resource__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Resource  Isnull"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"status__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status  In"}},{"name":"status__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Status  Isnull"}},{"name":"job_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/JobType"},{"type":"null"}],"title":"Job Type"}},{"name":"job_type__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Type  In"}},{"name":"job_type__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Job Type  Isnull"}},{"name":"operation_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Operation Type"}},{"name":"operation_type__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Operation Type  In"}},{"name":"operation_type__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Operation Type  Isnull"}},{"name":"created_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"}},{"name":"created_at__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Neq"}},{"name":"created_at__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gt"}},{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gte"}},{"name":"created_at__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lt"}},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lte"}},{"name":"created_at__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Created At  Isnull"}},{"name":"created_at__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At  In"}},{"name":"is_default","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Default"}},{"name":"file_path","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Path"}},{"name":"file_path__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Path  Ilike"}},{"name":"file_path__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Path  Like"}},{"name":"file_path__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Path  In"}},{"name":"file_path__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"File Path  Isnull"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}},{"name":"apiversion","in":"header","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Apiversion"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResults_JobResponseSchema_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/jobs/{job_id}":{"get":{"tags":["Jobs"],"summary":"Get Job by ID","description":"Retrieve a specific job by its ID","operationId":"get_job_by_id_jobs__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/jobs/joboutcomes/logs":{"get":{"tags":["Jobs"],"summary":"Get Job Outcomes by Filters","description":"Retrieve job outcomes based on various filters such as job type, status, and date range. This endpoint supports pagination and searching.","operationId":"get_job_outcomes_by_filters_jobs_joboutcomes_logs_get","parameters":[{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","examples":["V2VsbCBhcmV1IGN1cmlvdxM="],"title":"Cursor"},"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of results to return - defaults to 10","examples":[10],"title":"Limit"},"description":"The number of results to return - defaults to 10"},{"name":"order","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["order=created_at"],"default":"-created_at","title":"Order"}},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"}},{"name":"id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id  In"}},{"name":"id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Id  Isnull"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"status__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status  In"}},{"name":"status__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Status  Isnull"}},{"name":"created_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"}},{"name":"created_at__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Neq"}},{"name":"created_at__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gt"}},{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gte"}},{"name":"created_at__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lt"}},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lte"}},{"name":"created_at__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Created At  Isnull"}},{"name":"created_at__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At  In"}},{"name":"jobs__id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Id"}},{"name":"jobs__id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Id  In"}},{"name":"jobs__id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Jobs  Id  Isnull"}},{"name":"jobs__name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Name"}},{"name":"jobs__name__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Name  Ilike"}},{"name":"jobs__name__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Name  Like"}},{"name":"jobs__name__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Name  In"}},{"name":"jobs__name__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Jobs  Name  Isnull"}},{"name":"jobs__description","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Description"}},{"name":"jobs__description__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Description  Ilike"}},{"name":"jobs__description__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Description  Like"}},{"name":"jobs__description__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Description  In"}},{"name":"jobs__description__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Jobs  Description  Isnull"}},{"name":"jobs__resource","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Resource"}},{"name":"jobs__resource__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Resource  In"}},{"name":"jobs__resource__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Jobs  Resource  Isnull"}},{"name":"jobs__status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Status"}},{"name":"jobs__status__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Status  In"}},{"name":"jobs__status__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Jobs  Status  Isnull"}},{"name":"jobs__job_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/JobType"},{"type":"null"}],"title":"Jobs  Job Type"}},{"name":"jobs__job_type__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Job Type  In"}},{"name":"jobs__job_type__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Jobs  Job Type  Isnull"}},{"name":"jobs__operation_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Operation Type"}},{"name":"jobs__operation_type__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Operation Type  In"}},{"name":"jobs__operation_type__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Jobs  Operation Type  Isnull"}},{"name":"jobs__created_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Jobs  Created At"}},{"name":"jobs__created_at__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Jobs  Created At  Neq"}},{"name":"jobs__created_at__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Jobs  Created At  Gt"}},{"name":"jobs__created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Jobs  Created At  Gte"}},{"name":"jobs__created_at__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Jobs  Created At  Lt"}},{"name":"jobs__created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Jobs  Created At  Lte"}},{"name":"jobs__created_at__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Jobs  Created At  Isnull"}},{"name":"jobs__created_at__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Created At  In"}},{"name":"jobs__is_default","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Jobs  Is Default"}},{"name":"jobs__file_path","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  File Path"}},{"name":"jobs__file_path__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  File Path  Ilike"}},{"name":"jobs__file_path__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  File Path  Like"}},{"name":"jobs__file_path__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  File Path  In"}},{"name":"jobs__file_path__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Jobs  File Path  Isnull"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/jobs/{job_id}/logs":{"get":{"tags":["Jobs"],"summary":"Get Job Outcomes by ID","description":"Retrieve job outcomes for a specific job by its ID. This endpoint allows you to fetch the outcomes of a job, including logs and status.","operationId":"get_job_outcomes_by_id_jobs__job_id__logs_get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","examples":["V2VsbCBhcmV1IGN1cmlvdxM="],"title":"Cursor"},"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of results to return - defaults to 10","examples":[10],"title":"Limit"},"description":"The number of results to return - defaults to 10"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"}},{"name":"id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id  In"}},{"name":"id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Id  Isnull"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"status__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status  In"}},{"name":"status__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Status  Isnull"}},{"name":"created_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"}},{"name":"created_at__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Neq"}},{"name":"created_at__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gt"}},{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gte"}},{"name":"created_at__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lt"}},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lte"}},{"name":"created_at__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Created At  Isnull"}},{"name":"created_at__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At  In"}},{"name":"jobs__id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Id"}},{"name":"jobs__id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Id  In"}},{"name":"jobs__id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Jobs  Id  Isnull"}},{"name":"jobs__name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Name"}},{"name":"jobs__name__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Name  Ilike"}},{"name":"jobs__name__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Name  Like"}},{"name":"jobs__name__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Name  In"}},{"name":"jobs__name__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Jobs  Name  Isnull"}},{"name":"jobs__description","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Description"}},{"name":"jobs__description__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Description  Ilike"}},{"name":"jobs__description__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Description  Like"}},{"name":"jobs__description__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Description  In"}},{"name":"jobs__description__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Jobs  Description  Isnull"}},{"name":"jobs__resource","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Resource"}},{"name":"jobs__resource__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Resource  In"}},{"name":"jobs__resource__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Jobs  Resource  Isnull"}},{"name":"jobs__status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Status"}},{"name":"jobs__status__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Status  In"}},{"name":"jobs__status__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Jobs  Status  Isnull"}},{"name":"jobs__job_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/JobType"},{"type":"null"}],"title":"Jobs  Job Type"}},{"name":"jobs__job_type__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Job Type  In"}},{"name":"jobs__job_type__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Jobs  Job Type  Isnull"}},{"name":"jobs__operation_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Operation Type"}},{"name":"jobs__operation_type__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Operation Type  In"}},{"name":"jobs__operation_type__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Jobs  Operation Type  Isnull"}},{"name":"jobs__created_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Jobs  Created At"}},{"name":"jobs__created_at__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Jobs  Created At  Neq"}},{"name":"jobs__created_at__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Jobs  Created At  Gt"}},{"name":"jobs__created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Jobs  Created At  Gte"}},{"name":"jobs__created_at__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Jobs  Created At  Lt"}},{"name":"jobs__created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Jobs  Created At  Lte"}},{"name":"jobs__created_at__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Jobs  Created At  Isnull"}},{"name":"jobs__created_at__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  Created At  In"}},{"name":"jobs__is_default","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Jobs  Is Default"}},{"name":"jobs__file_path","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  File Path"}},{"name":"jobs__file_path__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  File Path  Ilike"}},{"name":"jobs__file_path__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  File Path  Like"}},{"name":"jobs__file_path__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobs  File Path  In"}},{"name":"jobs__file_path__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Jobs  File Path  Isnull"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/entitlements":{"get":{"tags":["Entitlements"],"summary":"List Entitlements","description":"List entitlement given a `next` or `previous` cursor and a limit. If cursor is not provided you will get the beginning of the search set","operationId":"get_entitlements_list_entitlements_get","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","examples":["V2VsbCBhcmV1IGN1cmlvdxM="],"title":"Cursor"},"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of results to return - defaults to 10","examples":[10],"title":"Limit"},"description":"The number of results to return - defaults to 10"},{"name":"order","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["order=created_at"],"default":"-created_at","title":"Order"}},{"name":"sort_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=id"],"title":"Sort Key"}},{"name":"sort_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=asc"],"title":"Sort Type"}},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"}},{"name":"id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id  In"}},{"name":"id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Id  Isnull"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"name__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name  Ilike"}},{"name":"name__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name  Like"}},{"name":"name__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name  In"}},{"name":"name__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Name  Isnull"}},{"name":"description","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},{"name":"description__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description  Ilike"}},{"name":"description__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description  Like"}},{"name":"description__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description  In"}},{"name":"description__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Description  Isnull"}},{"name":"entitlement_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entitlement Type"}},{"name":"entitlement_type__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entitlement Type  Ilike"}},{"name":"entitlement_type__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entitlement Type  Like"}},{"name":"entitlement_type__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entitlement Type  In"}},{"name":"entitlement_type__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Entitlement Type  Isnull"}},{"name":"units","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Units"}},{"name":"units__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Units  Ilike"}},{"name":"units__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Units  Like"}},{"name":"units__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Units  In"}},{"name":"units__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Units  Isnull"}},{"name":"is_active__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active  Isnull"}},{"name":"is_active","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active"}},{"name":"created_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"}},{"name":"created_at__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Neq"}},{"name":"created_at__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gt"}},{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gte"}},{"name":"created_at__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lt"}},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lte"}},{"name":"created_at__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Created At  Isnull"}},{"name":"created_at__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At  In"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}},{"name":"apiversion","in":"header","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Apiversion"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResults_EntitlementResponseSchema_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Entitlements"],"summary":"Create Entitlement","description":"Create a new entitlement","operationId":"create_entitlement_entitlements_post","parameters":[{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEntitlementRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitlementResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/entitlements/customers_balances":{"get":{"tags":["Entitlements"],"summary":"List Customer Balances","description":"Get a list of entitlement balances for all customers","operationId":"get_entitlements_customers_list_entitlements_customers_balances_get","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","examples":["V2VsbCBhcmV1IGN1cmlvdxM="],"title":"Cursor"},"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of results to return - defaults to 10","examples":[10],"title":"Limit"},"description":"The number of results to return - defaults to 10"},{"name":"sort_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=id"],"title":"Sort Key"}},{"name":"sort_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=asc"],"title":"Sort Type"}},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"populate","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["customer"],"title":"Populate"}},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"}},{"name":"id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id  In"}},{"name":"id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Id  Isnull"}},{"name":"entitlement","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entitlement"}},{"name":"entitlement__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entitlement  In"}},{"name":"entitlement__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Entitlement  Isnull"}},{"name":"customer","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer"}},{"name":"customer__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer  In"}},{"name":"customer__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Customer  Isnull"}},{"name":"created_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"}},{"name":"created_at__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Neq"}},{"name":"created_at__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gt"}},{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gte"}},{"name":"created_at__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lt"}},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lte"}},{"name":"created_at__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Created At  Isnull"}},{"name":"created_at__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At  In"}},{"name":"active_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Active From"}},{"name":"active_from__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Active From  Neq"}},{"name":"active_from__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Active From  Gt"}},{"name":"active_from__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Active From  Gte"}},{"name":"active_from__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Active From  Lt"}},{"name":"active_from__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Active From  Lte"}},{"name":"active_from__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active From  Isnull"}},{"name":"active_from__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Active From  In"}},{"name":"quantity","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity"}},{"name":"quantity__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity  Neq"}},{"name":"quantity__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity  Gt"}},{"name":"quantity__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity  Gte"}},{"name":"quantity__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity  Lt"}},{"name":"quantity__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity  Lte"}},{"name":"quantity__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Quantity  Isnull"}},{"name":"quantity__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quantity  In"}},{"name":"quantity_used","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity Used"}},{"name":"quantity_used__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity Used  Neq"}},{"name":"quantity_used__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity Used  Gt"}},{"name":"quantity_used__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity Used  Gte"}},{"name":"quantity_used__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity Used  Lt"}},{"name":"quantity_used__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity Used  Lte"}},{"name":"quantity_used__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Quantity Used  Isnull"}},{"name":"quantity_used__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quantity Used  In"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResults_EntitlementCustomerResponseSchema_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/entitlements/{entitlement_id}":{"get":{"tags":["Entitlements"],"summary":"Get Entitlement by ID","description":"Get entitlement details by its unique identifier","operationId":"get_entitlement_by_id_entitlements__entitlement_id__get","parameters":[{"name":"entitlement_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Entitlement Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitlementResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Entitlements"],"summary":"Update Entitlement","description":"Update an existing entitlement","operationId":"patch_entitlement_entitlements__entitlement_id__patch","parameters":[{"name":"entitlement_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Entitlement Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEntitlementRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitlementResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Entitlements"],"summary":"Delete Entitlement","description":"Delete an existing entitlement","operationId":"delete_entitlement_customer_by_id_entitlements__entitlement_id__delete","parameters":[{"name":"entitlement_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Entitlement Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteEntitlementResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/entitlements/{entitlement_id}/customer":{"post":{"tags":["Entitlements"],"summary":"Create Customer Entitlement","description":"Create a new entitlement for a customer","operationId":"create_entitlement_customer_entitlements__entitlement_id__customer_post","parameters":[{"name":"entitlement_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Entitlement Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEntitlementCustomerRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleEntitlementCustomerResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/entitlements/{entitlement_id}/customer/{customer_id}":{"get":{"tags":["Entitlements"],"summary":"List Customer Entitlements","description":"List entitlements assigned to a customer given a `next` or `previous` cursor and a limit. If cursor is not provided you will get the beginning of the search set","operationId":"get_entitlements_list_for_customer_entitlements__entitlement_id__customer__customer_id__get","parameters":[{"name":"entitlement_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Entitlement Id"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Customer Id"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","examples":["V2VsbCBhcmV1IGN1cmlvdxM="],"title":"Cursor"},"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of results to return - defaults to 10","examples":[10],"title":"Limit"},"description":"The number of results to return - defaults to 10"},{"name":"sort_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=id"],"title":"Sort Key"}},{"name":"sort_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=asc"],"title":"Sort Type"}},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"populate","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["customer"],"title":"Populate"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResults_EntitlementCustomerResponseSchema_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/entitlements/{entitlement_id}/customer/{customer_id}/total":{"get":{"tags":["Entitlements"],"summary":"Get Total Customer Entitlements","description":"Get total entitlements for a customer","operationId":"get_total_entitlements_for_customer_entitlements__entitlement_id__customer__customer_id__total_get","parameters":[{"name":"entitlement_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Entitlement Id"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Customer Id"}},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Start Date"}},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"End Date"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TotalEntitlementCustomerResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/entitlements/customer/{customer_id}":{"get":{"tags":["Entitlements"],"summary":"List Customer Entitlements","description":"List all entitlements assigned to a customer","operationId":"get_entitlements_list_for_customer_entitlements_customer__customer_id__get","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Customer Id"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","examples":["V2VsbCBhcmV1IGN1cmlvdxM="],"title":"Cursor"},"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of results to return - defaults to 10","examples":[10],"title":"Limit"},"description":"The number of results to return - defaults to 10"},{"name":"sort_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=id"],"title":"Sort Key"}},{"name":"sort_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=asc"],"title":"Sort Type"}},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"populate","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["customer"],"title":"Populate"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResults_EntitlementCustomerResponseSchema_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/entitlements/customer/unique/{customer_id}":{"get":{"tags":["Entitlements"],"summary":"List Unique Customer Entitlements","description":"List unique entitlements assigned to a customer","operationId":"get_unique_entitlements_list_for_customer_entitlements_customer_unique__customer_id__get","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Customer Id"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","examples":["V2VsbCBhcmV1IGN1cmlvdxM="],"title":"Cursor"},"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of results to return - defaults to 10","examples":[10],"title":"Limit"},"description":"The number of results to return - defaults to 10"},{"name":"sort_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=id"],"title":"Sort Key"}},{"name":"sort_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["sort_key=asc"],"title":"Sort Type"}},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"}},{"name":"id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id  In"}},{"name":"id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Id  Isnull"}},{"name":"entitlement","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entitlement"}},{"name":"entitlement__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entitlement  In"}},{"name":"entitlement__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Entitlement  Isnull"}},{"name":"customer","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer"}},{"name":"customer__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer  In"}},{"name":"customer__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Customer  Isnull"}},{"name":"created_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"}},{"name":"created_at__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Neq"}},{"name":"created_at__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gt"}},{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gte"}},{"name":"created_at__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lt"}},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lte"}},{"name":"created_at__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Created At  Isnull"}},{"name":"created_at__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At  In"}},{"name":"active_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Active From"}},{"name":"active_from__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Active From  Neq"}},{"name":"active_from__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Active From  Gt"}},{"name":"active_from__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Active From  Gte"}},{"name":"active_from__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Active From  Lt"}},{"name":"active_from__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Active From  Lte"}},{"name":"active_from__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active From  Isnull"}},{"name":"active_from__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Active From  In"}},{"name":"quantity","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity"}},{"name":"quantity__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity  Neq"}},{"name":"quantity__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity  Gt"}},{"name":"quantity__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity  Gte"}},{"name":"quantity__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity  Lt"}},{"name":"quantity__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity  Lte"}},{"name":"quantity__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Quantity  Isnull"}},{"name":"quantity__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quantity  In"}},{"name":"quantity_used","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity Used"}},{"name":"quantity_used__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity Used  Neq"}},{"name":"quantity_used__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity Used  Gt"}},{"name":"quantity_used__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity Used  Gte"}},{"name":"quantity_used__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity Used  Lt"}},{"name":"quantity_used__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity Used  Lte"}},{"name":"quantity_used__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Quantity Used  Isnull"}},{"name":"quantity_used__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quantity Used  In"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResults_EntitlementCustomerSumResponseSchema_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/entitlements/{entitlement_id}/customer/{customer_id}/{ec_id}":{"get":{"tags":["Entitlements"],"summary":"Get Customer Entitlement by ID","description":"Get specific entitlement details for a customer","operationId":"get_entitlement_customer_by_id_entitlements__entitlement_id__customer__customer_id___ec_id__get","parameters":[{"name":"entitlement_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the entitlement","title":"Entitlement Id"},"description":"The ID of the entitlement"},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the customer","title":"Customer Id"},"description":"The ID of the customer"},{"name":"ec_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the entitlement customer","title":"Ec Id"},"description":"The ID of the entitlement customer"},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleEntitlementCustomerResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Entitlements"],"summary":"Update Customer Entitlement","description":"Update an existing customer entitlement","operationId":"patch_entitlement_customer_entitlements__entitlement_id__customer__customer_id___ec_id__patch","parameters":[{"name":"entitlement_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Entitlement Id"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Customer Id"}},{"name":"ec_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Ec Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEntitlementCustomerRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleEntitlementCustomerResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Entitlements"],"summary":"Delete Customer Entitlement","description":"Delete an existing customer entitlement","operationId":"delete_entitlement_customer_by_id_entitlements__entitlement_id__customer__customer_id___ec_id__delete","parameters":[{"name":"entitlement_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Entitlement Id"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Customer Id"}},{"name":"ec_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Ec Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteEntitlementResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/business_entities":{"get":{"tags":["Business Entities"],"summary":"List business entities","description":"List business entities with pagination, filtering, and sorting options.","operationId":"get_business_entities_business_entities_get","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","examples":["V2VsbCBhcmV1IGN1cmlvdxM="],"title":"Cursor"},"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of results to return - defaults to 10","examples":[10],"title":"Limit"},"description":"The number of results to return - defaults to 10"},{"name":"order","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["order=created_at"],"default":"-created_at","title":"Order"}},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"}},{"name":"id__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id  Ilike"}},{"name":"id__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id  Like"}},{"name":"id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id  In"}},{"name":"id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Id  Isnull"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"name__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name  Ilike"}},{"name":"name__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name  Like"}},{"name":"name__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name  In"}},{"name":"name__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Name  Isnull"}},{"name":"email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"}},{"name":"email__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email  Ilike"}},{"name":"email__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email  Like"}},{"name":"email__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email  In"}},{"name":"email__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Email  Isnull"}},{"name":"phone_number__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number  Ilike"}},{"name":"phone_number__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number  Like"}},{"name":"phone_number__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Phone Number  Isnull"}},{"name":"is_default","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Default"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResults_BusinessEntityResponseSchema_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Business Entities"],"summary":"Create a business entity","description":"Create a new business entity with the provided details.","operationId":"create_business_entity_business_entities_post","parameters":[{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBusinessEntitySchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessEntityResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/business_entities/{entity_id}":{"get":{"tags":["Business Entities"],"summary":"Get business entity by ID","description":"Fetch a business entity by its ID.","operationId":"get_business_entity_business_entities__entity_id__get","parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Entity Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessEntityResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Business Entities"],"summary":"Update a business entity","description":"Update an existing business entity with the provided details.","operationId":"update_business_entity_business_entities__entity_id__patch","parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Entity Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBusinessEntityRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessEntityResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/product":{"get":{"tags":["Products"],"summary":"List Products","description":"List products given a `next` or `previous` cursor and a limit. If cursor is not provided you will get the beginning of the search set","operationId":"get_product_list_product_get","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","examples":["V2VsbCBhcmV1IGN1cmlvdxM="],"title":"Cursor"},"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of results to return - defaults to 10","examples":[10],"title":"Limit"},"description":"The number of results to return - defaults to 10"},{"name":"order","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["order=created_at"],"default":"-created_at","title":"Order"}},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"}},{"name":"id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id  In"}},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/app__product__model__ProductType"},{"type":"null"}],"title":"Type"}},{"name":"type__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type  In"}},{"name":"product_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product Name"}},{"name":"product_name__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product Name  Ilike"}},{"name":"created_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"}},{"name":"created_at__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gt"}},{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gte"}},{"name":"created_at__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lt"}},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lte"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/product/{product_id}":{"get":{"tags":["Products"],"summary":"Get Product by ID","description":"Get product details by its unique identifier","operationId":"get_product_product__product_id__get","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string","title":"Product Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/product/pricing_model/all":{"get":{"tags":["Products"],"summary":"List Pricing Models","description":"Get a list of all available pricing models","operationId":"get_pricing_models_list_product_pricing_model_all_get","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","examples":["V2VsbCBhcmV1IGN1cmlvdxM="],"title":"Cursor"},"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of results to return - defaults to 10","examples":[10],"title":"Limit"},"description":"The number of results to return - defaults to 10"},{"name":"order","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["order=created_at"],"default":"-created_at","title":"Order"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/products":{"get":{"tags":["Products"],"summary":"List Products","description":"List products given a `next` or `previous` cursor and a limit. If cursor is not provided you will get the beginning of the search set","operationId":"get_product_list_products_get","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","examples":["V2VsbCBhcmV1IGN1cmlvdxM="],"title":"Cursor"},"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of results to return - defaults to 10","examples":[10],"title":"Limit"},"description":"The number of results to return - defaults to 10"},{"name":"order","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["order=created_at"],"default":"-created_at","title":"Order"}},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ProductTypeV2"},{"type":"null"}],"title":"Type"}},{"name":"type__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type  In"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"name__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name  Ilike"}},{"name":"created_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"}},{"name":"created_at__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gt"}},{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gte"}},{"name":"created_at__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lt"}},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lte"}},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"}},{"name":"id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id  In"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Products"],"summary":"Create Product","description":"Creates a new product in the organization.","operationId":"create_product_products_post","parameters":[{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}},{"name":"apiversion","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apiversion"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/products/{product_id}":{"get":{"tags":["Products"],"summary":"Get Product by ID","description":"Fetches a product by its ID.","operationId":"get_product_products__product_id__get","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The UUID of the product","title":"Product Id"},"description":"The UUID of the product","example":"d290f1ee-6c54-4b01-90e6-d701748f0851"},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Products"],"summary":"Update Product by ID","description":"Updates a product by its ID.","operationId":"patch_product_products__product_id__patch","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Product Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProductRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Products"],"summary":"Delete Product by ID","description":"Deletes a product by its ID.","operationId":"delete_product_products__product_id__delete","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Product Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteProductResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/products/{product_id}/pricing":{"get":{"tags":["Products"],"summary":"Get Product Pricing","description":"Fetches all pricing models associated with a product.","operationId":"get_product_pricing_products__product_id__pricing_get","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Product Id"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","examples":["V2VsbCBhcmV1IGN1cmlvdxM="],"title":"Cursor"},"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of results to return - defaults to 10","examples":[10],"title":"Limit"},"description":"The number of results to return - defaults to 10"},{"name":"order","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["order=created_at"],"default":"-created_at","title":"Order"}},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ProductTypeV2"},{"type":"null"}],"title":"Type"}},{"name":"type__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type  In"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"name__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name  Ilike"}},{"name":"created_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"}},{"name":"created_at__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gt"}},{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gte"}},{"name":"created_at__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lt"}},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lte"}},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"}},{"name":"id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id  In"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResults_ProductBundlePricingResponseSchema_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Products"],"summary":"Create Product Pricing","description":"Creates a new pricing model for a product.","operationId":"create_product_pricing_products__product_id__pricing_post","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Product Id"}},{"name":"return_existing","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"examples":["return_existing=True"],"default":false,"title":"Return Existing"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProductPricingRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/products/{product_id}/pricing/{pricing_id}":{"get":{"tags":["Products"],"summary":"List Pricings by Product ID","description":"Fetches a specific pricing model by its ID.","operationId":"get_pricing_model_by_id_products__product_id__pricing__pricing_id__get","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Product Id"}},{"name":"pricing_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Pricing Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Products"],"summary":"Update Product Pricing","description":"Updates an existing pricing model for a product.","operationId":"update_product_pricing_products__product_id__pricing__pricing_id__patch","parameters":[{"name":"pricing_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Pricing Id"}},{"name":"product_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Product Id"}},{"name":"return_existing","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"examples":["return_existing=True"],"default":false,"title":"Return Existing"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProductPricingRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Products"],"summary":"Delete Product Pricing","description":"Deletes a specific pricing model for a product by its ID.","operationId":"delete_pricing_model_products__product_id__pricing__pricing_id__delete","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Product Id"}},{"name":"pricing_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Pricing Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteProductResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/products/bundle/{product_id}/pricing/{pricing_id}":{"get":{"tags":["Products"],"summary":"Get Product Bundle Pricing","description":"Fetches a specific product bundle pricing by its ID.","operationId":"get_product_bundle_pricing_products_bundle__product_id__pricing__pricing_id__get","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Product Id"}},{"name":"pricing_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Pricing Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductBundlePricingResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Products"],"summary":"Update Product Bundle Pricing","description":"Updates an existing pricing model for a product bundle.","operationId":"update_product_bundle_pricing_products_bundle__product_id__pricing__pricing_id__patch","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Product Id"}},{"name":"pricing_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Pricing Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProductBundlePricingRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductBundlePricingResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/products/bundle/{product_id}/pricing":{"post":{"tags":["Products"],"summary":"Create Product Bundle Pricing","description":"Creates a new pricing model for a product bundle.","operationId":"create_product_bundle_pricing_products_bundle__product_id__pricing_post","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Product Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProductBundlePricingRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductBundlePricingResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/contract_v2":{"get":{"tags":["Contracts"],"summary":"List Contracts","description":"List contracts given a `next` or `previous` cursor and a limit. If cursor is not provided you will get the beginning of the search set","operationId":"get_contracts_list_contract_v2_get","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","examples":["V2VsbCBhcmV1IGN1cmlvdxM="],"title":"Cursor"},"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of results to return - defaults to 10","examples":[10],"title":"Limit"},"description":"The number of results to return - defaults to 10"},{"name":"order","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["order=created_at"],"default":"-created_at","title":"Order"}},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"}},{"name":"id__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id  Ilike"}},{"name":"id__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id  Like"}},{"name":"id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id  In"}},{"name":"id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Id  Isnull"}},{"name":"customer_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"}},{"name":"customer_id__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id  In"}},{"name":"customer_id__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Customer Id  Isnull"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"name__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name  Ilike"}},{"name":"name__like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name  Like"}},{"name":"name__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name  In"}},{"name":"name__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Name  Isnull"}},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Date"}},{"name":"start_date__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Date  Neq"}},{"name":"start_date__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Date  Gt"}},{"name":"start_date__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Date  Gte"}},{"name":"start_date__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Date  Lt"}},{"name":"start_date__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Date  Lte"}},{"name":"start_date__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Start Date  Isnull"}},{"name":"start_date__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Date  In"}},{"name":"created_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"}},{"name":"created_at__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Neq"}},{"name":"created_at__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gt"}},{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gte"}},{"name":"created_at__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lt"}},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lte"}},{"name":"created_at__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Created At  Isnull"}},{"name":"created_at__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At  In"}},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Date"}},{"name":"end_date__neq","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Date  Neq"}},{"name":"end_date__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Date  Gt"}},{"name":"end_date__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Date  Gte"}},{"name":"end_date__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Date  Lt"}},{"name":"end_date__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Date  Lte"}},{"name":"end_date__isnull","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"End Date  Isnull"}},{"name":"end_date__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Date  In"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ContractStatus"},{"type":"null"}],"title":"Status"}},{"name":"status__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status  In"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResults_ContractResponseSchema_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Contracts"],"summary":"Create Contract","description":"Create a new contract","operationId":"create_contract_contract_v2_post","parameters":[{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContractRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/contract_v2/{contract_id}":{"get":{"tags":["Contracts"],"summary":"Get Contract by ID","description":"Get a contract by its unique identifier","operationId":"get_contract_by_id_contract_v2__contract_id__get","parameters":[{"name":"contract_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contract Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Contracts"],"summary":"Update Contract","description":"Update an already existing contract.","operationId":"update_contract_contract_v2__contract_id__put","parameters":[{"name":"contract_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contract Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateContractRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Contracts"],"summary":"Delete Contract","description":"Delete a contract by its ID, a contract must not be active to be deleted.","operationId":"delete_contract_contract_v2__contract_id__delete","parameters":[{"name":"contract_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contract Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/contract_v2/{contract_id}/amendments":{"get":{"tags":["Contracts"],"summary":"Get Contract Amendments","description":"Get all amendments for a contract","operationId":"get_amendments_by_contract_id_contract_v2__contract_id__amendments_get","parameters":[{"name":"contract_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contract Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/contract_v2/{contract_id}/phases":{"post":{"tags":["Contracts"],"summary":"Create Contract Phase","description":"Create a new phase for an existing contract","operationId":"create_contract_phase_contract_v2__contract_id__phases_post","parameters":[{"name":"contract_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contract Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContractPhaseRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractPhaseResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/contract_v2/{contract_id}/pause":{"post":{"tags":["Contracts"],"summary":"Pause Contract","description":"Pause an existing contract.","operationId":"pause_contract_contract_v2__contract_id__pause_post","parameters":[{"name":"contract_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contract Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PauseContractRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Contracts"],"summary":"Update Paused Contract","description":"Edit the pause of an existing contract.","operationId":"edit_pause_contract_contract_v2__contract_id__pause_patch","parameters":[{"name":"contract_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contract Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditPauseContractRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/contract_v2/{contract_id}/resume":{"patch":{"tags":["Contracts"],"summary":"Resume Contract Pause","description":"Resume the pause of an existing contract.","operationId":"resume_contract_contract_v2__contract_id__resume_patch","parameters":[{"name":"contract_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contract Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/contract_v2/{contract_id}/phases/{phase_id}/pricing":{"post":{"tags":["Contracts"],"summary":"Create Contract Phase Pricing","description":"Create a new pricing association for a contract phase","operationId":"create_contract_phase_pricing_contract_v2__contract_id__phases__phase_id__pricing_post","parameters":[{"name":"contract_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contract Id"}},{"name":"phase_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Phase Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContractPhasePricingRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractPhasePricingResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/contract_v2/{contract_id}/expire":{"patch":{"tags":["Contracts"],"summary":"Expire Contract","description":"Expire a contract by its ID.","operationId":"expire_contract_contract_v2__contract_id__expire_patch","parameters":[{"name":"contract_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contract Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/plans":{"get":{"tags":["Plans"],"summary":"List plans from a given cursor and limit","description":"List plans given a `next` or `previous` cursor and a limit. If cursor is not provided you will get the beginning of the search set","operationId":"get_plans_list_plans_get","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","examples":["V2VsbCBhcmV1IGN1cmlvdxM="],"title":"Cursor"},"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of results to return - defaults to 10","examples":[10],"title":"Limit"},"description":"The number of results to return - defaults to 10"},{"name":"order","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["order=created_at"],"default":"-created_at","title":"Order"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"name__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name  Ilike"}},{"name":"created_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"}},{"name":"created_at__gt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gt"}},{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Gte"}},{"name":"created_at__lt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lt"}},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At  Lte"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/PlanStatus"},{"type":"null"}],"title":"Status"}},{"name":"status__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status  In"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResults_PlanResponseSchema_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Plans"],"summary":"Create Plan","description":"Create a new plan for an organization","operationId":"create_plan_plans_post","parameters":[{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePlanRequestSchema"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/plans/{plan_id}":{"get":{"tags":["Plans"],"summary":"Get plan by ID","description":"Retrieve a specific plan by its ID","operationId":"get_plan_by_id_plans__plan_id__get","parameters":[{"name":"plan_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Plan Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Plans"],"summary":"Update Plan","description":"Update an existing plan by its ID","operationId":"update_plan_plans__plan_id__put","parameters":[{"name":"plan_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Plan Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePlanRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Plans"],"summary":"Delete Plan","description":"Delete a specific plan by its ID","operationId":"delete_plan_by_id_plans__plan_id__delete","parameters":[{"name":"plan_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Plan Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/plans/{plan_id}/phases":{"post":{"tags":["Plans"],"summary":"Create Plan Phase","description":"Create a new phase for a plan","operationId":"create_plan_phase_plans__plan_id__phases_post","parameters":[{"name":"plan_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Plan Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePlanPhaseRequestSchema"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanPhaseResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/plans/{plan_id}/phases/{phase_id}":{"put":{"tags":["Plans"],"summary":"Update Plan Phase","description":"Update an existing phase for a plan by its ID","operationId":"update_plan_phase_plans__plan_id__phases__phase_id__put","parameters":[{"name":"plan_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the plan","title":"Plan Id"},"description":"The ID of the plan"},{"name":"phase_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the phase","title":"Phase Id"},"description":"The ID of the phase"},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePlanPhaseRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanPhaseResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Plans"],"summary":"Delete Plan Phase","description":"Delete a specific phase from a plan by its ID","operationId":"delete_plan_phase_by_id_plans__plan_id__phases__phase_id__delete","parameters":[{"name":"plan_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the plan","title":"Plan Id"},"description":"The ID of the plan"},{"name":"phase_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the phase","title":"Phase Id"},"description":"The ID of the phase"},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/plans/{plan_id}/phases/{phase_id}/pricing":{"post":{"tags":["Plans"],"summary":"Create Plan Phase Pricing","description":"Create pricing for a plan phase","operationId":"create_plan_phase_pricing_plans__plan_id__phases__phase_id__pricing_post","parameters":[{"name":"plan_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the plan","title":"Plan Id"},"description":"The ID of the plan"},{"name":"phase_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the phase","title":"Phase Id"},"description":"The ID of the phase"},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePlanPhasePricingRequestSchema"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanPhasePricingResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/plans/{plan_id}/phases/{phase_id}/pricing/{phase_pricing_id}":{"put":{"tags":["Plans"],"summary":"Update Plan Phase Pricing","description":"Update pricing for a plan phase by its ID","operationId":"update_plan_phase_pricing_plans__plan_id__phases__phase_id__pricing__phase_pricing_id__put","parameters":[{"name":"plan_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the plan","title":"Plan Id"},"description":"The ID of the plan"},{"name":"phase_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the phase","title":"Phase Id"},"description":"The ID of the phase"},{"name":"phase_pricing_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the phase pricing","title":"Phase Pricing Id"},"description":"The ID of the phase pricing"},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePlanPhasePricingRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanPhasePricingResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/plans/{plan_id}/phases/{phase_id}/pricing/{pricing_id}":{"delete":{"tags":["Plans"],"summary":"Delete Plan Phase Pricing","description":"Delete pricing for a specific plan phase by its ID","operationId":"delete_plan_phase_pricing_by_id_plans__plan_id__phases__phase_id__pricing__pricing_id__delete","parameters":[{"name":"plan_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the plan","title":"Plan Id"},"description":"The ID of the plan"},{"name":"phase_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the phase","title":"Phase Id"},"description":"The ID of the phase"},{"name":"pricing_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the pricing","title":"Pricing Id"},"description":"The ID of the pricing"},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/plans/{plan_id}/new_version":{"post":{"tags":["Plans"],"summary":"Create New Version of Plan","description":"Create a new version of an existing plan","operationId":"create_new_version_plans__plan_id__new_version_post","parameters":[{"name":"plan_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Plan Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePlanRequestSchema"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/contract_metadata/":{"post":{"tags":["Contract Metadata"],"summary":"Create contract metadata","description":"Create contract metadata with the provided request schema.","operationId":"create_contract_metadata_contract_metadata__post","parameters":[{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContractMetadataRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractMetadataResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/contract_metadata/contract/{contract_id}":{"get":{"tags":["Contract Metadata"],"summary":"Get contract metadata by contract id","description":"Fetch contract metadata using the contract id.","operationId":"get_contract_metadata_by_contract_id_contract_metadata_contract__contract_id__get","parameters":[{"name":"contract_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contract Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractMetadataResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Contract Metadata"],"summary":"Update contract metadata by contract id","description":"Update contract metadata using the contract id.","operationId":"update_contract_metadata_by_contract_id_contract_metadata_contract__contract_id__put","parameters":[{"name":"contract_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contract Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContractMetadataRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractMetadataResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/contract_metadata/{id}":{"get":{"tags":["Contract Metadata"],"summary":"Get contract metadata by id","description":"Fetch contract metadata using the unique identifier.","operationId":"get_contract_metadata_by_id_contract_metadata__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractMetadataResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Contract Metadata"],"summary":"Update contract metadata by id","description":"Update contract metadata using the unique identifier.","operationId":"update_contract_metadata_by_id_contract_metadata__id__put","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContractMetadataRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractMetadataResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/tags/{holder}/{item_id}":{"get":{"tags":["Tags"],"summary":"List tags","description":"List tags","operationId":"get_tags_tags__holder___item_id__get","parameters":[{"name":"holder","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TagHolder"}},{"name":"item_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Item Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/tags":{"post":{"tags":["Tags"],"summary":"Upsert tags","description":"Upsert tags","operationId":"upsert_tags_tags_post","parameters":[{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertTagsRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/usage_events/{raw_metric_slug}":{"post":{"tags":["Usage Events"],"summary":"Ingest Usage Event","description":"Ingest a usage event associated with a raw metric.","operationId":"ingest_usage_event_usage_events__raw_metric_slug__post","parameters":[{"name":"raw_metric_slug","in":"path","required":true,"schema":{"type":"string","title":"Raw Metric Slug"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/custom_attributes":{"post":{"tags":["Custom Attributes"],"summary":"Create Custom Attribute Definition","description":"Create a new custom attribute definition for an organisation, or a specific business entity within it.","operationId":"create_custom_attribute_definition_custom_attributes_post","parameters":[{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"The UUID of the organisation","title":"Organisation"},"description":"The UUID of the organisation"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomAttributeDefinitionCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomAttributeDefinitionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Custom Attributes"],"summary":"List Custom Attribute Definitions","description":"List custom attribute definitions for an organisation.\n    If module is provided, returns definitions for that specific module.\n    If business_entity_id is provided, returns org defaults with business entity overrides.\n    Business entity overrides take precedence over org defaults for the same attribute.","operationId":"list_custom_attribute_definitions_custom_attributes_get","parameters":[{"name":"module","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ModuleEnum"},{"type":"null"}],"title":"Module"}},{"name":"business_entity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Business Entity Id"}},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["name=john"],"title":"Search"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","examples":["V2VsbCBhcmV1IGN1cmlvdxM="],"title":"Cursor"},"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of results to return - defaults to 10","examples":[10],"title":"Limit"},"description":"The number of results to return - defaults to 10"},{"name":"sort_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sort by field name. Valid fields: id, organisation_id, business_entity_id, attribute_key_name, display_name, data_type, is_tag, is_enabled, is_required, sort_order, created_at, updated_at","title":"Sort Key"},"description":"Sort by field name. Valid fields: id, organisation_id, business_entity_id, attribute_key_name, display_name, data_type, is_tag, is_enabled, is_required, sort_order, created_at, updated_at"},{"name":"sort_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sort order: 'asc' or 'desc'.","default":"desc","title":"Sort Type"},"description":"Sort order: 'asc' or 'desc'."},{"name":"is_tag","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Tag"}},{"name":"data_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/DataTypeEnum"},{"type":"null"}],"title":"Data Type"}},{"name":"attribute_key_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Attribute Key Name"}},{"name":"display_name__ilike","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name  Ilike"}},{"name":"is_enabled","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Enabled"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"The UUID of the organisation","title":"Organisation"},"description":"The UUID of the organisation"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResults"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/custom_attributes/{definition_id}":{"get":{"tags":["Custom Attributes"],"summary":"Get Custom Attribute Definition","description":"Retrieve a specific custom attribute definition by its ID.","operationId":"get_custom_attribute_definition_custom_attributes__definition_id__get","parameters":[{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Definition Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"The UUID of the organisation","title":"Organisation"},"description":"The UUID of the organisation"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomAttributeDefinitionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Custom Attributes"],"summary":"Update Custom Attribute Definition","description":"Update an existing custom attribute definition. Note: attribute_key_name and data_type are generally not updatable after creation.","operationId":"update_custom_attribute_definition_custom_attributes__definition_id__patch","parameters":[{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Definition Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"The UUID of the organisation","title":"Organisation"},"description":"The UUID of the organisation"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomAttributeDefinitionUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomAttributeDefinitionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Custom Attributes"],"summary":"Delete Custom Attribute Definition","description":"Delete a custom attribute definition.","operationId":"delete_custom_attribute_definition_custom_attributes__definition_id__delete","parameters":[{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Definition Id"}},{"name":"organisation","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"The UUID of the organisation","title":"Organisation"},"description":"The UUID of the organisation"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Address":{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"Line 1"},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Line 2"},"line3":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line3","description":"Line 3"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State"},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Zip Code"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country"},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Code","description":"Country Code"},"validation_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Validation Status","description":"Address Validation Status"},"connector_validation":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Connector Validation","description":"Connector Validation"}},"type":"object","title":"Address","description":"Address Schema"},"AddressResponse":{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"Line 1"},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Line 2"},"line3":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line3","description":"Line 3"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State"},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Zip Code"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country"},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Code","description":"Country Code"},"validation_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Validation Status","description":"Address Validation Status"},"connector_validation":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Connector Validation","description":"Connector Validation"}},"type":"object","title":"AddressResponse","description":"Address Schema"},"AggregateEstimateResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"UUID of the estimate"},"organisation_id":{"type":"string","format":"uuid","title":"Organisation Id","description":"UUID of the organisation"},"aggregate_id":{"type":"string","format":"uuid","title":"Aggregate Id","description":"UUID of the aggregate"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"UUID of the customer"},"start_date":{"type":"string","format":"date","title":"Start Date","description":"Start date of the estimate"},"end_date":{"type":"string","format":"date","title":"End Date","description":"End date of the estimate"},"value":{"$ref":"#/components/schemas/EstimateValue","description":"Value of the estimate"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the estimate"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Deletion timestamp of the estimate"},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deleted At","description":"Deletion timestamp of the estimate"}},"type":"object","required":["id","organisation_id","aggregate_id","customer_id","start_date","end_date","value","created_at"],"title":"AggregateEstimateResponseSchema"},"AggregateResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"aggregate Id"},"name":{"type":"string","title":"Name","description":"name of the aggregate"},"dataschema":{"type":"string","title":"Dataschema","description":"data schema of aggregate"},"aggregation_query":{"type":"string","title":"Aggregation Query","description":"aggregate query"},"cust_agg_query":{"type":"string","title":"Cust Agg Query","description":"customer aggregate query"},"visual_query_builder":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Visual Query Builder","description":"visual query builder"},"datasource":{"type":"string","format":"uuid","title":"Datasource","description":"data source uuid"},"version":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version","description":"version of aggregate"}},"type":"object","required":["id","name","dataschema","aggregation_query","cust_agg_query","visual_query_builder","datasource"],"title":"AggregateResponseSchema","description":"Aggregate Response Schema"},"AggregateType":{"type":"string","enum":["usage_report"],"title":"AggregateType"},"Amendment-Input":{"properties":{"contract_amendment_id":{"type":"string","format":"uuid","title":"Contract Amendment Id","description":"contract amendment id"},"effective_start_date":{"type":"string","format":"date","title":"Effective Start Date","description":"effective start date"},"effective_end_date":{"type":"string","format":"date","title":"Effective End Date","description":"effective end date"},"amendment_execution_data":{"$ref":"#/components/schemas/AmendmentExecutionData-Input","description":"amendment execution data"},"contract_billing_period":{"$ref":"#/components/schemas/BillingPeriod","description":"contract billing period"}},"type":"object","required":["contract_amendment_id","effective_start_date","effective_end_date","amendment_execution_data","contract_billing_period"],"title":"Amendment"},"Amendment-Output":{"properties":{"contract_amendment_id":{"type":"string","format":"uuid","title":"Contract Amendment Id","description":"contract amendment id"},"effective_start_date":{"type":"string","format":"date","title":"Effective Start Date","description":"effective start date"},"effective_end_date":{"type":"string","format":"date","title":"Effective End Date","description":"effective end date"},"amendment_execution_data":{"$ref":"#/components/schemas/AmendmentExecutionData-Output","description":"amendment execution data"},"contract_billing_period":{"$ref":"#/components/schemas/BillingPeriod","description":"contract billing period"}},"type":"object","required":["contract_amendment_id","effective_start_date","effective_end_date","amendment_execution_data","contract_billing_period"],"title":"Amendment"},"AmendmentExecutionData-Input":{"properties":{"invoice_total":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/ValueReference"}],"title":"Invoice Total"},"products":{"additionalProperties":{"$ref":"#/components/schemas/Product-Input"},"type":"object","title":"Products"},"top_features":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/Executable-Input"},"type":"object"},{"type":"null"}],"title":"Top Features"}},"type":"object","required":["invoice_total","products"],"title":"AmendmentExecutionData"},"AmendmentExecutionData-Output":{"properties":{"invoice_total":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/ValueReference"}],"title":"Invoice Total"},"products":{"additionalProperties":{"$ref":"#/components/schemas/Product-Output"},"type":"object","title":"Products"},"top_features":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/Executable-Output"},"type":"object"},{"type":"null"}],"title":"Top Features"}},"type":"object","required":["invoice_total","products"],"title":"AmendmentExecutionData"},"BillingPeriod":{"properties":{"billing_frequency":{"type":"string","title":"Billing Frequency","description":"ISO 8601 duration string. eg. P3M"},"billing_start_date_offset":{"$ref":"#/components/schemas/BillingStartDateOffset","description":"beginning or end of cycle"},"start_date":{"type":"string","format":"date","title":"Start Date","description":"start date"},"end_date":{"type":"string","format":"date","title":"End Date","description":"end date"}},"type":"object","required":["billing_frequency","billing_start_date_offset","start_date","end_date"],"title":"BillingPeriod"},"BillingStartDateOffset":{"type":"string","enum":["BEGINNING_OF_CYCLE","END_OF_CYCLE"],"title":"BillingStartDateOffset"},"BusinessEntityResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Business Entity ID"},"name":{"type":"string","title":"Name","description":"Business Entity Name"},"address":{"anyOf":[{"$ref":"#/components/schemas/EntityAddress"},{"type":"null"}],"description":"Business Entity address"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Business Entity email"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number","description":"Business Entity phone number"},"is_default":{"type":"boolean","title":"Is Default","description":"Business Entity default"},"tax_config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Tax Config","description":"Business Entity tax config"},"logo_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Logo Url","description":"Business Entity logo URL"}},"type":"object","required":["id","name","is_default"],"title":"BusinessEntityResponseSchema","description":"Business Entity Response Schema"},"Commitment":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Feature ID"},"identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Identifier","description":"Unique identifier for the feature in the pricing instance"},"priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Priority","description":"Priority of the feature, features get applied in ascending order of priority"},"type":{"$ref":"#/components/schemas/CommitmentType"},"unit_amount":{"anyOf":[{"type":"number"},{"$ref":"#/components/schemas/EdgeInput"}],"title":"Unit Amount"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"period":{"anyOf":[{"$ref":"#/components/schemas/PeriodCadence"},{"type":"null"}]},"charge_full_amount":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Charge Full Amount","description":"Charge full amount or not","default":false},"skip_zero_amount":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Skip Zero Amount","description":"Skip when input to minimum commitment is zero","default":false}},"type":"object","required":["type","unit_amount"],"title":"Commitment"},"CommitmentType":{"type":"string","enum":["minimum_spend","maximum_spend"],"title":"CommitmentType"},"Consumption":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Feature ID"},"identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Identifier","description":"Unique identifier for the feature in the pricing instance"},"priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Priority","description":"Priority of the feature, features get applied in ascending order of priority"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"entitlement_id":{"type":"string","format":"uuid","title":"Entitlement Id"},"type":{"$ref":"#/components/schemas/EntitlementType"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"},"show_additional_info":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Additional Info","description":"Show additional info or not","default":false},"trigger_event":{"anyOf":[{"$ref":"#/components/schemas/ConsumptionTriggerEvent"},{"type":"null"}],"description":"","default":"invoice_approval"}},"type":"object","required":["entitlement_id","type"],"title":"Consumption"},"ConsumptionResponse":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Feature ID"},"identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Identifier","description":"Unique identifier for the feature in the pricing instance"},"priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Priority","description":"Priority of the feature, features get applied in ascending order of priority"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"entitlement_id":{"type":"string","format":"uuid","title":"Entitlement Id"},"type":{"$ref":"#/components/schemas/EntitlementType"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"},"show_additional_info":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Additional Info","description":"Show additional info or not","default":false},"trigger_event":{"anyOf":[{"$ref":"#/components/schemas/ConsumptionTriggerEvent"},{"type":"null"}],"description":"","default":"invoice_approval"},"entitlement":{"anyOf":[{"$ref":"#/components/schemas/EntitlementResponseSchema"},{"type":"null"}]}},"type":"object","required":["entitlement_id","type"],"title":"ConsumptionResponse"},"ConsumptionTriggerEvent":{"type":"string","enum":["invoice_approval","invoice_creation","monitoring"],"title":"ConsumptionTriggerEvent"},"ContactResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Contact Id"},"customer":{"type":"string","format":"uuid","title":"Customer","description":" "},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"Contact first name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Contact last name"},"email":{"type":"string","title":"Email","description":"Contact Email"},"send_contract":{"type":"boolean","title":"Send Contract","description":"Send Contract","default":false},"send_invoice":{"type":"boolean","title":"Send Invoice","description":"Send Contact","default":true}},"type":"object","required":["id","customer","email"],"title":"ContactResponseSchema","description":"Create & Update Contact Response Schema"},"ContractMetadataResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"contract metadata ID"},"contract_id":{"type":"string","format":"uuid","title":"Contract Id","description":"contract ID"},"organisation_id":{"type":"string","format":"uuid","title":"Organisation Id","description":"organisation ID"},"amendments":{"items":{"$ref":"#/components/schemas/Amendment-Output"},"type":"array","title":"Amendments","description":"amendments"},"custom_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Data","description":"custom data"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"created at"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"updated at"},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deleted At","description":"deleted at"}},"type":"object","required":["id","contract_id","organisation_id","amendments","created_at","updated_at"],"title":"ContractMetadataResponseSchema"},"ContractPhasePricingResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Contract Phase Pricing ID"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"External ID"},"start_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Date","description":"Start Date"},"end_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Date","description":"End Date"},"phase_id":{"type":"string","format":"uuid","title":"Phase Id","description":"Contract Phase ID"},"pricing_id":{"type":"string","format":"uuid","title":"Pricing Id","description":"Pricing ID"},"product_id":{"type":"string","format":"uuid","title":"Product Id","description":"Product ID"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Contract Phase Pricing created at"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"Contract Phase Pricing updated at"},"product":{"$ref":"#/components/schemas/ProductResponseSchema","description":"Product details"},"pricing":{"$ref":"#/components/schemas/ProductBundlePricingResponseSchema","description":"Pricing details"},"custom_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Data","description":"Pricing Association Metadata"}},"type":"object","required":["id","phase_id","pricing_id","product_id","created_at","updated_at","product","pricing"],"title":"ContractPhasePricingResponseSchema"},"ContractPhaseResponseSchema":{"properties":{"name":{"type":"string","title":"Name","description":"Contract Phase name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Contract Phase Description"},"start_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Date","description":"Start Date"},"end_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Date","description":"End Date"},"id":{"type":"string","format":"uuid","title":"Id","description":"Contract Phase ID"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Contract Phase created at"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"Contract Phase updated at"},"contract_id":{"type":"string","format":"uuid","title":"Contract Id","description":"Contract ID"},"features":{"anyOf":[{"$ref":"#/components/schemas/ProductPricingResponseSchema"},{"type":"null"}],"description":"Pricing for the features of the phase"},"pricings":{"anyOf":[{"items":{"$ref":"#/components/schemas/ContractPhasePricingResponseSchema"},"type":"array"},{"type":"null"}],"title":"Pricings","description":"Different Product Pricings","default":[]},"source_plan_phase_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Source Plan Phase Id","description":"Source Plan Phase ID"},"phase_type":{"anyOf":[{"$ref":"#/components/schemas/PhaseType"},{"type":"null"}],"description":"Phase Type","default":"active"},"phase_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Phase Metadata","description":"Phase Metadata"}},"type":"object","required":["name","id","created_at","updated_at","contract_id"],"title":"ContractPhaseResponseSchema"},"ContractResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Contract ID"},"name":{"type":"string","title":"Name","description":"Contract name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Contract Description"},"tags":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Tags","description":"Contract Tags"},"status":{"$ref":"#/components/schemas/ContractStatus","description":"Contract Status"},"currency":{"type":"string","title":"Currency","description":"Currency"},"start_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Date","description":"Start Date"},"end_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Date","description":"End Date"},"custom_attributes":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Attributes","description":"Contract Tags"},"source":{"additionalProperties":true,"type":"object","title":"Source","description":"Source information for the contract"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Contract created at"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"Contract updated at"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"Customer ID"},"anchor_date":{"type":"string","format":"date-time","title":"Anchor Date","description":"Anchor Date"},"is_last_day_of_month":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Last Day Of Month","description":"Is Last Day of Month"},"plan_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Plan Id","description":"Plan ID"},"renewal_policy":{"anyOf":[{"$ref":"#/components/schemas/RenewalPolicy"},{"type":"null"}],"description":"Renewal Policy"},"phases":{"anyOf":[{"items":{"$ref":"#/components/schemas/ContractPhaseResponseSchema"},"type":"array"},{"type":"null"}],"title":"Phases","description":"Different Contract Phases","default":[]},"customer":{"$ref":"#/components/schemas/CustomerResponseSchema","description":"Customer details"},"invoice_payer_customer":{"anyOf":[{"$ref":"#/components/schemas/CustomerResponseSchema"},{"type":"null"}],"description":"Invoice Payer Customer"},"current_phase":{"anyOf":[{"$ref":"#/components/schemas/PhaseDetails"},{"type":"null"}],"description":"Current Contract Phase"},"contract_link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contract Link","description":"Contract Link"},"bill_parent_customer":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Bill Parent Customer","description":"Bill Parent Customer","default":false},"invoice_payer_customer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Invoice Payer Customer Id","description":"Invoice Payer Customer Id"}},"type":"object","required":["id","name","status","currency","created_at","updated_at","customer_id","customer"],"title":"ContractResponseSchema"},"ContractStatus":{"type":"string","enum":["draft","active","paused","expired","disputed"],"title":"ContractStatus"},"CreateAggregateRequestSchema":{"properties":{"name":{"type":"string","title":"Name","description":"name of the aggregate"},"dataschema":{"type":"string","title":"Dataschema","description":"data schema of aggregate"},"aggregation_query":{"type":"string","title":"Aggregation Query","description":"aggregate query"},"cust_agg_query":{"type":"string","title":"Cust Agg Query","description":"customer aggregate query"},"visual_query_builder":{"additionalProperties":true,"type":"object","title":"Visual Query Builder","description":"visual query builder"},"datasource":{"type":"string","title":"Datasource","description":"data source uuid"}},"type":"object","required":["name","dataschema","aggregation_query","cust_agg_query","visual_query_builder","datasource"],"title":"CreateAggregateRequestSchema","description":"Create Aggregate Request Schema"},"CreateBusinessEntitySchema":{"properties":{"name":{"type":"string","title":"Name","description":"Business Entity Name"},"address":{"anyOf":[{"$ref":"#/components/schemas/EntityAddress"},{"type":"null"}],"description":"Business Entity address"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Business Entity email"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number","description":"Business Entity phone number"},"is_default":{"type":"boolean","title":"Is Default","description":"Business Entity default","default":false},"tax_config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Tax Config","description":"Business Entity tax config"},"logo_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Logo Url","description":"Business Entity logo URL"}},"type":"object","required":["name"],"title":"CreateBusinessEntitySchema","description":"Create Organisation Request Schema"},"CreateContactRequestSchema":{"properties":{"customer":{"type":"string","format":"uuid","title":"Customer","description":" "},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"Contact first name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Contact last name"},"email":{"type":"string","title":"Email","description":"Contact Email"},"send_contract":{"type":"boolean","title":"Send Contract","description":"Send Contract","default":false},"send_invoice":{"type":"boolean","title":"Send Invoice","description":"Send Contact","default":true}},"type":"object","required":["customer","email"],"title":"CreateContactRequestSchema","description":"Create Contact Request Schema"},"CreateContractMetadataRequestSchema":{"properties":{"contract_id":{"type":"string","format":"uuid","title":"Contract Id","description":"contract ID"},"amendments":{"items":{"$ref":"#/components/schemas/Amendment-Input"},"type":"array","title":"Amendments","description":"amendments"},"custom_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Data","description":"custom data"}},"type":"object","required":["contract_id","amendments"],"title":"CreateContractMetadataRequestSchema"},"CreateContractPhasePricingRequestSchema":{"properties":{"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"External ID"},"start_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Date","description":"Start Date"},"end_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Date","description":"End Date"},"pricing_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Pricing Id","description":"Pricing ID"},"product_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Product Id","description":"Product ID"},"custom_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Data","description":"Pricing Association Metadata"},"pricing":{"anyOf":[{"$ref":"#/components/schemas/CreateProductPricingRequestSchema"},{"type":"null"}],"description":"Pricing for the phase"},"product":{"anyOf":[{"$ref":"#/components/schemas/CreateProductRequestSchema"},{"type":"null"}],"description":"Product Name"}},"type":"object","title":"CreateContractPhasePricingRequestSchema"},"CreateContractPhaseRequestSchema":{"properties":{"name":{"type":"string","title":"Name","description":"Contract Phase name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Contract Phase Description"},"start_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Date","description":"Start Date"},"end_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Date","description":"End Date"},"pricings":{"anyOf":[{"items":{"$ref":"#/components/schemas/CreateContractPhasePricingRequestSchema"},"type":"array"},{"type":"null"}],"title":"Pricings","description":"Different Product Pricings","default":[]},"features":{"anyOf":[{"$ref":"#/components/schemas/CreateProductPricingRequestSchema"},{"type":"null"}],"description":"Pricing for the features of the phase"},"source_plan_phase_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Source Plan Phase Id","description":"Source Plan Phase ID"},"phase_type":{"anyOf":[{"$ref":"#/components/schemas/PhaseType"},{"type":"null"}],"description":"Phase Type","default":"active"},"phase_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Phase Metadata","description":"Phase Metadata"}},"type":"object","required":["name"],"title":"CreateContractPhaseRequestSchema"},"CreateContractRequestSchema":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Contract ID"},"name":{"type":"string","title":"Name","description":"Contract name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Product Description"},"tags":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Tags","description":"Product Tags"},"status":{"$ref":"#/components/schemas/ContractStatus","description":"Contract Status"},"currency":{"type":"string","title":"Currency","description":"Currency"},"start_date":{"type":"string","format":"date-time","title":"Start Date","description":"Start Date"},"end_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Date","description":"End Date"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"Customer ID"},"anchor_date":{"type":"string","format":"date-time","title":"Anchor Date","description":"Anchor Date"},"is_last_day_of_month":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Last Day Of Month","description":"Is Last Day of Month"},"plan_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Plan Id","description":"Plan ID"},"custom_attributes":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Attributes","description":"Contract Custom Attributes","default":{}},"phases":{"anyOf":[{"items":{"$ref":"#/components/schemas/CreateContractPhaseRequestSchema"},"type":"array"},{"type":"null"}],"title":"Phases","description":"Different Contract Phases","default":[]},"renewal_policy":{"anyOf":[{"$ref":"#/components/schemas/RenewalPolicy"},{"type":"null"}],"description":"Renewal Policy"},"contract_link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contract Link","description":"Contract Link"},"bill_parent_customer":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Bill Parent Customer","description":"Bill Parent Customer","default":false},"invoice_payer_customer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Invoice Payer Customer Id","description":"Invoice Payer Customer Id"},"source":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Source","description":"Source information for the contract"}},"type":"object","required":["name","status","currency","start_date","customer_id"],"title":"CreateContractRequestSchema"},"CreateCreditNoteRequestSchema":{"properties":{"amount":{"type":"integer","title":"Amount","description":"Credit Note Amount"},"credits_returned":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Returned","description":"Credits amount returned"},"refund_amount":{"type":"integer","title":"Refund Amount","description":"Refund Amount (if any) against payments, should be addition of refund amount split","default":0},"currency":{"type":"string","title":"Currency","description":"Currency"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"Customer ID"},"invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Id","description":"Invoice ID"},"status":{"$ref":"#/components/schemas/CreditNoteStatuses","description":"Status"},"credit_note_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credit Note Number","description":"Credit Note Number"},"repayment_method":{"$ref":"#/components/schemas/CreditNoteRepaymentMethods","description":"Repayment Method"},"line_items":{"additionalProperties":true,"type":"object","title":"Line Items","description":"Line Items"},"custom_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Data","description":"Custom Data Dictionary"},"refund_destination":{"anyOf":[{"$ref":"#/components/schemas/RefundDestination"},{"type":"null"}],"description":" "},"refund_amount_split":{"anyOf":[{"items":{"$ref":"#/components/schemas/RefundSplitInPayments"},"type":"array"},{"type":"null"}],"title":"Refund Amount Split","description":"Refund Amount Split"}},"type":"object","required":["amount","currency","customer_id","status","repayment_method","line_items"],"title":"CreateCreditNoteRequestSchema"},"CreateCustomerPaymentMethodsResponseSchema":{"properties":{"connector_id":{"type":"string","format":"uuid","title":"Connector Id","description":"Connector Id"},"connector_name":{"type":"string","title":"Connector Name","description":"Connector Name"},"external_id":{"type":"string","title":"External Id","description":"External Id"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"status"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"country"},"is_default":{"type":"boolean","title":"Is Default","description":"is default payment method"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"payment method type"},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Payment Method Details"},"raw":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw","description":"Payment Method Details"}},"type":"object","required":["connector_id","connector_name","external_id","is_default"],"title":"CreateCustomerPaymentMethodsResponseSchema","description":"Create Customer Response Schema"},"CreateCustomerRequestSchema":{"properties":{"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"Customer ID"},"customer_name":{"type":"string","title":"Customer Name","description":"Customer name"},"custom_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Data","description":"Customer Custom Data","default":{}},"address":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}],"description":"Customer Address"},"ship_to_address":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}],"description":"Customer Ship To Address"},"tax_info":{"anyOf":[{"items":{"$ref":"#/components/schemas/TaxId"},"type":"array"},{"type":"null"}],"title":"Tax Info","description":"Customer Tax Ids","default":[]},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email","description":"Customer primary email address"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number","description":"Customer Phone Number"},"connector":{"anyOf":[{"$ref":"#/components/schemas/app__customer__schema__Connector"},{"type":"null"}]},"communications_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Communications Enabled","description":"To enable/disable communications","default":true},"auto_charge_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Auto Charge Enabled","description":"To enable/disable auto-charge","default":true},"business_entity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Business Entity Id","description":"Business Entity Id"}},"type":"object","title":"CreateCustomerRequestSchema","description":"Create Customer Request Schema"},"CreateDataSourceRequestSchema":{"properties":{"name":{"type":"string","title":"Name","description":"name of the connector"},"connector_type":{"type":"string","title":"Connector Type","description":"Connector type name"},"destination":{"type":"string","title":"Destination","description":"Data source destination"},"status":{"$ref":"#/components/schemas/DataSourceStatusEnum","description":"Status of connector"},"connector_config":{"additionalProperties":true,"type":"object","title":"Connector Config","description":"Contract Updates"},"remote_conn":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Remote Conn","description":"Optional remote connection field","default":false},"source_definition_id":{"type":"string","title":"Source Definition Id","description":"source definition id for connector"}},"type":"object","required":["name","connector_type","destination","status","connector_config","source_definition_id"],"title":"CreateDataSourceRequestSchema","description":"Create DataSource Request Schema"},"CreateEntitlementCustomerRequestSchema":{"properties":{"entitlement":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entitlement","description":"Entitlement ID"},"customer":{"type":"string","title":"Customer","description":"Customer ID"},"expiry_at":{"type":"string","format":"date-time","title":"Expiry At","description":"Entitlement Expiry Time"},"active_from":{"type":"string","format":"date-time","title":"Active From","description":"Entitlement Active From"},"quantity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity","description":"Entitlement Units assigned"},"quantity_used":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity Used","description":"Entitlement Units Consumed"},"contract_id":{"type":"string","title":"Contract Id","description":"Contract ID"},"block_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Block Amount","description":"Block Amount"},"invoice_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Invoice Id","description":"Invoice ID"},"event":{"anyOf":[{"$ref":"#/components/schemas/EntitlementEvent"},{"type":"null"}],"description":"Event","default":"manual"}},"type":"object","required":["customer"],"title":"CreateEntitlementCustomerRequestSchema","description":"Create Entitlement Request Schema"},"CreateEntitlementRequestSchema":{"properties":{"name":{"type":"string","title":"Name","description":"Entitlement name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Entitlement Description"},"entitlement_type":{"anyOf":[{"$ref":"#/components/schemas/EntitlementType"},{"type":"null"}],"description":"Entitlement Type"},"units":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Units","description":"Entitlement Units"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active","description":"Entitlement is active","default":true},"product_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Product Id","description":"Product ID"}},"type":"object","required":["name"],"title":"CreateEntitlementRequestSchema","description":"Create Entitlement Request Schema"},"CreateInvoiceChargeRequestSchema":{"properties":{"connector":{"anyOf":[{"$ref":"#/components/schemas/app__payments__schema__Connector"},{"type":"null"}],"description":"Connector"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source","description":""},"payment_method_types":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Payment Method Types","description":""},"skip_invoice_due_date_check":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Skip Invoice Due Date Check","description":"","default":false}},"type":"object","title":"CreateInvoiceChargeRequestSchema","description":"Create Invoice Charge Request Schema"},"CreatePaymentRequestSchema":{"properties":{"customer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Customer Id","description":" "},"connector_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Connector Id","description":" "},"payment_method":{"anyOf":[{"$ref":"#/components/schemas/PaymentMethodTypes"},{"type":"null"}],"description":" "},"payment_method_details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Payment Method Details","description":" "},"type":{"anyOf":[{"$ref":"#/components/schemas/PaymentTypes"},{"type":"null"}],"description":" "},"amount":{"type":"integer","title":"Amount","description":""},"currency_code":{"type":"string","title":"Currency Code","description":""},"status":{"anyOf":[{"$ref":"#/components/schemas/PaymentStatusTypes"},{"type":"null"}],"description":"Payment Status"},"payment_parts":{"anyOf":[{"items":{"$ref":"#/components/schemas/PaymentPart"},"type":"array"},{"type":"null"}],"title":"Payment Parts","description":"Payment Parts"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"External ID"},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":" "}},"type":"object","required":["amount","currency_code"],"title":"CreatePaymentRequestSchema","description":"Create Payment Request Schema"},"CreatePlanPhasePricingRequestSchema":{"properties":{"schedule":{"$ref":"#/components/schemas/Schedule","description":"Schedule of the product"},"pricing_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Pricing Id","description":"Pricing ID"},"product_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Product Id","description":"Product ID"},"pricing":{"anyOf":[{"$ref":"#/components/schemas/CreateProductPricingRequestSchema"},{"type":"null"}],"description":"Pricing for the phase"},"product":{"anyOf":[{"$ref":"#/components/schemas/CreateProductRequestSchema"},{"type":"null"}],"description":"Product for the phase"}},"type":"object","required":["schedule"],"title":"CreatePlanPhasePricingRequestSchema"},"CreatePlanPhaseRequestSchema":{"properties":{"name":{"type":"string","title":"Name","description":"Plan name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Product Description"},"schedule":{"$ref":"#/components/schemas/Schedule","description":"Schedule of the Phase"},"order":{"type":"integer","title":"Order","description":"Order of the phase"},"features":{"anyOf":[{"$ref":"#/components/schemas/CreateProductPricingRequestSchema"},{"type":"null"}],"description":"Phase Features"},"pricings":{"anyOf":[{"items":{"$ref":"#/components/schemas/CreatePlanPhasePricingRequestSchema"},"type":"array"},{"type":"null"}],"title":"Pricings","description":"Different Product Pricings","default":[]}},"type":"object","required":["name","schedule","order"],"title":"CreatePlanPhaseRequestSchema"},"CreatePlanRequestSchema":{"properties":{"name":{"type":"string","title":"Name","description":"Plan name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Product Description"},"status":{"$ref":"#/components/schemas/PlanStatus","description":"Plan Status"},"schedule":{"$ref":"#/components/schemas/Schedule","description":"Duration of the plan"},"phases":{"anyOf":[{"items":{"$ref":"#/components/schemas/CreatePlanPhaseRequestSchema"},"type":"array"},{"type":"null"}],"title":"Phases","description":"Plan Phases"}},"type":"object","required":["name","status","schedule"],"title":"CreatePlanRequestSchema"},"CreateProductBundlePricingRequestSchema":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Pricing Model Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Pricing Model Description"},"pricing_data":{"oneOf":[{"$ref":"#/components/schemas/MatrixPricing"},{"$ref":"#/components/schemas/CustomTieredPricing"},{"$ref":"#/components/schemas/TwoDimensionalTieredPricing"},{"$ref":"#/components/schemas/PercentPricing"},{"$ref":"#/components/schemas/TieredPricing"},{"$ref":"#/components/schemas/TieredWithFlatFeePricing"},{"$ref":"#/components/schemas/VolumePricing"},{"$ref":"#/components/schemas/VolumeWithFlatFeePricing"},{"$ref":"#/components/schemas/StepPricing"},{"$ref":"#/components/schemas/PackagePricing"},{"$ref":"#/components/schemas/PerUnitPricing"},{"$ref":"#/components/schemas/FlatFee"},{"$ref":"#/components/schemas/FeaturesPricing"},{"$ref":"#/components/schemas/CustomPricing"}],"title":"Pricing Data","description":"Pricing Data","discriminator":{"propertyName":"pricing_type","mapping":{"custom_pricing":"#/components/schemas/CustomPricing","custom_tiered":"#/components/schemas/CustomTieredPricing","features":"#/components/schemas/FeaturesPricing","flat_fee":"#/components/schemas/FlatFee","matrix":"#/components/schemas/MatrixPricing","package":"#/components/schemas/PackagePricing","per_unit":"#/components/schemas/PerUnitPricing","percent":"#/components/schemas/PercentPricing","step":"#/components/schemas/StepPricing","tiered":"#/components/schemas/TieredPricing","tiered_with_flat_fee":"#/components/schemas/TieredWithFlatFeePricing","two_dimensional_tiered":"#/components/schemas/TwoDimensionalTieredPricing","volume":"#/components/schemas/VolumePricing","volume_with_flat_fee":"#/components/schemas/VolumeWithFlatFeePricing"}}},"quantity":{"anyOf":[{"$ref":"#/components/schemas/Quantity"},{"type":"null"}],"description":"Quantity"},"grants":{"anyOf":[{"items":{"$ref":"#/components/schemas/Grant"},"type":"array"},{"type":"null"}],"title":"Grants","description":"Grants","default":[]},"consumptions":{"anyOf":[{"items":{"$ref":"#/components/schemas/Consumption"},"type":"array"},{"type":"null"}],"title":"Consumptions","description":"Consumptions","default":[]},"link_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link Id","description":"Parent Link ID"},"free_units":{"anyOf":[{"items":{"$ref":"#/components/schemas/FreeUnit"},"type":"array"},{"type":"null"}],"title":"Free Units","description":"Free Units","default":[]},"discounts":{"anyOf":[{"items":{"$ref":"#/components/schemas/Discount"},"type":"array"},{"type":"null"}],"title":"Discounts","description":"Discounts","default":[]},"commitments":{"anyOf":[{"items":{"$ref":"#/components/schemas/Commitment"},"type":"array"},{"type":"null"}],"title":"Commitments","description":"Commitments","default":[]},"taxes":{"anyOf":[{"items":{"$ref":"#/components/schemas/Taxes"},"type":"array"},{"type":"null"}],"title":"Taxes","description":"Taxes","default":[]},"payment_terms":{"anyOf":[{"items":{"$ref":"#/components/schemas/PaymentTerms"},"type":"array"},{"type":"null"}],"title":"Payment Terms","description":"Payment Terms","default":[]},"service_fees":{"anyOf":[{"items":{"$ref":"#/components/schemas/ServiceFee"},"type":"array"},{"type":"null"}],"title":"Service Fees","description":"Service Fees","default":[]},"execution_logic":{"anyOf":[{"$ref":"#/components/schemas/ExecutionLogic"},{"type":"null"}],"description":"Execution Logic"},"is_recurring":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Recurring","description":"Is Recurring or not"},"billing_period":{"anyOf":[{"$ref":"#/components/schemas/Period"},{"type":"null"}],"description":"Billing Cadence"},"add_to_catalog":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Add To Catalog","description":"Part of product catalog or not","default":true},"usage_report_configs":{"anyOf":[{"items":{"$ref":"#/components/schemas/CreateProductPricingUsageAssociationRequestSchema"},"type":"array"},{"type":"null"}],"title":"Usage Report Configs","description":"Usage Report Configuration","default":[]},"products":{"items":{"$ref":"#/components/schemas/CreateProductInBundleRequestSchema"},"type":"array","title":"Products","description":"List of Bundled Products"}},"type":"object","required":["pricing_data","products"],"title":"CreateProductBundlePricingRequestSchema"},"CreateProductInBundleRequestSchema":{"properties":{"product_id":{"type":"string","format":"uuid","title":"Product Id","description":"Product ID"},"product_pricing_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Product Pricing Id","description":"Product Pricing ID"},"product_pricing_data":{"anyOf":[{"$ref":"#/components/schemas/CreateProductPricingRequestSchema"},{"type":"null"}],"description":"Product Pricing Data"}},"type":"object","required":["product_id"],"title":"CreateProductInBundleRequestSchema"},"CreateProductPricingRequestSchema":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Pricing Model Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Pricing Model Description"},"pricing_data":{"oneOf":[{"$ref":"#/components/schemas/MatrixPricing"},{"$ref":"#/components/schemas/CustomTieredPricing"},{"$ref":"#/components/schemas/TwoDimensionalTieredPricing"},{"$ref":"#/components/schemas/PercentPricing"},{"$ref":"#/components/schemas/TieredPricing"},{"$ref":"#/components/schemas/TieredWithFlatFeePricing"},{"$ref":"#/components/schemas/VolumePricing"},{"$ref":"#/components/schemas/VolumeWithFlatFeePricing"},{"$ref":"#/components/schemas/StepPricing"},{"$ref":"#/components/schemas/PackagePricing"},{"$ref":"#/components/schemas/PerUnitPricing"},{"$ref":"#/components/schemas/FlatFee"},{"$ref":"#/components/schemas/FeaturesPricing"},{"$ref":"#/components/schemas/CustomPricing"}],"title":"Pricing Data","description":"Pricing Data","discriminator":{"propertyName":"pricing_type","mapping":{"custom_pricing":"#/components/schemas/CustomPricing","custom_tiered":"#/components/schemas/CustomTieredPricing","features":"#/components/schemas/FeaturesPricing","flat_fee":"#/components/schemas/FlatFee","matrix":"#/components/schemas/MatrixPricing","package":"#/components/schemas/PackagePricing","per_unit":"#/components/schemas/PerUnitPricing","percent":"#/components/schemas/PercentPricing","step":"#/components/schemas/StepPricing","tiered":"#/components/schemas/TieredPricing","tiered_with_flat_fee":"#/components/schemas/TieredWithFlatFeePricing","two_dimensional_tiered":"#/components/schemas/TwoDimensionalTieredPricing","volume":"#/components/schemas/VolumePricing","volume_with_flat_fee":"#/components/schemas/VolumeWithFlatFeePricing"}}},"quantity":{"anyOf":[{"$ref":"#/components/schemas/Quantity"},{"type":"null"}],"description":"Quantity"},"grants":{"anyOf":[{"items":{"$ref":"#/components/schemas/Grant"},"type":"array"},{"type":"null"}],"title":"Grants","description":"Grants","default":[]},"consumptions":{"anyOf":[{"items":{"$ref":"#/components/schemas/Consumption"},"type":"array"},{"type":"null"}],"title":"Consumptions","description":"Consumptions","default":[]},"link_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link Id","description":"Parent Link ID"},"free_units":{"anyOf":[{"items":{"$ref":"#/components/schemas/FreeUnit"},"type":"array"},{"type":"null"}],"title":"Free Units","description":"Free Units","default":[]},"discounts":{"anyOf":[{"items":{"$ref":"#/components/schemas/Discount"},"type":"array"},{"type":"null"}],"title":"Discounts","description":"Discounts","default":[]},"commitments":{"anyOf":[{"items":{"$ref":"#/components/schemas/Commitment"},"type":"array"},{"type":"null"}],"title":"Commitments","description":"Commitments","default":[]},"taxes":{"anyOf":[{"items":{"$ref":"#/components/schemas/Taxes"},"type":"array"},{"type":"null"}],"title":"Taxes","description":"Taxes","default":[]},"payment_terms":{"anyOf":[{"items":{"$ref":"#/components/schemas/PaymentTerms"},"type":"array"},{"type":"null"}],"title":"Payment Terms","description":"Payment Terms","default":[]},"service_fees":{"anyOf":[{"items":{"$ref":"#/components/schemas/ServiceFee"},"type":"array"},{"type":"null"}],"title":"Service Fees","description":"Service Fees","default":[]},"execution_logic":{"anyOf":[{"$ref":"#/components/schemas/ExecutionLogic"},{"type":"null"}],"description":"Execution Logic"},"is_recurring":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Recurring","description":"Is Recurring or not"},"billing_period":{"anyOf":[{"$ref":"#/components/schemas/Period"},{"type":"null"}],"description":"Billing Cadence"},"add_to_catalog":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Add To Catalog","description":"Part of product catalog or not","default":true},"usage_report_configs":{"anyOf":[{"items":{"$ref":"#/components/schemas/CreateProductPricingUsageAssociationRequestSchema"},"type":"array"},{"type":"null"}],"title":"Usage Report Configs","description":"Usage Report Configuration","default":[]}},"type":"object","required":["pricing_data"],"title":"CreateProductPricingRequestSchema"},"CreateProductPricingUsageAssociationRequestSchema":{"properties":{"aggregate_id":{"type":"string","format":"uuid","title":"Aggregate Id","description":"Aggregate ID"},"config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Config","description":"Usage Report Configuration","default":{}},"is_default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Default","description":"Is Default or not","default":false}},"type":"object","required":["aggregate_id"],"title":"CreateProductPricingUsageAssociationRequestSchema"},"CreateProductRequestSchema":{"properties":{"name":{"type":"string","title":"Name","description":"Product name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Product Description"},"tags":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Tags","description":"Product Tags"},"sku":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sku","description":"Product SKU"},"parent_link_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Link Id","description":"Parent Link ID"},"tax_codes":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Tax Codes","description":"Product Tax Codes"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active","description":"Is Active or not"},"type":{"$ref":"#/components/schemas/ProductTypeV2","description":"Product Type"},"default_pricing_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Default Pricing Id","description":"Default Pricing ID"},"custom_attributes":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Attributes","description":"Custom Attributes","default":{}}},"type":"object","required":["name","type"],"title":"CreateProductRequestSchema"},"CreateRawMetricRequestSchema":{"properties":{"name":{"type":"string","title":"Name","description":"name of the rawmetric"},"api_slug":{"type":"string","title":"Api Slug","description":"rawmetric slug name"},"dataschema":{"additionalProperties":true,"type":"object","title":"Dataschema","description":"Data schema of raw metric"},"column_order":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Column Order","description":"Order of the columns in the raw metric table"}},"type":"object","required":["name","api_slug","dataschema"],"title":"CreateRawMetricRequestSchema","description":"Create RawMetric Request Schema"},"CreateRefundRequestSchema":{"properties":{"connector":{"anyOf":[{"$ref":"#/components/schemas/app__payments__schema__Connector"},{"type":"null"}],"description":"Connector"},"refund_payment_part_amounts":{"anyOf":[{"items":{"$ref":"#/components/schemas/PaymentPart"},"type":"array"},{"type":"null"}],"title":"Refund Payment Part Amounts","description":"Payment Parts"},"refund_amount":{"type":"integer","title":"Refund Amount","description":"Total Refund Amount","default":0},"refund_destination":{"$ref":"#/components/schemas/RefundDestination","description":" "},"writeoff_invoices":{"type":"boolean","title":"Writeoff Invoices","description":" "},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":" "},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":" "}},"type":"object","required":["refund_destination","writeoff_invoices"],"title":"CreateRefundRequestSchema","description":"Create Refund Request Schema"},"CreditNoteRepaymentMethods":{"type":"string","enum":["credits","invoice_adjusted","external_payment","credits_against_payment","original_payment_method"],"title":"CreditNoteRepaymentMethods"},"CreditNoteResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"ID"},"amount":{"type":"integer","title":"Amount","description":"Amount"},"credits_returned":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Returned","description":"Credits amount"},"currency":{"type":"string","title":"Currency","description":"Currency"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"Customer ID"},"customer":{"anyOf":[{"$ref":"#/components/schemas/app__invoice__schema__DetailsObject"},{"type":"null"}],"description":"Customer Object"},"invoice":{"anyOf":[{"$ref":"#/components/schemas/app__invoice__schema__DetailsObject"},{"type":"null"}],"description":"Invoice Object"},"invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Id","description":"Invoice ID"},"status":{"$ref":"#/components/schemas/CreditNoteStatuses","description":"Status"},"repayment_method":{"$ref":"#/components/schemas/CreditNoteRepaymentMethods","description":"Repayment Method"},"line_items_url":{"type":"string","title":"Line Items Url","description":"Line Items URL"},"custom_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Data","description":"Custom Data Dictionary"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Created At"},"credit_note_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credit Note Number","description":"Credit Note Number"}},"type":"object","required":["id","amount","currency","customer_id","status","repayment_method","line_items_url","created_at"],"title":"CreditNoteResponseSchema"},"CreditNoteStatuses":{"type":"string","enum":["in_progress","issued","void","paid"],"title":"CreditNoteStatuses"},"CustomAttributeDefinitionCreate":{"properties":{"attribute_key_name":{"type":"string","minLength":1,"title":"Attribute Key Name","description":"A unique system identifier for the attribute (e.g., customer_tier, internal_notes)."},"display_name":{"type":"string","minLength":1,"title":"Display Name","description":"A user-friendly label for the attribute shown in the UI."},"module":{"$ref":"#/components/schemas/ModuleEnum","description":"The module this custom attribute belongs to (e.g., customer, products, contracts)."},"data_type":{"$ref":"#/components/schemas/DataTypeEnum","description":"The type of data the attribute will store."},"business_entity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Business Entity Id","description":"If populated, this definition is an entity-specific addition or override."},"is_tag":{"type":"boolean","title":"Is Tag","description":"If TRUE, this attribute is a Tag. Tags must have data_type = ENUM.","default":false},"enum_choices":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Enum Choices","description":"If data_type is ENUM, this stores the list of valid string choices."},"default_value":{"anyOf":[{},{"type":"null"}],"title":"Default Value","description":"An optional default value for the attribute. Must conform to data_type and be one of enum_choices if applicable."},"is_required":{"type":"boolean","title":"Is Required","description":"Indicates if a value is mandatory for this attribute.","default":false},"is_enabled":{"type":"boolean","title":"Is Enabled","description":"Whether the attribute definition is currently active.","default":true},"sort_order":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sort Order","description":"Optional: for controlling display order in UIs."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Optional: further description or help text for the attribute."}},"type":"object","required":["attribute_key_name","display_name","module","data_type"],"title":"CustomAttributeDefinitionCreate"},"CustomAttributeDefinitionResponse":{"properties":{"attribute_key_name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Attribute Key Name","description":"A unique system identifier for the attribute (e.g., customer_tier, internal_notes)."},"display_name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Display Name","description":"A user-friendly label for the attribute shown in the UI."},"module":{"anyOf":[{"$ref":"#/components/schemas/ModuleEnum"},{"type":"null"}],"description":"The module this custom attribute belongs to (e.g., customer, products, contracts)."},"data_type":{"anyOf":[{"$ref":"#/components/schemas/DataTypeEnum"},{"type":"null"}],"description":"The type of data the attribute will store."},"business_entity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Business Entity Id","description":"If populated, this definition is an entity-specific addition or override."},"is_tag":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Tag","description":"If TRUE, this attribute is a Tag. Tags must have data_type = ENUM."},"enum_choices":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Enum Choices","description":"If data_type is ENUM, this stores the list of valid string choices."},"default_value":{"anyOf":[{},{"type":"null"}],"title":"Default Value","description":"An optional default value for the attribute. Must conform to data_type and be one of enum_choices if applicable."},"is_required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Required","description":"Indicates if a value is mandatory for this attribute."},"is_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Enabled","description":"Whether the attribute definition is currently active."},"sort_order":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sort Order","description":"Optional: for controlling display order in UIs."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Optional: further description or help text for the attribute."},"id":{"type":"string","format":"uuid","title":"Id"},"organisation_id":{"type":"string","format":"uuid","title":"Organisation Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"business_entity":{"anyOf":[{"$ref":"#/components/schemas/BusinessEntityResponseSchema"},{"type":"null"}]}},"type":"object","required":["id","organisation_id","created_at","updated_at"],"title":"CustomAttributeDefinitionResponse"},"CustomAttributeDefinitionUpdate":{"properties":{"attribute_key_name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Attribute Key Name","description":"A unique system identifier for the attribute (e.g., customer_tier, internal_notes)."},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name","description":"A user-friendly label for the attribute shown in the UI."},"module":{"anyOf":[{"$ref":"#/components/schemas/ModuleEnum"},{"type":"null"}],"description":"The module this custom attribute belongs to (e.g., customer, products, contracts)."},"data_type":{"anyOf":[{"$ref":"#/components/schemas/DataTypeEnum"},{"type":"null"}],"description":"The type of data the attribute will store."},"business_entity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Business Entity Id","description":"If populated, this definition is an entity-specific addition or override."},"is_tag":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Tag","description":"If TRUE, this attribute is a Tag. Tags must have data_type = ENUM."},"enum_choices":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Enum Choices","description":"If data_type is ENUM, this stores the list of valid string choices."},"default_value":{"anyOf":[{},{"type":"null"}],"title":"Default Value","description":"An optional default value for the attribute. Must conform to data_type and be one of enum_choices if applicable."},"is_required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Required","description":"Indicates if a value is mandatory for this attribute."},"is_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Enabled","description":"Whether the attribute definition is currently active."},"sort_order":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sort Order","description":"Optional: for controlling display order in UIs."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Optional: further description or help text for the attribute."}},"type":"object","title":"CustomAttributeDefinitionUpdate"},"CustomPricing":{"properties":{"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"},"pricing_period":{"anyOf":[{"$ref":"#/components/schemas/PeriodCadence"},{"type":"null"}]},"unit_amount":{"anyOf":[{"type":"number"},{"$ref":"#/components/schemas/EdgeInput"},{"type":"null"}],"title":"Unit Amount"},"custom_pricing":{"additionalProperties":true,"type":"object","title":"Custom Pricing"},"pricing_type":{"type":"string","const":"custom_pricing","title":"Pricing Type"},"custom_py_script_location":{"type":"string","title":"Custom Py Script Location"}},"type":"object","required":["custom_pricing","pricing_type","custom_py_script_location"],"title":"CustomPricing"},"CustomTieredPricing":{"properties":{"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"},"pricing_period":{"anyOf":[{"$ref":"#/components/schemas/PeriodCadence"},{"type":"null"}]},"unit_amount":{"anyOf":[{"items":{"type":"number","minimum":0.0},"type":"array"},{"$ref":"#/components/schemas/EdgeInput"}],"title":"Unit Amount"},"up_to":{"anyOf":[{"items":{"type":"number","minimum":0.0},"type":"array"},{"$ref":"#/components/schemas/EdgeInput"}],"title":"Up To"},"tier_type":{"items":{"type":"string","enum":["package","per_unit"]},"type":"array","title":"Tier Type"},"flat_fee":{"anyOf":[{"items":{"type":"number","minimum":0.0},"type":"array"},{"$ref":"#/components/schemas/EdgeInput"}],"title":"Flat Fee"},"package_sizes":{"anyOf":[{"items":{"type":"number","minimum":0.0},"type":"array"},{"$ref":"#/components/schemas/EdgeInput"}],"title":"Package Sizes"},"pricing_type":{"type":"string","const":"custom_tiered","title":"Pricing Type"},"model_type":{"type":"string","enum":["tiered","volume"],"title":"Model Type"}},"type":"object","required":["unit_amount","up_to","tier_type","flat_fee","package_sizes","pricing_type","model_type"],"title":"CustomTieredPricing"},"CustomerPaymentMethodsResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Customer Id"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"Customer Id"},"organisation_id":{"type":"string","format":"uuid","title":"Organisation Id","description":"Organisation Id"},"connector_id":{"type":"string","format":"uuid","title":"Connector Id","description":"Connector Id"},"connector_name":{"type":"string","title":"Connector Name","description":"Connector Name"},"external_id":{"type":"string","title":"External Id","description":"External Id"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"status"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"country"},"is_default":{"type":"boolean","title":"Is Default","description":"is default payment method"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"payment method type"},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Payment Method Details"}},"type":"object","required":["id","customer_id","organisation_id","connector_id","connector_name","external_id","is_default"],"title":"CustomerPaymentMethodsResponseSchema","description":"Create Customer Response Schema"},"CustomerResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Customer Id"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"External Customer Id"},"customer_name":{"type":"string","title":"Customer Name","description":"Customer name"},"custom_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Data","description":"Customer Custom Data"},"address":{"anyOf":[{"$ref":"#/components/schemas/AddressResponse"},{"type":"null"}],"description":"Customer Address"},"ship_to_address":{"anyOf":[{"$ref":"#/components/schemas/AddressResponse"},{"type":"null"}],"description":"Customer Ship To Address"},"tax_info":{"anyOf":[{"items":{"$ref":"#/components/schemas/TaxId"},"type":"array"},{"type":"null"}],"title":"Tax Info","description":"Customer Tax Ids","default":[]},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Customer primary email address"},"custom_attributes":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Attributes","description":"Customer Tags"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number","description":"Customer Phone Number"},"communications_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Communications Enabled","description":"To enable/disable communications","default":true},"auto_charge_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Auto Charge Enabled","description":"To enable/disable auto-charge","default":true},"business_entity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Business Entity Id","description":"Business Entity Id"}},"type":"object","required":["id","external_id","customer_name","custom_data","address"],"title":"CustomerResponseSchema","description":"Create Customer Response Schema"},"DataSourceResponseSchema":{"properties":{"datasource":{"$ref":"#/components/schemas/DataSourceSchema","description":"Data source"},"connection":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Connection","description":"Connection"}},"type":"object","required":["datasource"],"title":"DataSourceResponseSchema","description":"Data source Response Schema"},"DataSourceSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Data source Id"},"name":{"type":"string","title":"Name","description":"name of the connector"},"connector_type":{"type":"string","title":"Connector Type","description":"Connector type name"},"destination":{"type":"string","title":"Destination","description":"Data source destination"},"status":{"$ref":"#/components/schemas/DataSourceStatusEnum","description":"Status of connector"},"remote_conn":{"type":"boolean","title":"Remote Conn","description":"Optional remote connection field"}},"type":"object","required":["id","name","connector_type","destination","status","remote_conn"],"title":"DataSourceSchema","description":"Data source Response Schema"},"DataSourceStatusEnum":{"type":"string","enum":["active","disabled","processing","failed"],"title":"DataSourceStatusEnum"},"DataTypeEnum":{"type":"string","enum":["STRING","INTEGER","FLOAT","BOOLEAN","LIST_STRING","ENUM","JSON","DATE"],"title":"DataTypeEnum"},"DeleteConnectorForCustomerResponseSchema":{"properties":{"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"},"reference_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Id"},"resource_mapping_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resource Mapping Id"},"connector_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Connector Id"},"payment_methods":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Payment Methods","description":"Deleted payment methods of the customer","default":[]},"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"DeleteConnectorForCustomerResponseSchema"},"DeleteContactResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Contact Id"},"message":{"type":"string","title":"Message","description":"Message"}},"type":"object","required":["id","message"],"title":"DeleteContactResponseSchema","description":"Delete Contact Response Schema"},"DeleteCustomerResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Customer Id"},"message":{"type":"string","title":"Message","description":"Message"}},"type":"object","required":["id","message"],"title":"DeleteCustomerResponseSchema","description":"Delete Customer Response Schema"},"DeleteEntitlementResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Entitlement Id"},"message":{"type":"string","title":"Message","description":"Message"}},"type":"object","required":["id","message"],"title":"DeleteEntitlementResponseSchema","description":"Delete Entitlement Response Schema"},"DeleteProductResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Product Id"},"message":{"type":"string","title":"Message","description":"Message"}},"type":"object","required":["id","message"],"title":"DeleteProductResponseSchema","description":"Delete Product Response Schema"},"Dimension":{"properties":{"name":{"type":"string","title":"Name"},"column_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Column Name"}},"type":"object","required":["name"],"title":"Dimension"},"Discount":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Feature ID"},"identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Identifier","description":"Unique identifier for the feature in the pricing instance"},"priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Priority","description":"Priority of the feature, features get applied in ascending order of priority"},"type":{"$ref":"#/components/schemas/DiscountType"},"unit_amount":{"anyOf":[{"type":"number"},{"$ref":"#/components/schemas/EdgeInput"}],"title":"Unit Amount"},"pricing_period":{"anyOf":[{"$ref":"#/components/schemas/PeriodCadence"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"}},"type":"object","required":["type","unit_amount"],"title":"Discount"},"DiscountType":{"type":"string","enum":["fixed","percent","quantity"],"title":"DiscountType"},"EdgeInput":{"properties":{"step_name":{"type":"string","title":"Step Name","description":"Step name"},"output_field":{"type":"string","title":"Output Field","description":"Output field"}},"type":"object","required":["step_name","output_field"],"title":"EdgeInput","description":"Represents an input that comes from another node's output"},"EditPauseContractRequestSchema":{"properties":{"start_date":{"type":"string","format":"date-time","title":"Start Date","description":"Start Date"},"end_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Date","description":"End Date"},"pause_phase_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Pause Phase Id","description":"Pause Phase ID"},"unpause_extension_policy":{"anyOf":[{"$ref":"#/components/schemas/UnpauseExtensionPolicy"},{"type":"null"}],"description":"Unpause Extension Policy"}},"type":"object","required":["start_date"],"title":"EditPauseContractRequestSchema"},"EntitlementCustomerResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Entitlement Customer Row Id"},"entitlement":{"type":"string","format":"uuid","title":"Entitlement","description":"Entitlement ID"},"name":{"type":"string","title":"Name","description":"Entitlement Name"},"type":{"anyOf":[{"$ref":"#/components/schemas/EntitlementType"},{"type":"null"}],"description":"Entitlement Type"},"units":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Units","description":"Entitlement units"},"customer":{"anyOf":[{"type":"string","format":"uuid"},{"$ref":"#/components/schemas/app__entitlements__schema__DetailsObject"}],"title":"Customer","description":"Customer ID"},"contract":{"anyOf":[{"$ref":"#/components/schemas/app__entitlements__schema__DetailsObject"},{"type":"null"}],"description":"Contract Details"},"product":{"anyOf":[{"$ref":"#/components/schemas/app__entitlements__schema__DetailsObject"},{"type":"null"}],"description":"Product Details"},"active_from":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Active From","description":"Entitlement Active From"},"expiry_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expiry At","description":"Entitlement Expiry Time"},"quantity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity","description":"Entitlement Units assigned"},"quantity_used":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity Used","description":"Entitlement Units Consumed"},"quantity_remaining":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity Remaining","description":"Entitlement Units Remaining"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At","description":"created time"},"contract_id":{"type":"string","title":"Contract Id","description":"Contract ID"},"event":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Event","description":"Event"},"invoice_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Invoice Id","description":"Source ID"}},"type":"object","required":["id","entitlement","name","units","customer"],"title":"EntitlementCustomerResponseSchema","description":"Create Entitlement Customer Request Schema"},"EntitlementCustomerSumResponseSchema":{"properties":{"entitlement":{"$ref":"#/components/schemas/EntitlementResponseSchema","description":"Entitlement ID"},"total_quantity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Quantity","description":"Total Entitlement Units assigned"},"total_quantity_used":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Quantity Used","description":"Total Entitlement Units Consumed"},"total_expired_entitlements":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Expired Entitlements","description":"Total Expired Entitlements"}},"type":"object","required":["entitlement"],"title":"EntitlementCustomerSumResponseSchema","description":"Create Entitlement Customer Sum Request Schema"},"EntitlementEvent":{"type":"string","enum":["manual","invoice","payment"],"title":"EntitlementEvent"},"EntitlementResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Entitlement Id"},"name":{"type":"string","title":"Name","description":"Entitlement name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Entitlement Description"},"entitlement_type":{"anyOf":[{"$ref":"#/components/schemas/EntitlementType"},{"type":"null"}],"description":"Entitlement Type"},"units":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Units","description":"Entitlement Units"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active","description":"Entitlement is active","default":true},"product_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Product Id","description":"Product ID"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At","description":"created time"}},"type":"object","required":["id","name"],"title":"EntitlementResponseSchema","description":"Create Entitlement Response Schema"},"EntitlementType":{"type":"string","enum":["Feature","Quantity","Credits"],"title":"EntitlementType"},"EntityAddress":{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"Line 1"},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Line 2"},"line3":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line3","description":"Line 3"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State"},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Zip Code"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country"},"validation_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Validation Status","description":"Address Validation Status"}},"type":"object","title":"EntityAddress","description":"Address Schema"},"EstimateValue":{"properties":{"fields":{"items":{"$ref":"#/components/schemas/EstimateValueObject"},"type":"array","title":"Fields"}},"type":"object","required":["fields"],"title":"EstimateValue"},"EstimateValueObject":{"properties":{"dimension":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dimension","description":"Dimension of the quantity"},"quantity":{"type":"number","title":"Quantity","description":"Quantity of the dimension"}},"type":"object","required":["quantity"],"title":"EstimateValueObject"},"Executable-Input":{"properties":{"node_type":{"type":"string","title":"Node Type","description":"node type"},"node_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Node Name","description":"node name in the workflow"},"node_data":{"additionalProperties":true,"type":"object","title":"Node Data","description":"execution data for the node"},"billing_period":{"anyOf":[{"$ref":"#/components/schemas/BillingPeriod"},{"type":"null"}],"description":"billing period"}},"type":"object","required":["node_type","node_data"],"title":"Executable"},"Executable-Output":{"properties":{"node_type":{"type":"string","title":"Node Type","description":"node type"},"node_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Node Name","description":"node name in the workflow"},"node_data":{"additionalProperties":true,"type":"object","title":"Node Data","description":"execution data for the node"},"billing_period":{"anyOf":[{"$ref":"#/components/schemas/BillingPeriod"},{"type":"null"}],"description":"billing period"}},"type":"object","required":["node_type","node_data"],"title":"Executable"},"ExecutionLogic":{"properties":{"additional_steps":{"items":{"$ref":"#/components/schemas/ExecutionStep"},"type":"array","title":"Additional Steps","description":"Additional nodes to add to the workflow"}},"type":"object","title":"ExecutionLogic","description":"Defines custom execution logic for a pricing instance"},"ExecutionStep":{"properties":{"node_type":{"type":"string","title":"Node Type","description":"Node type"},"inputs":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Inputs","description":"Additional inputs for the node"},"step_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Step Name","description":"Step name"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"Step ID"}},"type":"object","required":["node_type"],"title":"ExecutionStep","description":"Represents a custom execution step to be added to the workflow"},"FeaturesPricing":{"properties":{"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"},"pricing_period":{"anyOf":[{"$ref":"#/components/schemas/PeriodCadence"},{"type":"null"}]},"unit_amount":{"anyOf":[{"type":"number"},{"$ref":"#/components/schemas/EdgeInput"},{"type":"null"}],"title":"Unit Amount"},"pricing_type":{"type":"string","const":"features","title":"Pricing Type"}},"type":"object","required":["pricing_type"],"title":"FeaturesPricing"},"FlatFee":{"properties":{"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"},"pricing_period":{"anyOf":[{"$ref":"#/components/schemas/PeriodCadence"},{"type":"null"}]},"unit_amount":{"anyOf":[{"type":"number"},{"$ref":"#/components/schemas/EdgeInput"}],"title":"Unit Amount"},"pricing_type":{"type":"string","const":"flat_fee","title":"Pricing Type"},"charge_full_amount":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Charge Full Amount","description":"Always charge full amount or not (proration is not allowed)"}},"type":"object","required":["unit_amount","pricing_type"],"title":"FlatFee"},"FreeUnit":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Feature ID"},"identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Identifier","description":"Unique identifier for the feature in the pricing instance"},"priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Priority","description":"Priority of the feature, features get applied in ascending order of priority"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"unit_amount":{"anyOf":[{"type":"number"},{"$ref":"#/components/schemas/EdgeInput"}],"title":"Unit Amount"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"},"period":{"anyOf":[{"$ref":"#/components/schemas/PeriodCadence"},{"type":"null"}]}},"type":"object","required":["unit_amount"],"title":"FreeUnit"},"GetAccountsRequestSchema":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"},"search_query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Query"},"connector":{"$ref":"#/components/schemas/app__accounting__schema__Connector"},"search":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},"type":"object","required":["connector"],"title":"GetAccountsRequestSchema"},"GetAggregateResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"aggregate Id"},"name":{"type":"string","title":"Name","description":"name of the aggregate"},"dataschema":{"type":"string","title":"Dataschema","description":"data schema of aggregate"},"aggregation_query":{"type":"string","title":"Aggregation Query","description":"aggregate query"},"cust_agg_query":{"type":"string","title":"Cust Agg Query","description":"customer aggregate query"},"visual_query_builder":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Visual Query Builder","description":"visual query builder"},"datasource":{"type":"string","format":"uuid","title":"Datasource","description":"data source uuid"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At","description":"Created_at"}},"type":"object","required":["id","name","dataschema","aggregation_query","cust_agg_query","visual_query_builder","datasource"],"title":"GetAggregateResponseSchema","description":"Aggregate Response Schema"},"GetBalanceSheetRequestSchema":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"},"search_query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Query"},"connector":{"$ref":"#/components/schemas/app__accounting__schema__Connector"}},"type":"object","required":["connector"],"title":"GetBalanceSheetRequestSchema"},"GetCustomerResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Customer ID"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"External Customer Id"},"customer_name":{"type":"string","title":"Customer Name","description":"Customer name"},"custom_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Data","description":"Customer Custom Data"},"address":{"anyOf":[{"$ref":"#/components/schemas/AddressResponse"},{"type":"null"}],"description":"Customer address"},"ship_to_address":{"anyOf":[{"$ref":"#/components/schemas/AddressResponse"},{"type":"null"}],"description":"Customer Ship To address"},"tax_info":{"anyOf":[{"items":{"$ref":"#/components/schemas/TaxId"},"type":"array"},{"type":"null"}],"title":"Tax Info","description":"Customer Tax Ids","default":[]},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number","description":"Customer Phone Number"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Customer primary email address"},"contacts":{"anyOf":[{"items":{"$ref":"#/components/schemas/ContactResponseSchema"},"type":"array"},{"type":"null"}],"title":"Contacts","description":"List of associated contacts"},"custom_attributes":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Attributes","description":"Customer Tags"},"communications_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Communications Enabled","description":"To enable/disable communications","default":true},"auto_charge_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Auto Charge Enabled","description":"To enable/disable auto-charge","default":true},"invoice_details":{"anyOf":[{"$ref":"#/components/schemas/InvoiceDetailsObject"},{"type":"null"}],"description":"Invoice Details Object"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At","description":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Updated At"},"default_payment_method":{"anyOf":[{"$ref":"#/components/schemas/CustomerPaymentMethodsResponseSchema"},{"type":"null"}],"description":"default_payment_method"},"business_entity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Business Entity Id","description":"Business Entity Id"},"business_entity":{"anyOf":[{"$ref":"#/components/schemas/BusinessEntityResponseSchema"},{"type":"null"}],"description":"Business Entity"}},"type":"object","required":["id","external_id","customer_name","custom_data","address"],"title":"GetCustomerResponseSchema","description":"Create Customer Response Schema"},"GetRawMetricResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"RawMetric Id"},"name":{"type":"string","title":"Name","description":"name of the raw metric"},"api_slug":{"type":"string","title":"Api Slug","description":"api slug raw metric name"},"dataschema":{"additionalProperties":true,"type":"object","title":"Dataschema","description":"Data schema raw metric"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At","description":"Created_at"}},"type":"object","required":["id","name","api_slug","dataschema"],"title":"GetRawMetricResponseSchema","description":"RawMetric Response Schema"},"GetTransactionsRequestSchema":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor"},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit","description":"Limit"},"search_query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Query"},"connector":{"$ref":"#/components/schemas/app__accounting__schema__Connector"},"sort_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort Key","examples":["sort_key=id"]},"sort_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort Type","examples":["sort_key=asc"]},"customer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Customer Id","description":"Customer ID"},"system_account_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"System Account Name","description":"System Account Name like"},"migrated":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Migrated","description":"Migrated"}},"type":"object","required":["connector"],"title":"GetTransactionsRequestSchema"},"Grant":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Feature ID"},"identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Identifier","description":"Unique identifier for the feature in the pricing instance"},"priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Priority","description":"Priority of the feature, features get applied in ascending order of priority"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"unit_amount":{"anyOf":[{"type":"number"},{"$ref":"#/components/schemas/EdgeInput"}],"title":"Unit Amount"},"entitlement_id":{"type":"string","format":"uuid","title":"Entitlement Id"},"trigger_event":{"anyOf":[{"$ref":"#/components/schemas/GrantTriggerEvent"},{"type":"null"}],"description":"","default":"invoice_approval"},"type":{"$ref":"#/components/schemas/EntitlementType"},"expires_at":{"anyOf":[{"$ref":"#/components/schemas/GrantExpirationType"},{"type":"null"}],"default":"end_of_product_billing_period"},"expiry_period":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Expiry Period","description":""},"grant_frequency_same_as_product":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Grant Frequency Same As Product","description":"Grant frequency same as product billing period","default":true},"grant_period":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grant Period","description":""},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"},"period":{"anyOf":[{"$ref":"#/components/schemas/PeriodCadence"},{"type":"null"}]}},"type":"object","required":["unit_amount","entitlement_id","type"],"title":"Grant","description":"TODO:\nThis doesn't consider the event when it should be granted for now its just period\nBut it will be on payment success , on contract creation, Phase start, or when a product is added to a contract etc\nThis also needs to take into account of expiry"},"GrantExpirationType":{"type":"string","enum":["never","end_of_contract_date","end_of_product_date","end_of_phase_date","end_of_product_billing_period","custom"],"title":"GrantExpirationType"},"GrantResponse":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Feature ID"},"identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Identifier","description":"Unique identifier for the feature in the pricing instance"},"priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Priority","description":"Priority of the feature, features get applied in ascending order of priority"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"unit_amount":{"anyOf":[{"type":"number"},{"$ref":"#/components/schemas/EdgeInput"}],"title":"Unit Amount"},"entitlement_id":{"type":"string","format":"uuid","title":"Entitlement Id"},"trigger_event":{"anyOf":[{"$ref":"#/components/schemas/GrantTriggerEvent"},{"type":"null"}],"description":"","default":"invoice_approval"},"type":{"$ref":"#/components/schemas/EntitlementType"},"expires_at":{"anyOf":[{"$ref":"#/components/schemas/GrantExpirationType"},{"type":"null"}],"default":"end_of_product_billing_period"},"expiry_period":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Expiry Period","description":""},"grant_frequency_same_as_product":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Grant Frequency Same As Product","description":"Grant frequency same as product billing period","default":true},"grant_period":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grant Period","description":""},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"},"period":{"anyOf":[{"$ref":"#/components/schemas/PeriodCadence"},{"type":"null"}]},"entitlement":{"anyOf":[{"$ref":"#/components/schemas/EntitlementResponseSchema"},{"type":"null"}]}},"type":"object","required":["unit_amount","entitlement_id","type"],"title":"GrantResponse"},"GrantTriggerEvent":{"type":"string","enum":["payment_success","invoice_creation","invoice_approval"],"title":"GrantTriggerEvent"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"InvoiceAmounts":{"properties":{"invoice_id":{"type":"string","format":"uuid","title":"Invoice Id","description":"Invoice ID"},"payment_id":{"type":"string","format":"uuid","title":"Payment Id","description":"Payment ID"},"amount":{"type":"string","title":"Amount","description":"Amount"},"amount_refunded":{"type":"string","title":"Amount Refunded","description":"Amount Refunded"},"currency_code":{"type":"string","title":"Currency Code","description":"Currency Code"},"invoice_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Number","description":"Invoice Number"},"status":{"anyOf":[{"$ref":"#/components/schemas/InvoiceStatus"},{"type":"null"}],"description":"Invoice Status"},"invoice_total":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Total","description":"Invoice Total"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At","description":"Created At"}},"type":"object","required":["invoice_id","payment_id","amount","amount_refunded","currency_code"],"title":"InvoiceAmounts","description":"Payment part"},"InvoiceDetailsObject":{"properties":{"no_of_invoices":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"No Of Invoices"},"total_amount_due":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Amount Due"}},"type":"object","title":"InvoiceDetailsObject"},"InvoiceStatus":{"type":"string","enum":["draft","approved","edited","discarded","paid","void","partially_paid","upcoming"],"title":"InvoiceStatus","description":"When adding a new status make sure the following files are also modified appropriately\n    * serverless-backend/zenskar_shared/models/invoices.py"},"JobResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Job Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Job name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Job Description"},"job_type":{"anyOf":[{"$ref":"#/components/schemas/JobType"},{"type":"null"}],"description":"Job Type Manual/Automated"},"job_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Job Data","description":"Job Data"},"status":{"$ref":"#/components/schemas/JobStatus","description":"Job status"},"resource":{"$ref":"#/components/schemas/Resource","description":"Job Resource"},"file_path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Path","description":"Job file download url"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At","description":"Job Created dated"},"output_log":{"anyOf":[{"$ref":"#/components/schemas/OutputLog"},{"type":"null"}],"description":"Job Outcomes Result"},"execution_params":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Execution Params","description":"Job Execution Params"}},"type":"object","required":["id","status","resource"],"title":"JobResponseSchema","description":"Create Job Response Schema"},"JobStatus":{"type":"string","enum":["pending","in_progress","success","partial_success","failed"],"title":"JobStatus"},"JobType":{"type":"string","enum":["manual","automated"],"title":"JobType"},"MatrixPricing":{"properties":{"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"},"pricing_period":{"anyOf":[{"$ref":"#/components/schemas/PeriodCadence"},{"type":"null"}]},"unit_amount":{"anyOf":[{"type":"number"},{"$ref":"#/components/schemas/EdgeInput"}],"title":"Unit Amount"},"dimensions":{"items":{"$ref":"#/components/schemas/Dimension"},"type":"array","title":"Dimensions"},"prices":{"anyOf":[{"items":{"anyOf":[{"type":"number","minimum":0.0},{"type":"null"}]},"type":"array"},{"$ref":"#/components/schemas/EdgeInput"}],"title":"Prices"},"display_alias":{"items":{"type":"string"},"type":"array","title":"Display Alias"},"pricing_type":{"type":"string","const":"matrix","title":"Pricing Type"}},"type":"object","required":["unit_amount","dimensions","prices","display_alias","pricing_type"],"title":"MatrixPricing"},"ModuleEnum":{"type":"string","enum":["customers","products","contracts","plans","invoices","payments"],"title":"ModuleEnum"},"OutputLog":{"properties":{"failure_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Failure Count","description":"Failure Count","default":0},"skipped_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Skipped Count","description":"Skipped Count","default":0},"success_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Success Count","description":"Success Count","default":0},"total_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Count","description":"Total Count","default":0},"failure_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Failure Reason","description":"Reason for Job Failure"},"in_progress_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"In Progress Count","description":"In Progress Count","default":0}},"type":"object","title":"OutputLog"},"PackagePricing":{"properties":{"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"},"pricing_period":{"anyOf":[{"$ref":"#/components/schemas/PeriodCadence"},{"type":"null"}]},"unit_amount":{"anyOf":[{"type":"number"},{"$ref":"#/components/schemas/EdgeInput"}],"title":"Unit Amount"},"package_size":{"anyOf":[{"type":"number"},{"$ref":"#/components/schemas/EdgeInput"}],"title":"Package Size"},"pricing_type":{"type":"string","const":"package","title":"Pricing Type"}},"type":"object","required":["unit_amount","package_size","pricing_type"],"title":"PackagePricing"},"PaginatedResults":{"properties":{"next":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next","description":"The cursor for the next page of results","examples":["V2VsbCBhcmV1IGN1cmlvdxM="]},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous","description":"The cursor for the previous page of results","examples":["GmBsbCBhcmV1IGN1cmlvdxM="]},"total_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Count","description":"The total count of rows"},"results":{"items":{},"type":"array","title":"Results","description":"The results for the current page"}},"type":"object","required":["results"],"title":"PaginatedResults","description":"results: The results of the query of size limit\nnext: The cursor to use to get the next set of results\nprevious: The cursor to use to get the previous set of results"},"PaginatedResults_BusinessEntityResponseSchema_":{"properties":{"next":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next","description":"The cursor for the next page of results","examples":["V2VsbCBhcmV1IGN1cmlvdxM="]},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous","description":"The cursor for the previous page of results","examples":["GmBsbCBhcmV1IGN1cmlvdxM="]},"total_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Count","description":"The total count of rows"},"results":{"items":{"$ref":"#/components/schemas/BusinessEntityResponseSchema"},"type":"array","title":"Results","description":"The results for the current page"}},"type":"object","required":["results"],"title":"PaginatedResults[BusinessEntityResponseSchema]"},"PaginatedResults_ContactResponseSchema_":{"properties":{"next":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next","description":"The cursor for the next page of results","examples":["V2VsbCBhcmV1IGN1cmlvdxM="]},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous","description":"The cursor for the previous page of results","examples":["GmBsbCBhcmV1IGN1cmlvdxM="]},"total_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Count","description":"The total count of rows"},"results":{"items":{"$ref":"#/components/schemas/ContactResponseSchema"},"type":"array","title":"Results","description":"The results for the current page"}},"type":"object","required":["results"],"title":"PaginatedResults[ContactResponseSchema]"},"PaginatedResults_ContractResponseSchema_":{"properties":{"next":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next","description":"The cursor for the next page of results","examples":["V2VsbCBhcmV1IGN1cmlvdxM="]},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous","description":"The cursor for the previous page of results","examples":["GmBsbCBhcmV1IGN1cmlvdxM="]},"total_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Count","description":"The total count of rows"},"results":{"items":{"$ref":"#/components/schemas/ContractResponseSchema"},"type":"array","title":"Results","description":"The results for the current page"}},"type":"object","required":["results"],"title":"PaginatedResults[ContractResponseSchema]"},"PaginatedResults_CreditNoteResponseSchema_":{"properties":{"next":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next","description":"The cursor for the next page of results","examples":["V2VsbCBhcmV1IGN1cmlvdxM="]},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous","description":"The cursor for the previous page of results","examples":["GmBsbCBhcmV1IGN1cmlvdxM="]},"total_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Count","description":"The total count of rows"},"results":{"items":{"$ref":"#/components/schemas/CreditNoteResponseSchema"},"type":"array","title":"Results","description":"The results for the current page"}},"type":"object","required":["results"],"title":"PaginatedResults[CreditNoteResponseSchema]"},"PaginatedResults_DataSourceSchema_":{"properties":{"next":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next","description":"The cursor for the next page of results","examples":["V2VsbCBhcmV1IGN1cmlvdxM="]},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous","description":"The cursor for the previous page of results","examples":["GmBsbCBhcmV1IGN1cmlvdxM="]},"total_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Count","description":"The total count of rows"},"results":{"items":{"$ref":"#/components/schemas/DataSourceSchema"},"type":"array","title":"Results","description":"The results for the current page"}},"type":"object","required":["results"],"title":"PaginatedResults[DataSourceSchema]"},"PaginatedResults_EntitlementCustomerResponseSchema_":{"properties":{"next":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next","description":"The cursor for the next page of results","examples":["V2VsbCBhcmV1IGN1cmlvdxM="]},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous","description":"The cursor for the previous page of results","examples":["GmBsbCBhcmV1IGN1cmlvdxM="]},"total_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Count","description":"The total count of rows"},"results":{"items":{"$ref":"#/components/schemas/EntitlementCustomerResponseSchema"},"type":"array","title":"Results","description":"The results for the current page"}},"type":"object","required":["results"],"title":"PaginatedResults[EntitlementCustomerResponseSchema]"},"PaginatedResults_EntitlementCustomerSumResponseSchema_":{"properties":{"next":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next","description":"The cursor for the next page of results","examples":["V2VsbCBhcmV1IGN1cmlvdxM="]},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous","description":"The cursor for the previous page of results","examples":["GmBsbCBhcmV1IGN1cmlvdxM="]},"total_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Count","description":"The total count of rows"},"results":{"items":{"$ref":"#/components/schemas/EntitlementCustomerSumResponseSchema"},"type":"array","title":"Results","description":"The results for the current page"}},"type":"object","required":["results"],"title":"PaginatedResults[EntitlementCustomerSumResponseSchema]"},"PaginatedResults_EntitlementResponseSchema_":{"properties":{"next":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next","description":"The cursor for the next page of results","examples":["V2VsbCBhcmV1IGN1cmlvdxM="]},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous","description":"The cursor for the previous page of results","examples":["GmBsbCBhcmV1IGN1cmlvdxM="]},"total_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Count","description":"The total count of rows"},"results":{"items":{"$ref":"#/components/schemas/EntitlementResponseSchema"},"type":"array","title":"Results","description":"The results for the current page"}},"type":"object","required":["results"],"title":"PaginatedResults[EntitlementResponseSchema]"},"PaginatedResults_GetAggregateResponseSchema_":{"properties":{"next":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next","description":"The cursor for the next page of results","examples":["V2VsbCBhcmV1IGN1cmlvdxM="]},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous","description":"The cursor for the previous page of results","examples":["GmBsbCBhcmV1IGN1cmlvdxM="]},"total_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Count","description":"The total count of rows"},"results":{"items":{"$ref":"#/components/schemas/GetAggregateResponseSchema"},"type":"array","title":"Results","description":"The results for the current page"}},"type":"object","required":["results"],"title":"PaginatedResults[GetAggregateResponseSchema]"},"PaginatedResults_GetCustomerResponseSchema_":{"properties":{"next":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next","description":"The cursor for the next page of results","examples":["V2VsbCBhcmV1IGN1cmlvdxM="]},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous","description":"The cursor for the previous page of results","examples":["GmBsbCBhcmV1IGN1cmlvdxM="]},"total_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Count","description":"The total count of rows"},"results":{"items":{"$ref":"#/components/schemas/GetCustomerResponseSchema"},"type":"array","title":"Results","description":"The results for the current page"}},"type":"object","required":["results"],"title":"PaginatedResults[GetCustomerResponseSchema]"},"PaginatedResults_GetRawMetricResponseSchema_":{"properties":{"next":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next","description":"The cursor for the next page of results","examples":["V2VsbCBhcmV1IGN1cmlvdxM="]},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous","description":"The cursor for the previous page of results","examples":["GmBsbCBhcmV1IGN1cmlvdxM="]},"total_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Count","description":"The total count of rows"},"results":{"items":{"$ref":"#/components/schemas/GetRawMetricResponseSchema"},"type":"array","title":"Results","description":"The results for the current page"}},"type":"object","required":["results"],"title":"PaginatedResults[GetRawMetricResponseSchema]"},"PaginatedResults_JobResponseSchema_":{"properties":{"next":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next","description":"The cursor for the next page of results","examples":["V2VsbCBhcmV1IGN1cmlvdxM="]},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous","description":"The cursor for the previous page of results","examples":["GmBsbCBhcmV1IGN1cmlvdxM="]},"total_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Count","description":"The total count of rows"},"results":{"items":{"$ref":"#/components/schemas/JobResponseSchema"},"type":"array","title":"Results","description":"The results for the current page"}},"type":"object","required":["results"],"title":"PaginatedResults[JobResponseSchema]"},"PaginatedResults_PaymentResponseSchema_":{"properties":{"next":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next","description":"The cursor for the next page of results","examples":["V2VsbCBhcmV1IGN1cmlvdxM="]},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous","description":"The cursor for the previous page of results","examples":["GmBsbCBhcmV1IGN1cmlvdxM="]},"total_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Count","description":"The total count of rows"},"results":{"items":{"$ref":"#/components/schemas/PaymentResponseSchema"},"type":"array","title":"Results","description":"The results for the current page"}},"type":"object","required":["results"],"title":"PaginatedResults[PaymentResponseSchema]"},"PaginatedResults_PlanResponseSchema_":{"properties":{"next":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next","description":"The cursor for the next page of results","examples":["V2VsbCBhcmV1IGN1cmlvdxM="]},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous","description":"The cursor for the previous page of results","examples":["GmBsbCBhcmV1IGN1cmlvdxM="]},"total_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Count","description":"The total count of rows"},"results":{"items":{"$ref":"#/components/schemas/PlanResponseSchema"},"type":"array","title":"Results","description":"The results for the current page"}},"type":"object","required":["results"],"title":"PaginatedResults[PlanResponseSchema]"},"PaginatedResults_ProductBundlePricingResponseSchema_":{"properties":{"next":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next","description":"The cursor for the next page of results","examples":["V2VsbCBhcmV1IGN1cmlvdxM="]},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous","description":"The cursor for the previous page of results","examples":["GmBsbCBhcmV1IGN1cmlvdxM="]},"total_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Count","description":"The total count of rows"},"results":{"items":{"$ref":"#/components/schemas/ProductBundlePricingResponseSchema"},"type":"array","title":"Results","description":"The results for the current page"}},"type":"object","required":["results"],"title":"PaginatedResults[ProductBundlePricingResponseSchema]"},"PauseContractRequestSchema":{"properties":{"start_date":{"type":"string","format":"date-time","title":"Start Date","description":"Start Date"},"end_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Date","description":"End Date"},"unpause_extension_policy":{"$ref":"#/components/schemas/UnpauseExtensionPolicy","description":"Unpause Extension Policy"}},"type":"object","required":["start_date","unpause_extension_policy"],"title":"PauseContractRequestSchema"},"PaymentMethodTypes":{"type":"string","enum":["card","cash","check","charge_back","bank_transfer","direct_debit","amazon_payments","paypal_express_checkout","upi","netbanking_emandates","other","credits","ach_credit_transfer"],"title":"PaymentMethodTypes"},"PaymentPart":{"properties":{"invoice_id":{"type":"string","format":"uuid","title":"Invoice Id","description":"Invoice ID"},"amount":{"type":"integer","title":"Amount","description":"Amount"}},"type":"object","required":["invoice_id","amount"],"title":"PaymentPart","description":"Payment Part Object"},"PaymentResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Payment Id"},"customer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Customer Id","description":" "},"customer_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Name","description":" "},"customer_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Email","description":" "},"customer_external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer External Id","description":" "},"connector_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Connector Id","description":" "},"connector_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Connector Name","description":" "},"organisation_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Organisation Id","description":" "},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":" "},"payment_method":{"anyOf":[{"$ref":"#/components/schemas/PaymentMethodTypes"},{"type":"null"}],"description":" "},"payment_method_details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Payment Method Details","description":""},"type":{"anyOf":[{"$ref":"#/components/schemas/PaymentTypes"},{"type":"null"}],"description":" "},"amount":{"type":"string","title":"Amount","description":""},"amount_refunded":{"type":"string","title":"Amount Refunded","description":""},"currency_code":{"type":"string","title":"Currency Code","description":""},"status":{"anyOf":[{"$ref":"#/components/schemas/PaymentStatusTypes"},{"type":"null"}],"description":"Payment Status"},"parent_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Parent Id","description":" "},"invoices":{"anyOf":[{"items":{"$ref":"#/components/schemas/InvoiceAmounts"},"type":"array"},{"type":"null"}],"title":"Invoices","description":" "},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":" "},"transactions":{"anyOf":[{"items":{"$ref":"#/components/schemas/TransactionResponseSchema"},"type":"array"},{"type":"null"}],"title":"Transactions","description":" "},"error_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Text","description":"Error Message"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At","description":"created_at"},"receipt_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Number","description":"receipt_number"},"balance_transactions":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Balance Transactions","description":"balance_transactions"}},"type":"object","required":["id","amount","amount_refunded","currency_code","status"],"title":"PaymentResponseSchema","description":"Payment Response Schema"},"PaymentStatusTypes":{"type":"string","enum":["in_progress","requires_action","pending_charge","authorized","created","success","voided","failed","canceled","refunded","partially_refunded","other"],"title":"PaymentStatusTypes"},"PaymentTermMode":{"type":"string","enum":["relative","absolute"],"title":"PaymentTermMode"},"PaymentTermType":{"type":"string","enum":["on_approval","on_creation"],"title":"PaymentTermType"},"PaymentTerms":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Feature ID"},"identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Identifier","description":"Unique identifier for the feature in the pricing instance"},"priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Priority","description":"Priority of the feature, features get applied in ascending order of priority"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"payment_term_type":{"$ref":"#/components/schemas/PaymentTermType"},"due_days":{"type":"integer","exclusiveMinimum":0.0,"title":"Due Days"},"payment_term_mode":{"anyOf":[{"$ref":"#/components/schemas/PaymentTermMode"},{"type":"null"}],"description":"Payment Term Mode, relative or absolute","default":"relative"},"last_day_of_month":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Last Day Of Month","description":"Last day of month or not","default":false}},"type":"object","required":["payment_term_type","due_days"],"title":"PaymentTerms"},"PaymentTypes":{"type":"string","enum":["payment","refund","payment_reversal","authorization","tax_withheld"],"title":"PaymentTypes"},"PerUnitPricing":{"properties":{"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"},"pricing_period":{"anyOf":[{"$ref":"#/components/schemas/PeriodCadence"},{"type":"null"}]},"unit_amount":{"anyOf":[{"type":"number"},{"$ref":"#/components/schemas/EdgeInput"}],"title":"Unit Amount"},"pricing_type":{"type":"string","const":"per_unit","title":"Pricing Type"}},"type":"object","required":["unit_amount","pricing_type"],"title":"PerUnitPricing"},"PercentPricing":{"properties":{"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"},"pricing_period":{"anyOf":[{"$ref":"#/components/schemas/PeriodCadence"},{"type":"null"}]},"unit_amount":{"anyOf":[{"type":"number"},{"$ref":"#/components/schemas/EdgeInput"}],"title":"Unit Amount"},"pricing_type":{"type":"string","const":"percent","title":"Pricing Type"}},"type":"object","required":["unit_amount","pricing_type"],"title":"PercentPricing"},"Period":{"properties":{"cadence":{"type":"string","title":"Cadence","description":"Cadence"},"offset":{"$ref":"#/components/schemas/PeriodOffset","description":"Offset"}},"type":"object","required":["cadence","offset"],"title":"Period"},"PeriodCadence":{"properties":{"cadence":{"type":"string","title":"Cadence","description":"Cadence"}},"type":"object","required":["cadence"],"title":"PeriodCadence"},"PeriodOffset":{"type":"string","enum":["prepaid","postpaid"],"title":"PeriodOffset"},"PhaseDetails":{"properties":{"name":{"type":"string","title":"Name","description":"Contract Phase name"},"start_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Date","description":"Start Date"},"end_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Date","description":"End Date"},"id":{"type":"string","format":"uuid","title":"Id","description":"Contract Phase ID"},"phase_type":{"anyOf":[{"$ref":"#/components/schemas/PhaseType"},{"type":"null"}],"description":"Phase Type","default":"active"},"phase_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Phase Metadata","description":"Phase Metadata"}},"type":"object","required":["name","id"],"title":"PhaseDetails"},"PhaseType":{"type":"string","enum":["active","pause","trial"],"title":"PhaseType"},"PlanDiff":{"properties":{"additions":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Additions","description":"Additions"},"deletions":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Deletions","description":"Deletions"},"updates":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Updates","description":"Updates"}},"type":"object","title":"PlanDiff"},"PlanPhasePricingResponseSchema":{"properties":{"schedule":{"$ref":"#/components/schemas/Schedule","description":"Schedule of the product"},"product_id":{"type":"string","format":"uuid","title":"Product Id","description":"Product ID"},"pricing_id":{"type":"string","format":"uuid","title":"Pricing Id","description":"Pricing ID"},"product":{"$ref":"#/components/schemas/ProductResponseSchema","description":"Product details"},"pricing":{"$ref":"#/components/schemas/ProductBundlePricingResponseSchema","description":"Pricing details"},"id":{"type":"string","format":"uuid","title":"Id","description":"Plan Phase Pricing ID"}},"type":"object","required":["schedule","product_id","pricing_id","product","pricing","id"],"title":"PlanPhasePricingResponseSchema"},"PlanPhaseResponseSchema":{"properties":{"name":{"type":"string","title":"Name","description":"Plan name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Product Description"},"schedule":{"$ref":"#/components/schemas/Schedule","description":"Schedule of the phase"},"order":{"type":"integer","title":"Order","description":"Order of the phase"},"id":{"type":"string","format":"uuid","title":"Id","description":"Plan ID"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Plan created at"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"Plan updated at"},"plan_id":{"type":"string","format":"uuid","title":"Plan Id","description":"Plan ID"},"pricings":{"anyOf":[{"items":{"$ref":"#/components/schemas/PlanPhasePricingResponseSchema"},"type":"array"},{"type":"null"}],"title":"Pricings","description":"Different Product Pricings","default":[]},"features":{"anyOf":[{"$ref":"#/components/schemas/ProductPricingResponseSchema"},{"type":"null"}],"description":"Phase Features"}},"type":"object","required":["name","schedule","order","id","created_at","updated_at","plan_id"],"title":"PlanPhaseResponseSchema"},"PlanResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Plan ID"},"name":{"type":"string","title":"Name","description":"Plan name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Product Description"},"status":{"$ref":"#/components/schemas/PlanStatus","description":"Plan Status"},"schedule":{"$ref":"#/components/schemas/Schedule","description":"Schedule of the plan"},"phases":{"anyOf":[{"items":{"$ref":"#/components/schemas/PlanPhaseResponseSchema"},"type":"array"},{"type":"null"}],"title":"Phases","description":"Plan Phases","default":[]},"plan_version":{"anyOf":[{"$ref":"#/components/schemas/PlanVersionResponseSchema"},{"type":"null"}],"description":"Plan Version"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Plan created at"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"Plan updated at"}},"type":"object","required":["id","name","status","schedule","created_at","updated_at"],"title":"PlanResponseSchema"},"PlanStatus":{"type":"string","enum":["draft","active"],"title":"PlanStatus"},"PlanVersionResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Plan Version ID"},"old_plan_id":{"type":"string","format":"uuid","title":"Old Plan Id","description":"Old Plan ID"},"new_plan_id":{"type":"string","format":"uuid","title":"New Plan Id","description":"New Plan ID"},"parent_plan_id":{"type":"string","format":"uuid","title":"Parent Plan Id","description":"Parent Plan ID"},"version_number":{"type":"integer","title":"Version Number","description":"Version Number"},"diff":{"anyOf":[{"$ref":"#/components/schemas/PlanDiff"},{"type":"null"}],"description":"Diff"}},"type":"object","required":["id","old_plan_id","new_plan_id","parent_plan_id","version_number"],"title":"PlanVersionResponseSchema"},"Product-Input":{"properties":{"billing_period":{"anyOf":[{"$ref":"#/components/schemas/BillingPeriod"},{"$ref":"#/components/schemas/ValueReference"},{"type":"null"}],"title":"Billing Period","description":"billing period"},"subtotal":{"anyOf":[{"$ref":"#/components/schemas/ValueReference"},{"type":"number"}],"title":"Subtotal","description":"product subtotal, ie. before applying post pricing features"},"total":{"anyOf":[{"$ref":"#/components/schemas/ValueReference"},{"type":"number"}],"title":"Total","description":"product total, ie. after applying post pricing features"},"quantity_sources":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/Executable-Input"},"type":"object"},{"type":"null"}],"title":"Quantity Sources","description":"quantity sources"},"subproducts":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/Product-Input"},"type":"object"},{"type":"null"}],"title":"Subproducts","description":"subproducts"},"features":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/Executable-Input"},"type":"object"},{"type":"null"}],"title":"Features","description":"features"},"pricing_model":{"$ref":"#/components/schemas/Executable-Input","description":"pricing model executable"}},"type":"object","required":["subtotal","total","pricing_model"],"title":"Product"},"Product-Output":{"properties":{"billing_period":{"anyOf":[{"$ref":"#/components/schemas/BillingPeriod"},{"$ref":"#/components/schemas/ValueReference"},{"type":"null"}],"title":"Billing Period","description":"billing period"},"subtotal":{"anyOf":[{"$ref":"#/components/schemas/ValueReference"},{"type":"number"}],"title":"Subtotal","description":"product subtotal, ie. before applying post pricing features"},"total":{"anyOf":[{"$ref":"#/components/schemas/ValueReference"},{"type":"number"}],"title":"Total","description":"product total, ie. after applying post pricing features"},"quantity_sources":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/Executable-Output"},"type":"object"},{"type":"null"}],"title":"Quantity Sources","description":"quantity sources"},"subproducts":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/Product-Output"},"type":"object"},{"type":"null"}],"title":"Subproducts","description":"subproducts"},"features":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/Executable-Output"},"type":"object"},{"type":"null"}],"title":"Features","description":"features"},"pricing_model":{"$ref":"#/components/schemas/Executable-Output","description":"pricing model executable"}},"type":"object","required":["subtotal","total","pricing_model"],"title":"Product"},"ProductBundlePricingResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Pricing Model ID"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Pricing Model Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Pricing Model Description"},"pricing_data":{"oneOf":[{"$ref":"#/components/schemas/MatrixPricing"},{"$ref":"#/components/schemas/CustomTieredPricing"},{"$ref":"#/components/schemas/TwoDimensionalTieredPricing"},{"$ref":"#/components/schemas/PercentPricing"},{"$ref":"#/components/schemas/TieredPricing"},{"$ref":"#/components/schemas/TieredWithFlatFeePricing"},{"$ref":"#/components/schemas/VolumePricing"},{"$ref":"#/components/schemas/VolumeWithFlatFeePricing"},{"$ref":"#/components/schemas/StepPricing"},{"$ref":"#/components/schemas/PackagePricing"},{"$ref":"#/components/schemas/PerUnitPricing"},{"$ref":"#/components/schemas/FlatFee"},{"$ref":"#/components/schemas/FeaturesPricing"},{"$ref":"#/components/schemas/CustomPricing"}],"title":"Pricing Data","description":"Pricing Data","discriminator":{"propertyName":"pricing_type","mapping":{"custom_pricing":"#/components/schemas/CustomPricing","custom_tiered":"#/components/schemas/CustomTieredPricing","features":"#/components/schemas/FeaturesPricing","flat_fee":"#/components/schemas/FlatFee","matrix":"#/components/schemas/MatrixPricing","package":"#/components/schemas/PackagePricing","per_unit":"#/components/schemas/PerUnitPricing","percent":"#/components/schemas/PercentPricing","step":"#/components/schemas/StepPricing","tiered":"#/components/schemas/TieredPricing","tiered_with_flat_fee":"#/components/schemas/TieredWithFlatFeePricing","two_dimensional_tiered":"#/components/schemas/TwoDimensionalTieredPricing","volume":"#/components/schemas/VolumePricing","volume_with_flat_fee":"#/components/schemas/VolumeWithFlatFeePricing"}}},"quantity":{"anyOf":[{"$ref":"#/components/schemas/QuantityResponse"},{"type":"null"}],"description":"Quantity"},"grants":{"anyOf":[{"items":{"$ref":"#/components/schemas/GrantResponse"},"type":"array"},{"type":"null"}],"title":"Grants","description":"Grants","default":[]},"consumptions":{"anyOf":[{"items":{"$ref":"#/components/schemas/ConsumptionResponse"},"type":"array"},{"type":"null"}],"title":"Consumptions","description":"Consumptions","default":[]},"link_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link Id","description":"Parent Link ID"},"free_units":{"anyOf":[{"items":{"$ref":"#/components/schemas/FreeUnit"},"type":"array"},{"type":"null"}],"title":"Free Units","description":"Free Units","default":[]},"discounts":{"anyOf":[{"items":{"$ref":"#/components/schemas/Discount"},"type":"array"},{"type":"null"}],"title":"Discounts","description":"Discounts","default":[]},"commitments":{"anyOf":[{"items":{"$ref":"#/components/schemas/Commitment"},"type":"array"},{"type":"null"}],"title":"Commitments","description":"Commitments","default":[]},"taxes":{"anyOf":[{"items":{"$ref":"#/components/schemas/Taxes"},"type":"array"},{"type":"null"}],"title":"Taxes","description":"Taxes","default":[]},"payment_terms":{"anyOf":[{"items":{"$ref":"#/components/schemas/PaymentTerms"},"type":"array"},{"type":"null"}],"title":"Payment Terms","description":"Payment Terms","default":[]},"service_fees":{"anyOf":[{"items":{"$ref":"#/components/schemas/ServiceFee"},"type":"array"},{"type":"null"}],"title":"Service Fees","description":"Service Fees","default":[]},"execution_logic":{"anyOf":[{"$ref":"#/components/schemas/ExecutionLogic"},{"type":"null"}],"description":"Execution Logic"},"is_recurring":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Recurring","description":"Is Recurring or not"},"billing_period":{"anyOf":[{"$ref":"#/components/schemas/Period"},{"type":"null"}],"description":"Billing Cadence"},"add_to_catalog":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Add To Catalog","description":"Part of product catalog or not","default":true},"usage_report_configs":{"anyOf":[{"items":{"$ref":"#/components/schemas/ProductPricingUsageAssociationResponseSchema"},"type":"array"},{"type":"null"}],"title":"Usage Report Configs","description":"Usage Report Configurations associated with the pricing model","default":[]},"products":{"anyOf":[{"items":{"$ref":"#/components/schemas/ProductInBundleResponseSchema"},"type":"array"},{"type":"null"}],"title":"Products","description":"List of Bundled Products"}},"type":"object","required":["id","pricing_data"],"title":"ProductBundlePricingResponseSchema"},"ProductCategory":{"type":"string","enum":["group","standalone","bundle"],"title":"ProductCategory"},"ProductInBundleResponseSchema":{"properties":{"product":{"$ref":"#/components/schemas/ProductResponseSchema","description":"Product"},"pricing_model":{"$ref":"#/components/schemas/ProductPricingResponseSchema","description":"Pricing Model"}},"type":"object","required":["product","pricing_model"],"title":"ProductInBundleResponseSchema"},"ProductPricingResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Pricing Model ID"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Pricing Model Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Pricing Model Description"},"pricing_data":{"oneOf":[{"$ref":"#/components/schemas/MatrixPricing"},{"$ref":"#/components/schemas/CustomTieredPricing"},{"$ref":"#/components/schemas/TwoDimensionalTieredPricing"},{"$ref":"#/components/schemas/PercentPricing"},{"$ref":"#/components/schemas/TieredPricing"},{"$ref":"#/components/schemas/TieredWithFlatFeePricing"},{"$ref":"#/components/schemas/VolumePricing"},{"$ref":"#/components/schemas/VolumeWithFlatFeePricing"},{"$ref":"#/components/schemas/StepPricing"},{"$ref":"#/components/schemas/PackagePricing"},{"$ref":"#/components/schemas/PerUnitPricing"},{"$ref":"#/components/schemas/FlatFee"},{"$ref":"#/components/schemas/FeaturesPricing"},{"$ref":"#/components/schemas/CustomPricing"}],"title":"Pricing Data","description":"Pricing Data","discriminator":{"propertyName":"pricing_type","mapping":{"custom_pricing":"#/components/schemas/CustomPricing","custom_tiered":"#/components/schemas/CustomTieredPricing","features":"#/components/schemas/FeaturesPricing","flat_fee":"#/components/schemas/FlatFee","matrix":"#/components/schemas/MatrixPricing","package":"#/components/schemas/PackagePricing","per_unit":"#/components/schemas/PerUnitPricing","percent":"#/components/schemas/PercentPricing","step":"#/components/schemas/StepPricing","tiered":"#/components/schemas/TieredPricing","tiered_with_flat_fee":"#/components/schemas/TieredWithFlatFeePricing","two_dimensional_tiered":"#/components/schemas/TwoDimensionalTieredPricing","volume":"#/components/schemas/VolumePricing","volume_with_flat_fee":"#/components/schemas/VolumeWithFlatFeePricing"}}},"quantity":{"anyOf":[{"$ref":"#/components/schemas/QuantityResponse"},{"type":"null"}],"description":"Quantity"},"grants":{"anyOf":[{"items":{"$ref":"#/components/schemas/GrantResponse"},"type":"array"},{"type":"null"}],"title":"Grants","description":"Grants","default":[]},"consumptions":{"anyOf":[{"items":{"$ref":"#/components/schemas/ConsumptionResponse"},"type":"array"},{"type":"null"}],"title":"Consumptions","description":"Consumptions","default":[]},"link_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link Id","description":"Parent Link ID"},"free_units":{"anyOf":[{"items":{"$ref":"#/components/schemas/FreeUnit"},"type":"array"},{"type":"null"}],"title":"Free Units","description":"Free Units","default":[]},"discounts":{"anyOf":[{"items":{"$ref":"#/components/schemas/Discount"},"type":"array"},{"type":"null"}],"title":"Discounts","description":"Discounts","default":[]},"commitments":{"anyOf":[{"items":{"$ref":"#/components/schemas/Commitment"},"type":"array"},{"type":"null"}],"title":"Commitments","description":"Commitments","default":[]},"taxes":{"anyOf":[{"items":{"$ref":"#/components/schemas/Taxes"},"type":"array"},{"type":"null"}],"title":"Taxes","description":"Taxes","default":[]},"payment_terms":{"anyOf":[{"items":{"$ref":"#/components/schemas/PaymentTerms"},"type":"array"},{"type":"null"}],"title":"Payment Terms","description":"Payment Terms","default":[]},"service_fees":{"anyOf":[{"items":{"$ref":"#/components/schemas/ServiceFee"},"type":"array"},{"type":"null"}],"title":"Service Fees","description":"Service Fees","default":[]},"execution_logic":{"anyOf":[{"$ref":"#/components/schemas/ExecutionLogic"},{"type":"null"}],"description":"Execution Logic"},"is_recurring":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Recurring","description":"Is Recurring or not"},"billing_period":{"anyOf":[{"$ref":"#/components/schemas/Period"},{"type":"null"}],"description":"Billing Cadence"},"add_to_catalog":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Add To Catalog","description":"Part of product catalog or not","default":true},"usage_report_configs":{"anyOf":[{"items":{"$ref":"#/components/schemas/ProductPricingUsageAssociationResponseSchema"},"type":"array"},{"type":"null"}],"title":"Usage Report Configs","description":"Usage Report Configurations associated with the pricing model","default":[]}},"type":"object","required":["id","pricing_data"],"title":"ProductPricingResponseSchema"},"ProductPricingUsageAssociationResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Product Pricing Usage Association ID"},"aggregate_id":{"type":"string","format":"uuid","title":"Aggregate Id","description":"Aggregate ID"},"config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Config","description":"Usage Report Configuration","default":{}},"is_default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Default","description":"Is Default or not","default":false},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At","description":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Updated At"},"aggregate":{"anyOf":[{"$ref":"#/components/schemas/GetAggregateResponseSchema"},{"type":"null"}],"description":"Aggregate"}},"type":"object","required":["id","aggregate_id"],"title":"ProductPricingUsageAssociationResponseSchema"},"ProductResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Product ID"},"name":{"type":"string","title":"Name","description":"Product name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Product Description"},"tags":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Tags","description":"Product Tags"},"sku":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sku","description":"Product SKU"},"parent_link_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Link Id","description":"Parent Link ID"},"tax_codes":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Tax Codes","description":"Product Tax Codes"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active","description":"Is Active or not"},"type":{"$ref":"#/components/schemas/ProductTypeV2","description":"Product Type"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At","description":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Updated At"},"default_pricing_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Default Pricing Id","description":"Default Pricing ID"},"custom_attributes":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Attributes","description":"Custom Attributes","default":{}},"product_category":{"anyOf":[{"$ref":"#/components/schemas/ProductCategory"},{"type":"null"}],"description":"Product Category"},"product_type":{"anyOf":[{"$ref":"#/components/schemas/ProductType-Output"},{"type":"null"}],"description":"Product Type"},"product_sub_type":{"anyOf":[{"$ref":"#/components/schemas/ProductSubType"},{"type":"null"}],"description":"Product Sub Type"},"track_usage":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Track Usage","description":"Track Usage or not"},"enum_values":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Enum Values","description":"Enum Values"}},"type":"object","required":["id","name","type"],"title":"ProductResponseSchema"},"ProductSubType":{"type":"string","enum":["quantity","boolean","credits"],"title":"ProductSubType"},"ProductType-Output":{"type":"string","enum":["time_dependent","time_independent"],"title":"ProductType"},"ProductTypeV2":{"type":"string","enum":["product","group"],"title":"ProductTypeV2"},"Quantity":{"properties":{"type":{"$ref":"#/components/schemas/QuantityType"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label","description":"Label"},"quantity":{"anyOf":[{"type":"number"},{"$ref":"#/components/schemas/EdgeInput"},{"type":"null"}],"title":"Quantity","description":"Quantity"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit","description":"Unit"},"aggregate_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Aggregate Id","description":"Aggregate ID"},"quantity_entries":{"anyOf":[{"items":{"$ref":"#/components/schemas/QuantityEntry"},"type":"array"},{"type":"null"}],"title":"Quantity Entries"}},"type":"object","required":["type"],"title":"Quantity"},"QuantityEntry":{"properties":{"value":{"anyOf":[{"type":"number"},{"type":"string"}],"title":"Value"},"effective_from":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Effective From"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","required":["value"],"title":"QuantityEntry"},"QuantityResponse":{"properties":{"type":{"$ref":"#/components/schemas/QuantityType"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label","description":"Label"},"quantity":{"anyOf":[{"type":"number"},{"$ref":"#/components/schemas/EdgeInput"},{"type":"null"}],"title":"Quantity","description":"Quantity"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit","description":"Unit"},"aggregate_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Aggregate Id","description":"Aggregate ID"},"quantity_entries":{"anyOf":[{"items":{"$ref":"#/components/schemas/QuantityEntry"},"type":"array"},{"type":"null"}],"title":"Quantity Entries"},"aggregate":{"anyOf":[{"$ref":"#/components/schemas/GetAggregateResponseSchema"},{"type":"null"}]}},"type":"object","required":["type"],"title":"QuantityResponse"},"QuantityType":{"type":"string","enum":["metered","fixed"],"title":"QuantityType"},"RawMetricResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"RawMetric Id"},"name":{"type":"string","title":"Name","description":"name of the raw metric"},"api_slug":{"type":"string","title":"Api Slug","description":"api slug raw metric name"},"dataschema":{"additionalProperties":true,"type":"object","title":"Dataschema","description":"Data schema raw metric"},"column_order":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Column Order","description":"Order of the columns in the raw metric table"}},"type":"object","required":["id","name","api_slug","dataschema"],"title":"RawMetricResponseSchema","description":"RawMetric Response Schema"},"RefundDestination":{"type":"string","enum":["credits","original_payment_method","external"],"title":"RefundDestination"},"RefundSplitInPayments":{"properties":{"payment_id":{"type":"string","format":"uuid","title":"Payment Id","description":"Payment ID"},"external_payment_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Payment Id","description":"External Payment ID"},"connector_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Connector Id","description":"Connector ID"},"amount":{"type":"number","title":"Amount","description":"Amount"}},"type":"object","required":["payment_id","amount"],"title":"RefundSplitInPayments"},"RenewalPolicy":{"type":"string","enum":["renew_with_default_contract","renew_with_existing","do_not_renew"],"title":"RenewalPolicy","description":"Enum for defining the renewal policy of a contract."},"Resource":{"type":"string","enum":["contracts","invoices","sandbox","usage_report","custom_email","customer","monitoring","payment","journal_entry","credit_note","revenue_posting","entitlements","account_balance","performance_obligation"],"title":"Resource"},"Schedule":{"properties":{"duration":{"type":"string","title":"Duration","description":"Length of the phase/plan in ISO 8601 format"},"start_offset":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Offset","description":"Offset duration from the plan start date to the phase start date in ISO 8601 format","default":"P0D"},"trigger_type":{"anyOf":[{"$ref":"#/components/schemas/TriggerType"},{"type":"null"}],"description":"Trigger for product","default":"time_based"}},"type":"object","required":["duration"],"title":"Schedule"},"ServiceFee":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Feature ID"},"identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Identifier","description":"Unique identifier for the feature in the pricing instance"},"priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Priority","description":"Priority of the feature, features get applied in ascending order of priority"},"type":{"$ref":"#/components/schemas/ServiceFeeType"},"unit_amount":{"type":"number","minimum":0.0,"title":"Unit Amount"},"pricing_period":{"anyOf":[{"$ref":"#/components/schemas/PeriodCadence"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"}},"type":"object","required":["type","unit_amount"],"title":"ServiceFee"},"ServiceFeeType":{"type":"string","enum":["fixed","percent"],"title":"ServiceFeeType"},"SingleEntitlementCustomerResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Entitlement Customer Row Id"},"entitlement":{"type":"string","format":"uuid","title":"Entitlement","description":"Entitlement ID"},"customer":{"type":"string","format":"uuid","title":"Customer","description":"Customer ID"},"expiry_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expiry At","description":"Entitlement Expiry Time"},"active_from":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Active From","description":"Entitlement Active From"},"quantity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity","description":"Entitlement Units assigned"},"quantity_used":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity Used","description":"Entitlement Units Consumed"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At","description":"created time"}},"type":"object","required":["id","entitlement","customer"],"title":"SingleEntitlementCustomerResponseSchema","description":"Create Entitlement Customer Request Schema"},"StepPricing":{"properties":{"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"},"pricing_period":{"anyOf":[{"$ref":"#/components/schemas/PeriodCadence"},{"type":"null"}]},"unit_amount":{"anyOf":[{"items":{"type":"number","minimum":0.0},"type":"array"},{"$ref":"#/components/schemas/EdgeInput"}],"title":"Unit Amount"},"up_to":{"anyOf":[{"items":{"type":"number","minimum":0.0},"type":"array"},{"$ref":"#/components/schemas/EdgeInput"},{"type":"null"}],"title":"Up To"},"pricing_type":{"type":"string","const":"step","title":"Pricing Type"}},"type":"object","required":["unit_amount","pricing_type"],"title":"StepPricing"},"TagHolder":{"type":"string","enum":["invoice","product","contract","customer","payment"],"title":"TagHolder"},"TaxId":{"properties":{"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Code","description":"Country Code"},"tax_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Code","description":"Tax Code"},"tax_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Id","description":"Tax Id"}},"type":"object","title":"TaxId","description":"Tax Id Schema"},"TaxType":{"type":"string","enum":["manual","avalara"],"title":"TaxType"},"Taxes":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Feature ID"},"identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Identifier","description":"Unique identifier for the feature in the pricing instance"},"priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Priority","description":"Priority of the feature, features get applied in ascending order of priority"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"unit_amount":{"anyOf":[{"type":"number"},{"$ref":"#/components/schemas/EdgeInput"},{"type":"null"}],"title":"Unit Amount"},"type":{"$ref":"#/components/schemas/TaxType"}},"type":"object","required":["type"],"title":"Taxes"},"TieredPricing":{"properties":{"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"},"pricing_period":{"anyOf":[{"$ref":"#/components/schemas/PeriodCadence"},{"type":"null"}]},"unit_amount":{"anyOf":[{"items":{"type":"number","minimum":0.0},"type":"array"},{"$ref":"#/components/schemas/EdgeInput"}],"title":"Unit Amount"},"up_to":{"anyOf":[{"items":{"type":"number","minimum":0.0},"type":"array"},{"$ref":"#/components/schemas/EdgeInput"},{"type":"null"}],"title":"Up To"},"flat_fee":{"anyOf":[{"items":{"type":"number","minimum":0.0},"type":"array"},{"$ref":"#/components/schemas/EdgeInput"},{"type":"null"}],"title":"Flat Fee"},"pricing_type":{"type":"string","const":"tiered","title":"Pricing Type"}},"type":"object","required":["unit_amount","pricing_type"],"title":"TieredPricing"},"TieredWithFlatFeePricing":{"properties":{"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"},"pricing_period":{"anyOf":[{"$ref":"#/components/schemas/PeriodCadence"},{"type":"null"}]},"unit_amount":{"anyOf":[{"items":{"type":"number","minimum":0.0},"type":"array"},{"$ref":"#/components/schemas/EdgeInput"}],"title":"Unit Amount"},"up_to":{"anyOf":[{"items":{"type":"number","minimum":0.0},"type":"array"},{"$ref":"#/components/schemas/EdgeInput"},{"type":"null"}],"title":"Up To"},"flat_fee":{"anyOf":[{"items":{"type":"number","minimum":0.0},"type":"array"},{"$ref":"#/components/schemas/EdgeInput"},{"type":"null"}],"title":"Flat Fee"},"pricing_type":{"type":"string","const":"tiered_with_flat_fee","title":"Pricing Type"}},"type":"object","required":["unit_amount","pricing_type"],"title":"TieredWithFlatFeePricing"},"TotalEntitlementCustomerResponseSchema":{"properties":{"entitlement":{"type":"string","format":"uuid","title":"Entitlement","description":"Entitlement ID"},"customer":{"type":"string","format":"uuid","title":"Customer","description":"Customer ID"},"quantity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity","description":"Entitlement Units assigned"}},"type":"object","required":["entitlement","customer"],"title":"TotalEntitlementCustomerResponseSchema","description":"Create Entitlement Customer Request Schema"},"TransactionResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":" "},"customer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Customer Id","description":" "},"connector_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Connector Id","description":" "},"organisation_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Organisation Id","description":" "},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":" "},"payment_method":{"anyOf":[{"$ref":"#/components/schemas/PaymentMethodTypes"},{"type":"null"}],"description":" "},"payment_method_details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Payment Method Details","description":""},"reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Number","description":" "},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":" "},"amount":{"type":"string","title":"Amount","description":""},"currency_code":{"type":"string","title":"Currency Code","description":""},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code","description":" "},"error_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Text","description":" "},"payment":{"type":"string","format":"uuid","title":"Payment","description":" "},"settled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Settled At","description":" "},"voided_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Voided At","description":" "},"status":{"anyOf":[{"$ref":"#/components/schemas/PaymentStatusTypes"},{"type":"null"}],"description":" "},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":" "},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At","description":" "},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":" "},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deleted At","description":" "},"payment_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Type","description":" "}},"type":"object","required":["id","amount","currency_code","payment","status"],"title":"TransactionResponseSchema","description":"Transaction Response Schema"},"TriggerType":{"type":"string","enum":["event_based","time_based"],"title":"TriggerType"},"TwoDimensionalTieredPricing":{"properties":{"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"},"pricing_period":{"anyOf":[{"$ref":"#/components/schemas/PeriodCadence"},{"type":"null"}]},"unit_amount":{"anyOf":[{"items":{"items":{"type":"number","minimum":0.0},"type":"array"},"type":"array"},{"$ref":"#/components/schemas/EdgeInput"}],"title":"Unit Amount"},"up_to":{"anyOf":[{"items":{"type":"number","minimum":0.0},"type":"array"},{"$ref":"#/components/schemas/EdgeInput"}],"title":"Up To"},"column_up_to":{"anyOf":[{"items":{"type":"number","minimum":0.0},"type":"array"},{"$ref":"#/components/schemas/EdgeInput"}],"title":"Column Up To"},"pricing_type":{"type":"string","const":"two_dimensional_tiered","title":"Pricing Type"}},"type":"object","required":["unit_amount","up_to","column_up_to","pricing_type"],"title":"TwoDimensionalTieredPricing"},"UnpauseExtensionPolicy":{"type":"string","enum":["extend","overlap"],"title":"UnpauseExtensionPolicy"},"UpdateAggregateRequestSchema":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"name of the aggregate"},"dataschema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dataschema","description":"data schema of aggregate"},"aggregation_query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Aggregation Query","description":"aggregate query"},"cust_agg_query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cust Agg Query","description":"customer aggregate query"},"visual_query_builder":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Visual Query Builder","description":"visual query builder"},"datasource":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Datasource","description":"data source uuid"}},"type":"object","title":"UpdateAggregateRequestSchema","description":"Create Aggregate Request Schema"},"UpdateBusinessEntityRequestSchema":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Business Entity Name"},"address":{"anyOf":[{"$ref":"#/components/schemas/EntityAddress"},{"type":"null"}],"description":"Business Entity address"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Business Entity email"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number","description":"Business Entity phone number"},"is_default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Default","description":"Business Entity default"},"tax_config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Tax Config","description":"Business Entity tax config"},"logo_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Logo Url","description":"Business Entity logo URL"}},"type":"object","title":"UpdateBusinessEntityRequestSchema","description":"Update Organisation Request Schema"},"UpdateContractPhasePricingRequestSchema":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Contract Phase Pricing ID"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"External ID"},"start_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Date","description":"Start Date"},"end_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Date","description":"End Date"},"pricing_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Pricing Id","description":"Pricing ID"},"product_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Product Id","description":"Product ID"},"custom_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Data","description":"Pricing Association Metadata"},"pricing":{"anyOf":[{"$ref":"#/components/schemas/CreateProductPricingRequestSchema"},{"type":"null"}],"description":"Pricing for the phase"},"product":{"anyOf":[{"$ref":"#/components/schemas/CreateProductRequestSchema"},{"type":"null"}],"description":"Product"}},"type":"object","title":"UpdateContractPhasePricingRequestSchema"},"UpdateContractPhaseRequestSchema":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Contract Phase ID"},"name":{"type":"string","title":"Name","description":"Contract Phase name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Contract Phase Description"},"start_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Date","description":"Start Date"},"end_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Date","description":"End Date"},"pricings":{"anyOf":[{"items":{"$ref":"#/components/schemas/UpdateContractPhasePricingRequestSchema"},"type":"array"},{"type":"null"}],"title":"Pricings","description":"Different Product Pricings","default":[]},"features":{"anyOf":[{"$ref":"#/components/schemas/UpdateProductPricingRequestSchema"},{"type":"null"}],"description":"Pricing for the features of the phase"},"source_plan_phase_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Source Plan Phase Id","description":"Source Plan Phase ID"},"phase_type":{"anyOf":[{"$ref":"#/components/schemas/PhaseType"},{"type":"null"}],"description":"Phase Type","default":"active"},"phase_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Phase Metadata","description":"Phase Metadata"}},"type":"object","required":["name"],"title":"UpdateContractPhaseRequestSchema"},"UpdateContractRequestSchema":{"properties":{"name":{"type":"string","title":"Name","description":"Contract name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Product Description"},"tags":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Tags","description":"Product Tags"},"status":{"$ref":"#/components/schemas/ContractStatus","description":"Contract Status"},"currency":{"type":"string","title":"Currency","description":"Currency"},"start_date":{"type":"string","format":"date-time","title":"Start Date","description":"Start Date"},"end_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Date","description":"End Date"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"Customer ID"},"anchor_date":{"type":"string","format":"date-time","title":"Anchor Date","description":"Anchor Date"},"is_last_day_of_month":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Last Day Of Month","description":"Is Last Day of Month"},"custom_attributes":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Attributes","description":"Contract Custom Attributes"},"phases":{"anyOf":[{"items":{"$ref":"#/components/schemas/UpdateContractPhaseRequestSchema"},"type":"array"},{"type":"null"}],"title":"Phases","description":"Different Contract Phases","default":[]},"renewal_policy":{"anyOf":[{"$ref":"#/components/schemas/RenewalPolicy"},{"type":"null"}],"description":"Renewal Policy"},"contract_link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contract Link","description":"Contract Link"},"bill_parent_customer":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Bill Parent Customer","description":"Bill Parent Customer","default":false},"invoice_payer_customer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Invoice Payer Customer Id","description":"Invoice Payer Customer Id"},"include_in_renewal":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Include In Renewal","description":"Include in Renewal","default":true},"source":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Source","description":"Source information for the contract"}},"type":"object","required":["name","status","currency","start_date","customer_id"],"title":"UpdateContractRequestSchema"},"UpdateCreditNoteRequestSchema":{"properties":{"amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amount","description":"Amount"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Currency"},"status":{"anyOf":[{"$ref":"#/components/schemas/CreditNoteStatuses"},{"type":"null"}],"description":"Status"},"repayment_method":{"anyOf":[{"$ref":"#/components/schemas/CreditNoteRepaymentMethods"},{"type":"null"}],"description":"Repayment Method"},"line_items":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Line Items","description":"Line Items"},"custom_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Data","description":"Custom Data Dictionary"}},"type":"object","title":"UpdateCreditNoteRequestSchema"},"UpdateCustomerConnectorRequestSchema":{"properties":{"connector":{"$ref":"#/components/schemas/app__customer__schema__Connector","description":"Connector"}},"type":"object","required":["connector"],"title":"UpdateCustomerConnectorRequestSchema","description":"Update Customer Connector RequestSchema"},"UpdateCustomerRequestSchema":{"properties":{"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"External Customer Id"},"customer_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Name","description":"Customer name"},"custom_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Data","description":"Customer Custom Data"},"address":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}],"description":"Customer Address"},"ship_to_address":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}],"description":"Customer Ship To Address"},"tax_info":{"anyOf":[{"items":{"$ref":"#/components/schemas/TaxId"},"type":"array"},{"type":"null"}],"title":"Tax Info","description":"Customer Tax Ids","default":[]},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number","description":"Customer Phone Number"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email","description":"Customer primary email address"},"connector":{"anyOf":[{"$ref":"#/components/schemas/app__customer__schema__Connector"},{"type":"null"}],"description":"Connector"},"communications_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Communications Enabled","description":"To enable/disable communications","default":true},"auto_charge_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Auto Charge Enabled","description":"To enable/disable auto-charge","default":true},"business_entity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Business Entity Id","description":"Business Entity Id"}},"type":"object","title":"UpdateCustomerRequestSchema","description":"Update Customer RequestSchema"},"UpdateEntitlementCustomerRequestSchema":{"properties":{"entitlement":{"type":"string","title":"Entitlement","description":"Entitlement ID"},"customer":{"type":"string","title":"Customer","description":"Customer ID"},"expiry_at":{"type":"string","format":"date-time","title":"Expiry At","description":"Entitlement Expiry Time"},"active_from":{"type":"string","format":"date-time","title":"Active From","description":"Entitlement Active From"},"quantity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity","description":"Entitlement Units assigned"},"quantity_used":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quantity Used","description":"Entitlement Units Consumed"}},"type":"object","required":["entitlement","customer"],"title":"UpdateEntitlementCustomerRequestSchema","description":"Update Entitlement Request Schema"},"UpdateEntitlementRequestSchema":{"properties":{"name":{"type":"string","title":"Name","description":"Entitlement name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Entitlement Description"},"entitlement_type":{"anyOf":[{"$ref":"#/components/schemas/EntitlementType"},{"type":"null"}],"description":"Entitlement Type"},"units":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Units","description":"Entitlement Units"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active","description":"Entitlement is active","default":true},"product_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Product Id","description":"Product ID"}},"type":"object","required":["name"],"title":"UpdateEntitlementRequestSchema","description":"Update Entitlement RequestSchema"},"UpdateManualPaymentRequestSchema":{"properties":{"payment_method_details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Payment Method Details","description":" "},"amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amount","description":""},"payment_parts":{"anyOf":[{"items":{"$ref":"#/components/schemas/PaymentPart"},"type":"array"},{"type":"null"}],"title":"Payment Parts","description":"Payment Parts"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"External ID"},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":" "}},"type":"object","title":"UpdateManualPaymentRequestSchema","description":"Update Manual Payment Request Schema"},"UpdatePaymentRequestSchema":{"properties":{"payment_parts":{"anyOf":[{"items":{"$ref":"#/components/schemas/PaymentPart"},"type":"array"},{"type":"null"}],"title":"Payment Parts","description":"Payment Parts"}},"type":"object","title":"UpdatePaymentRequestSchema","description":"Update Payment Request Schema"},"UpdatePlanPhasePricingRequestSchema":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Plan Phase Pricing ID"},"schedule":{"anyOf":[{"$ref":"#/components/schemas/Schedule"},{"type":"null"}],"description":"Schedule of the product"},"pricing_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Pricing Id","description":"Pricing ID"},"product_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Product Id","description":"Product ID"},"pricing":{"anyOf":[{"$ref":"#/components/schemas/UpdateProductPricingRequestSchema"},{"type":"null"}],"description":"Pricing for the phase"},"product":{"anyOf":[{"$ref":"#/components/schemas/UpdateProductRequestSchema"},{"type":"null"}],"description":"Product for the phase"}},"type":"object","title":"UpdatePlanPhasePricingRequestSchema"},"UpdatePlanPhaseRequestSchema":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Plan Phase ID"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Plan name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Product Description"},"schedule":{"anyOf":[{"$ref":"#/components/schemas/Schedule"},{"type":"null"}],"description":"Schedule of the Phase"},"order":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Order","description":"Order of the phase"},"features":{"anyOf":[{"$ref":"#/components/schemas/UpdateProductPricingRequestSchema"},{"type":"null"}],"description":"Phase Features"},"pricings":{"anyOf":[{"items":{"$ref":"#/components/schemas/UpdatePlanPhasePricingRequestSchema"},"type":"array"},{"type":"null"}],"title":"Pricings","description":"Different Product Pricings","default":[]}},"type":"object","title":"UpdatePlanPhaseRequestSchema"},"UpdatePlanRequestSchema":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Plan name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Product Description"},"status":{"$ref":"#/components/schemas/PlanStatus","description":"Plan Status"},"schedule":{"anyOf":[{"$ref":"#/components/schemas/Schedule"},{"type":"null"}],"description":"Duration of the plan"},"phases":{"anyOf":[{"items":{"$ref":"#/components/schemas/UpdatePlanPhaseRequestSchema"},"type":"array"},{"type":"null"}],"title":"Phases","description":"Plan Phases"}},"type":"object","required":["status"],"title":"UpdatePlanRequestSchema"},"UpdateProductBundlePricingRequestSchema":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Pricing Model ID"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Pricing Model Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Pricing Model Description"},"pricing_data":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/MatrixPricing"},{"$ref":"#/components/schemas/CustomTieredPricing"},{"$ref":"#/components/schemas/TwoDimensionalTieredPricing"},{"$ref":"#/components/schemas/PercentPricing"},{"$ref":"#/components/schemas/TieredPricing"},{"$ref":"#/components/schemas/TieredWithFlatFeePricing"},{"$ref":"#/components/schemas/VolumePricing"},{"$ref":"#/components/schemas/VolumeWithFlatFeePricing"},{"$ref":"#/components/schemas/StepPricing"},{"$ref":"#/components/schemas/PackagePricing"},{"$ref":"#/components/schemas/PerUnitPricing"},{"$ref":"#/components/schemas/FlatFee"},{"$ref":"#/components/schemas/FeaturesPricing"},{"$ref":"#/components/schemas/CustomPricing"}],"discriminator":{"propertyName":"pricing_type","mapping":{"custom_pricing":"#/components/schemas/CustomPricing","custom_tiered":"#/components/schemas/CustomTieredPricing","features":"#/components/schemas/FeaturesPricing","flat_fee":"#/components/schemas/FlatFee","matrix":"#/components/schemas/MatrixPricing","package":"#/components/schemas/PackagePricing","per_unit":"#/components/schemas/PerUnitPricing","percent":"#/components/schemas/PercentPricing","step":"#/components/schemas/StepPricing","tiered":"#/components/schemas/TieredPricing","tiered_with_flat_fee":"#/components/schemas/TieredWithFlatFeePricing","two_dimensional_tiered":"#/components/schemas/TwoDimensionalTieredPricing","volume":"#/components/schemas/VolumePricing","volume_with_flat_fee":"#/components/schemas/VolumeWithFlatFeePricing"}}},{"type":"null"}],"title":"Pricing Data","description":"Pricing Data"},"quantity":{"anyOf":[{"$ref":"#/components/schemas/Quantity"},{"type":"null"}],"description":"Quantity"},"grants":{"anyOf":[{"items":{"$ref":"#/components/schemas/Grant"},"type":"array"},{"type":"null"}],"title":"Grants","description":"Grants","default":[]},"consumptions":{"anyOf":[{"items":{"$ref":"#/components/schemas/Consumption"},"type":"array"},{"type":"null"}],"title":"Consumptions","description":"Consumptions","default":[]},"link_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link Id","description":"Parent Link ID"},"free_units":{"anyOf":[{"items":{"$ref":"#/components/schemas/FreeUnit"},"type":"array"},{"type":"null"}],"title":"Free Units","description":"Free Units","default":[]},"discounts":{"anyOf":[{"items":{"$ref":"#/components/schemas/Discount"},"type":"array"},{"type":"null"}],"title":"Discounts","description":"Discounts","default":[]},"commitments":{"anyOf":[{"items":{"$ref":"#/components/schemas/Commitment"},"type":"array"},{"type":"null"}],"title":"Commitments","description":"Commitments","default":[]},"taxes":{"anyOf":[{"items":{"$ref":"#/components/schemas/Taxes"},"type":"array"},{"type":"null"}],"title":"Taxes","description":"Taxes","default":[]},"payment_terms":{"anyOf":[{"items":{"$ref":"#/components/schemas/PaymentTerms"},"type":"array"},{"type":"null"}],"title":"Payment Terms","description":"Payment Terms","default":[]},"service_fees":{"anyOf":[{"items":{"$ref":"#/components/schemas/ServiceFee"},"type":"array"},{"type":"null"}],"title":"Service Fees","description":"Service Fees","default":[]},"execution_logic":{"anyOf":[{"$ref":"#/components/schemas/ExecutionLogic"},{"type":"null"}],"description":"Execution Logic"},"is_recurring":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Recurring","description":"Is Recurring or not"},"billing_period":{"anyOf":[{"$ref":"#/components/schemas/Period"},{"type":"null"}],"description":"Billing Cadence"},"add_to_catalog":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Add To Catalog","description":"Part of product catalog or not","default":true},"usage_report_configs":{"anyOf":[{"items":{"$ref":"#/components/schemas/UpdateProductPricingUsageAssociationRequestSchema"},"type":"array"},{"type":"null"}],"title":"Usage Report Configs","description":"Usage Report Configuration","default":[]},"products":{"items":{"$ref":"#/components/schemas/UpdateProductInBundleRequestSchema"},"type":"array","title":"Products","description":"List of Bundled Products"}},"type":"object","required":["products"],"title":"UpdateProductBundlePricingRequestSchema"},"UpdateProductInBundleRequestSchema":{"properties":{"product_id":{"type":"string","format":"uuid","title":"Product Id","description":"Product ID"},"product_pricing_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Product Pricing Id","description":"Product Pricing ID"},"product_pricing_data":{"anyOf":[{"$ref":"#/components/schemas/CreateProductPricingRequestSchema"},{"$ref":"#/components/schemas/UpdateProductPricingRequestSchema"},{"type":"null"}],"title":"Product Pricing Data","description":"Product Pricing Data"}},"type":"object","required":["product_id"],"title":"UpdateProductInBundleRequestSchema"},"UpdateProductPricingRequestSchema":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Pricing Model ID"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Pricing Model Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Pricing Model Description"},"pricing_data":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/MatrixPricing"},{"$ref":"#/components/schemas/CustomTieredPricing"},{"$ref":"#/components/schemas/TwoDimensionalTieredPricing"},{"$ref":"#/components/schemas/PercentPricing"},{"$ref":"#/components/schemas/TieredPricing"},{"$ref":"#/components/schemas/TieredWithFlatFeePricing"},{"$ref":"#/components/schemas/VolumePricing"},{"$ref":"#/components/schemas/VolumeWithFlatFeePricing"},{"$ref":"#/components/schemas/StepPricing"},{"$ref":"#/components/schemas/PackagePricing"},{"$ref":"#/components/schemas/PerUnitPricing"},{"$ref":"#/components/schemas/FlatFee"},{"$ref":"#/components/schemas/FeaturesPricing"},{"$ref":"#/components/schemas/CustomPricing"}],"discriminator":{"propertyName":"pricing_type","mapping":{"custom_pricing":"#/components/schemas/CustomPricing","custom_tiered":"#/components/schemas/CustomTieredPricing","features":"#/components/schemas/FeaturesPricing","flat_fee":"#/components/schemas/FlatFee","matrix":"#/components/schemas/MatrixPricing","package":"#/components/schemas/PackagePricing","per_unit":"#/components/schemas/PerUnitPricing","percent":"#/components/schemas/PercentPricing","step":"#/components/schemas/StepPricing","tiered":"#/components/schemas/TieredPricing","tiered_with_flat_fee":"#/components/schemas/TieredWithFlatFeePricing","two_dimensional_tiered":"#/components/schemas/TwoDimensionalTieredPricing","volume":"#/components/schemas/VolumePricing","volume_with_flat_fee":"#/components/schemas/VolumeWithFlatFeePricing"}}},{"type":"null"}],"title":"Pricing Data","description":"Pricing Data"},"quantity":{"anyOf":[{"$ref":"#/components/schemas/Quantity"},{"type":"null"}],"description":"Quantity"},"grants":{"anyOf":[{"items":{"$ref":"#/components/schemas/Grant"},"type":"array"},{"type":"null"}],"title":"Grants","description":"Grants","default":[]},"consumptions":{"anyOf":[{"items":{"$ref":"#/components/schemas/Consumption"},"type":"array"},{"type":"null"}],"title":"Consumptions","description":"Consumptions","default":[]},"link_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link Id","description":"Parent Link ID"},"free_units":{"anyOf":[{"items":{"$ref":"#/components/schemas/FreeUnit"},"type":"array"},{"type":"null"}],"title":"Free Units","description":"Free Units","default":[]},"discounts":{"anyOf":[{"items":{"$ref":"#/components/schemas/Discount"},"type":"array"},{"type":"null"}],"title":"Discounts","description":"Discounts","default":[]},"commitments":{"anyOf":[{"items":{"$ref":"#/components/schemas/Commitment"},"type":"array"},{"type":"null"}],"title":"Commitments","description":"Commitments","default":[]},"taxes":{"anyOf":[{"items":{"$ref":"#/components/schemas/Taxes"},"type":"array"},{"type":"null"}],"title":"Taxes","description":"Taxes","default":[]},"payment_terms":{"anyOf":[{"items":{"$ref":"#/components/schemas/PaymentTerms"},"type":"array"},{"type":"null"}],"title":"Payment Terms","description":"Payment Terms","default":[]},"service_fees":{"anyOf":[{"items":{"$ref":"#/components/schemas/ServiceFee"},"type":"array"},{"type":"null"}],"title":"Service Fees","description":"Service Fees","default":[]},"execution_logic":{"anyOf":[{"$ref":"#/components/schemas/ExecutionLogic"},{"type":"null"}],"description":"Execution Logic"},"is_recurring":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Recurring","description":"Is Recurring or not"},"billing_period":{"anyOf":[{"$ref":"#/components/schemas/Period"},{"type":"null"}],"description":"Billing Cadence"},"add_to_catalog":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Add To Catalog","description":"Part of product catalog or not","default":true},"usage_report_configs":{"anyOf":[{"items":{"$ref":"#/components/schemas/UpdateProductPricingUsageAssociationRequestSchema"},"type":"array"},{"type":"null"}],"title":"Usage Report Configs","description":"Usage Report Configuration","default":[]}},"type":"object","title":"UpdateProductPricingRequestSchema"},"UpdateProductPricingUsageAssociationRequestSchema":{"properties":{"aggregate_id":{"type":"string","format":"uuid","title":"Aggregate Id","description":"Aggregate ID"},"config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Config","description":"Usage Report Configuration","default":{}},"is_default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Default","description":"Is Default or not","default":false},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Product Pricing Usage Association ID"}},"type":"object","required":["aggregate_id"],"title":"UpdateProductPricingUsageAssociationRequestSchema"},"UpdateProductRequestSchema":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Product name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Product Description"},"tags":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Tags","description":"Product Tags"},"sku":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sku","description":"Product SKU"},"parent_link_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Link Id","description":"Parent Link ID"},"tax_codes":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Tax Codes","description":"Product Tax Codes"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active","description":"Is Active or not"},"type":{"anyOf":[{"$ref":"#/components/schemas/ProductTypeV2"},{"type":"null"}],"description":"Product Type"},"default_pricing_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Default Pricing Id","description":"Default Pricing ID"},"custom_attributes":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Attributes","description":"Custom Attributes"},"product_category":{"anyOf":[{"$ref":"#/components/schemas/ProductCategory"},{"type":"null"}],"description":"Product Category"},"product_type":{"anyOf":[{"$ref":"#/components/schemas/app__product__schema_v2__ProductType"},{"type":"null"}],"description":"Product Type"},"product_sub_type":{"anyOf":[{"$ref":"#/components/schemas/ProductSubType"},{"type":"null"}],"description":"Product Sub Type"},"track_usage":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Track Usage","description":"Track Usage or not"},"enum_values":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Enum Values","description":"Enum Values"}},"type":"object","title":"UpdateProductRequestSchema"},"UpsertTagsRequestSchema":{"properties":{"holder":{"anyOf":[{"$ref":"#/components/schemas/TagHolder"},{"type":"null"}],"description":""},"item_id":{"type":"string","title":"Item Id","description":""},"tags":{"additionalProperties":true,"type":"object","title":"Tags","description":"Dictionary of tags and their values"}},"type":"object","required":["item_id","tags"],"title":"UpsertTagsRequestSchema","example":{"holder":"INVOICE","item_id":"inv_123","tags":{"department":"sales","priority":"high"}}},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"ValueReference":{"properties":{"value_from":{"type":"string","title":"Value From"}},"type":"object","required":["value_from"],"title":"ValueReference","description":"value_from is a valid path in the amendment JSON"},"VolumePricing":{"properties":{"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"},"pricing_period":{"anyOf":[{"$ref":"#/components/schemas/PeriodCadence"},{"type":"null"}]},"unit_amount":{"anyOf":[{"items":{"type":"number","minimum":0.0},"type":"array"},{"$ref":"#/components/schemas/EdgeInput"}],"title":"Unit Amount"},"up_to":{"anyOf":[{"items":{"type":"number","minimum":0.0},"type":"array"},{"$ref":"#/components/schemas/EdgeInput"},{"type":"null"}],"title":"Up To"},"flat_fee":{"anyOf":[{"items":{"type":"number","minimum":0.0},"type":"array"},{"$ref":"#/components/schemas/EdgeInput"},{"type":"null"}],"title":"Flat Fee"},"pricing_type":{"type":"string","const":"volume","title":"Pricing Type"}},"type":"object","required":["unit_amount","pricing_type"],"title":"VolumePricing"},"VolumeWithFlatFeePricing":{"properties":{"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"},"pricing_period":{"anyOf":[{"$ref":"#/components/schemas/PeriodCadence"},{"type":"null"}]},"unit_amount":{"anyOf":[{"items":{"type":"number","minimum":0.0},"type":"array"},{"$ref":"#/components/schemas/EdgeInput"}],"title":"Unit Amount"},"up_to":{"anyOf":[{"items":{"type":"number","minimum":0.0},"type":"array"},{"$ref":"#/components/schemas/EdgeInput"},{"type":"null"}],"title":"Up To"},"flat_fee":{"anyOf":[{"items":{"type":"number","minimum":0.0},"type":"array"},{"$ref":"#/components/schemas/EdgeInput"},{"type":"null"}],"title":"Flat Fee"},"pricing_type":{"type":"string","const":"volume_with_flat_fee","title":"Pricing Type"}},"type":"object","required":["unit_amount","pricing_type"],"title":"VolumeWithFlatFeePricing"},"app__accounting__schema__Connector":{"properties":{"name":{"type":"string","title":"Name","description":"Connector Name"}},"type":"object","required":["name"],"title":"Connector"},"app__customer__schema__Connector":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Connector Name"},"reference_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Id","description":"External Connector customer Refrence id"}},"type":"object","title":"Connector"},"app__entitlements__schema__DetailsObject":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"}},"type":"object","title":"DetailsObject"},"app__invoice__schema__DetailsObject":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"}},"type":"object","required":["id"],"title":"DetailsObject"},"app__payments__schema__Connector":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Connector Name"},"reference_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Id","description":"External Connector customer Refrence id"}},"type":"object","title":"Connector"},"app__product__model__ProductType":{"type":"string","enum":["product","add_on","bundle","sub_product"],"title":"ProductType"},"app__product__schema_v2__ProductType":{"type":"string","enum":["time_dependent","time_independent"],"title":"ProductType"}},"securitySchemes":{"ApiTokenAuth":{"type":"apiKey","in":"header","name":"x-api-key"}}},"servers":[{"url":"https://api.zenskar.com"}],"security":[{"ApiTokenAuth":[]}]}