diff --git a/openapi.yaml b/openapi.yaml index 30ecacf..7703a03 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -13757,13 +13757,78 @@ components: amount_cents: 200 metadata: $ref: '#/components/schemas/MetadataInput' + IntegrationCustomer: + type: object + required: + - lago_id + - type + - external_customer_id + - integration_code + description: Configuration specific to the accounting and tax integrations. This object contains settings and parameters necessary for syncing documents and payments. + properties: + lago_id: + type: string + format: uuid + example: 1a901a90-1a90-1a90-1a90-1a901a901a90 + description: A unique identifier for the integration customer object in the Lago application. + type: + type: string + example: netsuite + description: |- + The integration type used for accounting and tax syncs. + Accepted values: `netsuite, anrok`. + enum: + - netsuite + - anrok + - xero + - hubspot + - salesforce + integration_code: + type: string + example: netsuite-eu-1 + description: Unique code used to identify an integration connection. + external_customer_id: + type: string + example: cus_12345 + description: The customer ID within the integration's system. If this field is not provided, Lago has the option to create a new customer record within the integration's system on behalf of the customer. + sync_with_provider: + type: + - boolean + - 'null' + example: true + description: Set this field to `true` if you want to create a customer record in the integration's system. This option is applicable only when the `external_customer_id` is null and the `sync_with_provider` field is set to `true`. By default, the value is set to `false` + subsidiary_id: + type: string + example: '2' + description: This optional field is needed only when working with `netsuite` connection. + targeted_object: + type: + - string + - 'null' + example: contacts + description: This optional field is present only when working with `hubspot` connection. + email: + type: + - string + - 'null' + example: dinesh@piedpiper.test + description: This optional field is present only when working with `hubspot` connection. + CustomerObject: + allOf: + - $ref: '#/components/schemas/CustomerBaseObject' + - type: object + properties: + integration_customers: + type: array + items: + $ref: '#/components/schemas/IntegrationCustomer' CreditNoteExtendedObject: allOf: - $ref: '#/components/schemas/CreditNoteObject' - type: object properties: customer: - $ref: '#/components/schemas/CustomerBaseObject' + $ref: '#/components/schemas/CustomerObject' CreditNoteExtended: type: object required: @@ -13994,71 +14059,6 @@ components: properties: metadata: $ref: '#/components/schemas/MetadataObject' - IntegrationCustomer: - type: object - required: - - lago_id - - type - - external_customer_id - - integration_code - description: Configuration specific to the accounting and tax integrations. This object contains settings and parameters necessary for syncing documents and payments. - properties: - lago_id: - type: string - format: uuid - example: 1a901a90-1a90-1a90-1a90-1a901a901a90 - description: A unique identifier for the integration customer object in the Lago application. - type: - type: string - example: netsuite - description: |- - The integration type used for accounting and tax syncs. - Accepted values: `netsuite, anrok`. - enum: - - netsuite - - anrok - - xero - - hubspot - - salesforce - integration_code: - type: string - example: netsuite-eu-1 - description: Unique code used to identify an integration connection. - external_customer_id: - type: string - example: cus_12345 - description: The customer ID within the integration's system. If this field is not provided, Lago has the option to create a new customer record within the integration's system on behalf of the customer. - sync_with_provider: - type: - - boolean - - 'null' - example: true - description: Set this field to `true` if you want to create a customer record in the integration's system. This option is applicable only when the `external_customer_id` is null and the `sync_with_provider` field is set to `true`. By default, the value is set to `false` - subsidiary_id: - type: string - example: '2' - description: This optional field is needed only when working with `netsuite` connection. - targeted_object: - type: - - string - - 'null' - example: contacts - description: This optional field is present only when working with `hubspot` connection. - email: - type: - - string - - 'null' - example: dinesh@piedpiper.test - description: This optional field is present only when working with `hubspot` connection. - CustomerObject: - allOf: - - $ref: '#/components/schemas/CustomerBaseObject' - - type: object - properties: - integration_customers: - type: array - items: - $ref: '#/components/schemas/IntegrationCustomer' ErrorDetailObject: type: object required: diff --git a/src/schemas/CreditNoteExtendedObject.yaml b/src/schemas/CreditNoteExtendedObject.yaml index ebee2de..85da6a4 100644 --- a/src/schemas/CreditNoteExtendedObject.yaml +++ b/src/schemas/CreditNoteExtendedObject.yaml @@ -3,4 +3,4 @@ allOf: - type: object properties: customer: - $ref: "./CustomerBaseObject.yaml" + $ref: "./CustomerObject.yaml"