API Reference: Tax Service Adapter

Owned by Umer Mir
Last updated: May 08, 2024
114 min read

Tax Service Adapter is a Service Provider Interface (SPI) that helps Chargebee communicate with API platforms that provide the following services:

  • Address validation

  • Estimating taxes for sales

  • Submitting invoices for tax filing

If you have an API that provides the services mentioned above and want Chargebee to be able to integrate with it, you can build an adapter service according to the specification given below.

openapi: 3.0.3 info: description: > ## Overview Tax Service Adapter is a Service Provider Interface (SPI) that helps Chargebee communicate with API platforms providing the following services: - Address validation - Estimating taxes for sales - Submitting invoices for tax filing If you have an API that provides the services mentioned above and want Chargebee to be able to integrate with it, you can build an adapter service according to this specification. ## Terminology Here's a list of terms we've used to describe this specification. ### Merchant Chargebee’s customer who is carrying out the business of selling products. Also known as the Seller. The Seller has one or more Chargebee accounts. ### Chargebee The SaaS which manages subscriptions and revenue operations on behalf of the Merchant. Chargebee makes API calls to the Tax Service Adapter for tax estimation and tax filing of transactions between the Merchant and the Customer. ### Customer Merchant’s customer who purchases products from the Merchant. Their customer record(s) and other details are stored within Chargebee under the Merchant’s account. ### Tax Authority The institution, usually a government, that is responsible for collecting taxes for commercial transactions between Merchants and their Customers. ### Tax Service Provider The service which provides tax estimation and tax filing services for merchants. ### Tax Service Adapter The SPI for which the spec is defined in this document. This adapter serves the following purposes: - Translates API requests (as defined in this document) from Chargebee to the request format specified by the Tax Service Provider's API. - Translates API responses from the Tax Service Provider APIs to the format understood by Chargebee (as defined in this document). ### Authorization Chargebee uses HTTP header-based authorization for all the API endpoints associated with Tax Service Adapter. We dynamically pass this authorization key in the HTTP header. The parameter that holds this key is found in the JSON object `api_configuration` required for configuring your onboarding on Chargebee's marketplace. In the `api_configuration` object, our [Taxes Service Adapter SPI](https://chargebee.atlassian.net/l/cp/ca5aZ1mA) checks the authorization key parameter from `credential_configuration.id` and creates the HTTP header-based input query parameter for authorization. The `credential_configuration` is an array of objects with an `id` attribute, and the value of `id` is the parameter containing the authorization key. Following are the JSON snippets for your reference. ```json "api_configuration": { "api_base_url": "https://xyz.abc.com/chargebee", "credential_configuration": [ { "id":"authorization_key", "name": "Authorization Key", "type": "text", "is_sensitive": true }, { "id": "client_secret", "name": "Client Secret", "type": "text", "is_sensitive": true } ] } ``` `"Authorization":"{"<authorization_key>":"test_GykCvTykZFTBqHQAFzjMN9R1Thgdho0Q"}"` title: Taxes Service Adapter SPI version: 0.3.7 servers: - description: Production SPI server. url: 'https://rest.taxes.provider.com/api/v1' - description: Sandbox SPI server. url: 'https://sandbox.taxes.provider.com/api/v1' security: - bearerAuth: [] - apiKey: [] tags: - description: Endpoints to validate an address and check its taxability. name: Address - description: Endpoints to estimate taxes. name: TaxEstimate - description: Endpoints to manage invoices sent to the Tax Service Provider. name: Invoice - description: Endpoints to manage credit notes sent to the Tax Service Provider. name: CreditNote - description: >- Endpoints to validate the credentials used for calling the Tax Service Adapter. name: Authentication - description: >- Endpoints to monitor the health of the Tax Service Provider and the Tax Service Adapter. name: Health paths: /health: get: description: >- This endpoint is used to fetch the health status of the Service Provider. operationId: fetchHealth responses: '200': content: application/json: example: status: UP version: 1.0.0 description: The service is healthy. components: - id: app-db-memory name: Application Database type: DATABASE status: UP - id: adapter-server name: Adapter API Server type: ADAPTER status: UP - id: service-server name: API Server type: API status: UP time: 2022-11-01T05:12:08.131Z schema: $ref: '#/components/schemas/HealthCheckResponse' description: Service is healthy. '429': description: Too many requests. '500': content: application/json: examples: Error500: $ref: '#/components/examples/Error500Response' schema: $ref: '#/components/schemas/BasicErrorResponse' description: Unexpected error while processing request. '503': content: application/json: example: status: DOWN version: 1.0.0 description: The service is unhealthy. Several components are down. components: - id: app-db-memory name: Application Database Memory Usage type: DATABASE status: UP - id: adapter-server name: Adapter API Server type: ADAPTER status: DOWN - id: service-server name: API Server type: API status: DOWN time: 2022-11-01T05:12:08.131Z schema: $ref: '#/components/schemas/HealthCheckResponse' description: Service is unhealthy. security: - {} summary: Fetch the health status of the Service Provider. tags: - Health x-accepts: application/json /credentials/validate: post: description: >- This endpoint is used to validate the credentials used to call the Service Provider. operationId: validateCredentials responses: '200': content: application/json: example: status: VALID schema: $ref: '#/components/schemas/CredentialValidationResponse' description: Authentication succeeded. '401': content: application/json: example: status: INVALID schema: $ref: '#/components/schemas/CredentialValidationResponse' description: Authentication failed. '429': description: Too many requests. '500': content: application/json: examples: Error500: $ref: '#/components/examples/Error500Response' schema: $ref: '#/components/schemas/BasicErrorResponse' description: Unexpected error while processing request. '503': content: application/json: example: status: DOWN version: 1.0.0 description: The service is unhealthy. Several components are down. components: - id: app-db-memory name: Application Database Memory Usage type: DATABASE status: UP - id: adapter-server name: Adapter API Server type: ADAPTER status: DOWN - id: service-server name: API Server type: API status: DOWN time: 2022-11-01T05:12:08.131Z schema: $ref: '#/components/schemas/HealthCheckResponse' description: Service is unhealthy. summary: Validate credentials tags: - Authentication x-accepts: application/json /tax-estimate: post: description: >- This endpoint is used to estimate taxes for a set of line items being sold by the Merchant to a Customer. operationId: estimateTaxes requestBody: content: application/json: examples: TaxEstimationRequestSimple: $ref: '#/components/examples/TaxEstimationRequestSimple' TaxEstimationRequestWithTaxInclusive: $ref: '#/components/examples/TaxEstimationRequestWithTaxInclusive' TaxEstimationRequestWithLineItemDiscount: $ref: '#/components/examples/TaxEstimationRequestWithLineItemDiscount' TaxEstimationRequestWithCustomerExemption: $ref: >- #/components/examples/TaxEstimationRequestWithCustomerExemption schema: $ref: '#/components/schemas/TaxEstimationRequest' responses: '200': content: application/json: examples: TaxEstimationResponseSimple: $ref: '#/components/examples/TaxEstimationResponseSimple' TaxEstimationResponseWithTaxInclusive: $ref: '#/components/examples/TaxEstimationResponseWithTaxInclusive' TaxEstimationResponseWithLineItemDiscount: $ref: >- #/components/examples/TaxEstimationResponseWithLineItemDiscount TaxEstimationResponseWithCustomerExemption: $ref: >- #/components/examples/TaxEstimationResponseWithCustomerExemption schema: $ref: '#/components/schemas/TaxEstimationResponse' description: Tax estimated successfully for given line items. '400': content: application/json: examples: Error400ResponseInvalidTaxCode: $ref: '#/components/examples/Error400ResponseInvalidTaxCode' Error400ResponseMissingCustomerAddress: $ref: '#/components/examples/Error400ResponseMissingCustomerAddress' schema: $ref: '#/components/schemas/ValidationErrorResponse' description: Bad request. '401': description: Unauthenticated request. '403': description: Unauthorized request. '404': description: Not found. '429': description: Too many requests. '500': content: application/json: examples: Error500: $ref: '#/components/examples/Error500Response' schema: $ref: '#/components/schemas/BasicErrorResponse' description: Unexpected error while processing request. '503': content: application/json: example: status: DOWN version: 1.0.0 description: The service is unhealthy. Several components are down. components: - id: app-db-memory name: Application Database Memory Usage type: DATABASE status: UP - id: adapter-server name: Adapter API Server type: ADAPTER status: DOWN - id: service-server name: API Server type: API status: DOWN time: 2022-11-01T05:12:08.131Z schema: $ref: '#/components/schemas/HealthCheckResponse' description: Service is unhealthy. summary: Estimate tax tags: - TaxEstimate x-content-type: application/json x-accepts: application/json /invoices: post: description: >- This endpoint is used to send an invoice to the Tax Service Provider. Invoices created in Chargebee are statements of amounts owed by the Customer to the Merchant for a specific purchase. operationId: createInvoice requestBody: content: application/json: examples: InvoiceRequestSimple: $ref: '#/components/examples/InvoiceRequestSimple' InvoiceRequestWithTaxInclusive: $ref: '#/components/examples/InvoiceRequestWithTaxInclusive' schema: $ref: '#/components/schemas/InvoiceRequest' responses: '201': content: application/json: examples: InvoiceResponseSimple: $ref: '#/components/examples/InvoiceResponseSimple' InvoiceResponseWithTaxInclusive: $ref: '#/components/examples/InvoiceResponseWithTaxInclusive' schema: $ref: '#/components/schemas/Invoice' description: Invoice created successfully. '400': content: application/json: examples: Error400ResponseInvalidTaxCode: $ref: '#/components/examples/Error400ResponseInvalidTaxCode' Error400ResponseMissingCustomerAddress: $ref: '#/components/examples/Error400ResponseMissingCustomerAddress' schema: $ref: '#/components/schemas/ValidationErrorResponse' description: Bad request. '401': description: Unauthenticated request. '403': description: Unauthorized request. '429': description: Too many requests. '500': content: application/json: examples: Error500: $ref: '#/components/examples/Error500Response' schema: $ref: '#/components/schemas/BasicErrorResponse' description: Unexpected error while processing request. '503': content: application/json: example: status: DOWN version: 1.0.0 description: The service is unhealthy. Several components are down. components: - id: app-db-memory name: Application Database Memory Usage type: DATABASE status: UP - id: adapter-server name: Adapter API Server type: ADAPTER status: DOWN - id: service-server name: API Server type: API status: DOWN time: 2022-11-01T05:12:08.131Z schema: $ref: '#/components/schemas/HealthCheckResponse' description: Service is unhealthy. summary: Create Invoice tags: - Invoice x-content-type: application/json x-accepts: application/json '/invoices/{invoiceId}': get: description: This endpoint is used to retrieve an invoice for a given invoice id. operationId: fetchInvoice parameters: - description: >- The unique identifier of the invoice at the Tax Service Adapter or Tax Service Provider. explode: false in: path name: invoiceId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/Invoice' description: Invoice retrieved successfully. '401': description: Unauthenticated request. '403': description: Unauthorized request. '404': description: Not found. '429': description: Too many requests. '500': content: application/json: examples: Error500: $ref: '#/components/examples/Error500Response' schema: $ref: '#/components/schemas/BasicErrorResponse' description: Unexpected error while processing request. '503': content: application/json: example: status: DOWN version: 1.0.0 description: The service is unhealthy. Several components are down. components: - id: app-db-memory name: Application Database Memory Usage type: DATABASE status: UP - id: adapter-server name: Adapter API Server type: ADAPTER status: DOWN - id: service-server name: API Server type: API status: DOWN time: 2022-11-01T05:12:08.131Z schema: $ref: '#/components/schemas/HealthCheckResponse' description: Service is unhealthy. summary: Retrieve Invoice tags: - Invoice x-accepts: application/json '/invoices/{invoiceId}/commit': post: description: >- This endpoint is used to commit an invoice for a given invoice id. Once committed, the invoice is considered to be finalized. operationId: commitInvoice parameters: - description: >- The unique identifier of the invoice at the Tax Service Adapter or Tax Service Provider. explode: false in: path name: invoiceId required: true schema: type: string style: simple responses: '204': description: Invoice committed successfully. '401': description: Unauthenticated request. '403': description: Unauthorized request. '404': description: Not found. '429': description: Too many requests. '500': content: application/json: examples: Error500: $ref: '#/components/examples/Error500Response' schema: $ref: '#/components/schemas/BasicErrorResponse' description: Unexpected error while processing request. '503': content: application/json: example: status: DOWN version: 1.0.0 description: The service is unhealthy. Several components are down. components: - id: app-db-memory name: Application Database Memory Usage type: DATABASE status: UP - id: adapter-server name: Adapter API Server type: ADAPTER status: DOWN - id: service-server name: API Server type: API status: DOWN time: 2022-11-01T05:12:08.131Z schema: $ref: '#/components/schemas/HealthCheckResponse' description: Service is unhealthy. summary: Commit Invoice tags: - Invoice x-accepts: application/json '/invoices/{invoiceId}/void': post: description: >- This endpoint is used to mark a specific invoice as void. Voiding cancels the invoice without deleting it. operationId: voidInvoice parameters: - description: >- The unique identifier of the invoice at the Tax Service Adapter or Tax Service Provider. explode: false in: path name: invoiceId required: true schema: type: string style: simple responses: '204': description: Invoice voided successfully. '401': description: Unauthenticated request. '403': description: Unauthorized request. '404': description: Not found. '429': description: Too many requests. '500': content: application/json: examples: Error500: $ref: '#/components/examples/Error500Response' schema: $ref: '#/components/schemas/BasicErrorResponse' description: Unexpected error while processing request. '503': content: application/json: example: status: DOWN version: 1.0.0 description: The service is unhealthy. Several components are down. components: - id: app-db-memory name: Application Database Memory Usage type: DATABASE status: UP - id: adapter-server name: Adapter API Server type: ADAPTER status: DOWN - id: service-server name: API Server type: API status: DOWN time: 2022-11-01T05:12:08.131Z schema: $ref: '#/components/schemas/HealthCheckResponse' description: Service is unhealthy. summary: Void Invoice tags: - Invoice x-accepts: application/json /credit-notes: post: description: >- This endpoint is used to send a credit note to the Tax Service Adapter. A credit note is used to reduce the amount due on an invoice. If the credit note is issued after payments have been made for the invoice, refunds can be issued to the Customer. operationId: createCreditNote requestBody: content: application/json: examples: CreditNoteRequestFull: $ref: '#/components/examples/CreditNoteRequestFull' CreditNoteRequestFullWithTaxInclusive: $ref: '#/components/examples/CreditNoteRequestFullWithTaxInclusive' schema: $ref: '#/components/schemas/CreditNoteRequest' responses: '201': content: application/json: examples: CreditNoteResponseFull: $ref: '#/components/examples/CreditNoteResponseFull' CreditNoteResponseFullWithTaxInclusive: $ref: '#/components/examples/CreditNoteResponseFullWithTaxInclusive' schema: $ref: '#/components/schemas/CreditNote' description: Credit note created successfully. '400': content: application/json: examples: Error400ResponseInvalidCreditNoteId: $ref: '#/components/examples/Error400ResponseInvalidCreditNoteId' Error400ResponseMissingCustomerAddress: $ref: '#/components/examples/Error400ResponseMissingCustomerAddress' schema: $ref: '#/components/schemas/ValidationErrorResponse' description: Bad request. '401': description: Unauthenticated request. '403': description: Unauthorized request. '429': description: Too many requests. '500': content: application/json: examples: Error500: $ref: '#/components/examples/Error500Response' schema: $ref: '#/components/schemas/BasicErrorResponse' description: Unexpected error while processing request. '503': content: application/json: example: status: DOWN version: 1.0.0 description: The service is unhealthy. Several components are down. components: - id: app-db-memory name: Application Database Memory Usage type: DATABASE status: UP - id: adapter-server name: Adapter API Server type: ADAPTER status: DOWN - id: service-server name: API Server type: API status: DOWN time: 2022-11-01T05:12:08.131Z schema: $ref: '#/components/schemas/HealthCheckResponse' description: Service is unhealthy. summary: Create credit note tags: - CreditNote x-content-type: application/json x-accepts: application/json '/credit-notes/{creditNoteId}': get: description: >- This endpoint is used to retrieve a specific credit note using the unique credit note id. operationId: fetchCreditNote parameters: - description: >- The unique identifier of the credit note at the Tax Service Adapter or Tax Service Provider. explode: false in: path name: creditNoteId required: true schema: type: string style: simple - description: >- The unique identifier of the invoice at the Tax Service Adapter or Tax Service Provider. explode: true in: query name: invoiceId required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/CreditNote' description: Credit note retrieved successfully. '401': description: Unauthenticated request. '403': description: Unauthorized request. '404': description: Not found. '429': description: Too many requests. '500': content: application/json: examples: Error500: $ref: '#/components/examples/Error500Response' schema: $ref: '#/components/schemas/BasicErrorResponse' description: Unexpected error while processing request. '503': content: application/json: example: status: DOWN version: 1.0.0 description: The service is unhealthy. Several components are down. components: - id: app-db-memory name: Application Database Memory Usage type: DATABASE status: UP - id: adapter-server name: Adapter API Server type: ADAPTER status: DOWN - id: service-server name: API Server type: API status: DOWN time: 2022-11-01T05:12:08.131Z schema: $ref: '#/components/schemas/HealthCheckResponse' description: Service is unhealthy. summary: Retrieve credit note tags: - CreditNote x-accepts: application/json '/credit-notes/{creditNoteId}/commit': post: description: >- This endpoint is used to mark a credit note as committed. Once committed, the credit note is considered as finalized. operationId: commitCreditNote parameters: - description: >- The unique identifier of the credit note at the Tax Service Adapter or Tax Service Provider. explode: false in: path name: creditNoteId required: true schema: type: string style: simple - description: >- The unique identifier of the invoice at the Tax Service Adapter or Tax Service Provider. explode: true in: query name: invoiceId required: false schema: type: string style: form responses: '204': description: Credit note committed successfully. '401': description: Unauthenticated request. '403': description: Unauthorized request. '404': description: Not found. '429': description: Too many requests. '500': content: application/json: examples: Error500: $ref: '#/components/examples/Error500Response' schema: $ref: '#/components/schemas/BasicErrorResponse' description: Unexpected error while processing request. '503': content: application/json: example: status: DOWN version: 1.0.0 description: The service is unhealthy. Several components are down. components: - id: app-db-memory name: Application Database Memory Usage type: DATABASE status: UP - id: adapter-server name: Adapter API Server type: ADAPTER status: DOWN - id: service-server name: API Server type: API status: DOWN time: 2022-11-01T05:12:08.131Z schema: $ref: '#/components/schemas/HealthCheckResponse' description: Service is unhealthy. summary: Commit credit note tags: - CreditNote x-accepts: application/json '/credit-notes/{creditNoteId}/void': post: description: >- This endpoint is used to void the credit note for a specific credit note id. Voiding reverses the credit note, thereby restoring the amount due on the invoice. operationId: voidCreditNote parameters: - description: >- The unique identifier of the credit note at the Tax Service Adapter or Tax Service Provider. explode: false in: path name: creditNoteId required: true schema: type: string style: simple - description: >- The unique identifier of the invoice at the Tax Service Adapter or Tax Service Provider. explode: true in: query name: invoiceId required: false schema: type: string style: form responses: '204': description: Credit note voided successfully. '401': description: Unauthenticated request. '403': description: Unauthorized request. '404': description: Not found. '429': description: Too many requests. '500': content: application/json: examples: Error500: $ref: '#/components/examples/Error500Response' schema: $ref: '#/components/schemas/BasicErrorResponse' description: Unexpected error while processing request. '503': content: application/json: example: status: DOWN version: 1.0.0 description: The service is unhealthy. Several components are down. components: - id: app-db-memory name: Application Database Memory Usage type: DATABASE status: UP - id: adapter-server name: Adapter API Server type: ADAPTER status: DOWN - id: service-server name: API Server type: API status: DOWN time: 2022-11-01T05:12:08.131Z schema: $ref: '#/components/schemas/HealthCheckResponse' description: Service is unhealthy. summary: Void credit note tags: - CreditNote x-accepts: application/json /address/validate: post: description: >- Checks whether a given address is a valid delivery address for shipping purposes. The tax provider can decide whether to mention the full or valid address depending on their requirement. operationId: validateAddress requestBody: content: application/json: examples: AddressValidationValidRequest: $ref: '#/components/examples/AddressValidationValidRequest' AddressValidationInvalidRequest: $ref: '#/components/examples/AddressValidationInvalidRequest' schema: $ref: '#/components/schemas/AddressValidationRequest' responses: '200': content: application/json: examples: AddressValidationValidResponse: $ref: '#/components/examples/AddressValidationValidResponse' AddressValidationInvalidResponse: $ref: '#/components/examples/AddressValidationInvalidResponse' schema: $ref: '#/components/schemas/AddressValidationResponse' description: Address is validated successfully '400': content: application/json: example: errors: - code: INVALID_DATA message: Empty address provided. entity: Address schema: $ref: '#/components/schemas/ValidationErrorResponse' description: Bad request. '401': description: Unauthenticated request. '403': description: Unauthorized request. '429': description: Too many requests. '500': content: application/json: examples: Error500: $ref: '#/components/examples/Error500Response' schema: $ref: '#/components/schemas/BasicErrorResponse' description: Unexpected error while processing request. '503': content: application/json: example: status: DOWN version: 1.0.0 description: The service is unhealthy. Several components are down. components: - id: app-db-memory name: Application Database Memory Usage type: DATABASE status: UP - id: adapter-server name: Adapter API Server type: ADAPTER status: DOWN - id: service-server name: API Server type: API status: DOWN time: 2022-11-01T05:12:08.131Z schema: $ref: '#/components/schemas/HealthCheckResponse' description: Service is unhealthy. summary: Address validation tags: - Address x-content-type: application/json x-accepts: application/json /address/check-taxability: post: description: >- Checks whether the tax address is valid in terms of tax calculation. This endpoint checks whether the address information of the customer is sufficient for the tax provider to return a tax rate. It does not consider the nexus status of the merchant and is mandatory to integrate for the tax provider. operationId: checkAddressTaxability requestBody: content: application/json: examples: CheckAddressTaxabilityValidRequest-Option1: $ref: >- #/components/examples/CheckAddressTaxabilityValidRequest-Option1 CheckAddressTaxabilityInvalidRequest-Option1: $ref: >- #/components/examples/CheckAddressTaxabilityInvalidRequest-Option1 CheckAddressTaxabilityValidRequest-Option2: $ref: >- #/components/examples/CheckAddressTaxabilityValidRequest-Option2 CheckAddressTaxabilityInvalidRequest-Option2: $ref: >- #/components/examples/CheckAddressTaxabilityInvalidRequest-Option2 CheckAddressTaxabilityValidRequest-Option3: $ref: >- #/components/examples/CheckAddressTaxabilityValidRequest-Option3 CheckAddressTaxabilityInvalidRequest-Option3: $ref: >- #/components/examples/CheckAddressTaxabilityInvalidRequest-Option3 schema: $ref: '#/components/schemas/CheckAddressTaxabilityRequest' responses: '200': content: application/json: examples: CheckAddressTaxabilityValidResponse-Option1: $ref: >- #/components/examples/CheckAddressTaxabilityValidResponse-Option1 CheckAddressTaxabilityInvalidResponse-Option1: $ref: >- #/components/examples/CheckAddressTaxabilityInvalidResponse-Option1 CheckAddressTaxabilityValidResponse-Option2: $ref: >- #/components/examples/CheckAddressTaxabilityValidResponse-Option2 CheckAddressTaxabilityInvalidResponse-Option2: $ref: >- #/components/examples/CheckAddressTaxabilityInvalidResponse-Option2 CheckAddressTaxabilityValidResponse-Option3: $ref: >- #/components/examples/CheckAddressTaxabilityValidResponse-Option3 CheckAddressTaxabilityInvalidResponse-Option3: $ref: >- #/components/examples/CheckAddressTaxabilityInvalidResponse-Option3 schema: $ref: '#/components/schemas/CheckAddressTaxabilityResponse' description: Tax can be calculated for the address provided. '400': content: application/json: example: errors: - code: INVALID_DATA message: Empty address provided. entity: Address schema: $ref: '#/components/schemas/ValidationErrorResponse' description: Bad request. '401': description: Unauthenticated request. '403': description: Unauthorized request. '429': description: Too many requests. '500': content: application/json: examples: Error500: $ref: '#/components/examples/Error500Response' schema: $ref: '#/components/schemas/BasicErrorResponse' description: Unexpected error while processing request. '503': content: application/json: example: status: DOWN version: 1.0.0 description: The service is unhealthy. Several components are down. components: - id: app-db-memory name: Application Database Memory Usage type: DATABASE status: UP - id: adapter-server name: Adapter API Server type: ADAPTER status: DOWN - id: service-server name: API Server type: API status: DOWN time: 2022-11-01T05:12:08.131Z schema: $ref: '#/components/schemas/HealthCheckResponse' description: Service is unhealthy. summary: Check taxability tags: - Address x-content-type: application/json x-accepts: application/json components: examples: TaxEstimationRequestSimple: description: A sample tax estimation request. value: seller: address: line1: 412 63rd South Avenue city: Baltimore state: MD country: US postalCode: '21230' customer: name: John Doe customerCode: customer_test address: line1: '59, Starlight Avenue' city: Newark state: NJ country: US postalCode: '98712' estimateDateTime: 2022-11-01T05:12:08.131Z currency: USD lineItems: - number: 1 itemCode: cbWatch description: A winding watch. quantity: 1 amount: 100 isTaxInclusive: false taxIdentifiers: - id: taxCode value: PT12312 TaxEstimationResponseSimple: description: A sample response to the tax estimation request. value: seller: address: line1: 412 63rd South Avenue city: Baltimore state: MD country: US postalCode: '21230' hasNexus: true customer: customerCode: customer_test address: line1: '59, Starlight Avenue' city: Newark state: NJ country: US postalCode: '98712' estimateDateTime: 2022-11-01T05:12:08.131Z currency: USD discountAmount: 0 subtotal: 100 exemptAmount: 0 taxableAmount: 100 taxAmount: 15 total: 115 lineItems: - number: 1 itemCode: cbWatch description: A winding watch. quantity: 1 amount: 100 isTaxInclusive: false isTaxable: true taxIdentifiers: - id: taxCode value: PT12312 discountAmount: 0 subtotal: 100 exemptAmount: 0 taxableAmount: 100 taxAmount: 15 total: 115 taxes: - number: 1 jurisdiction: code: '48' type: STATE name: CALIFORNIA name: SALE rate: 5 taxableAmount: 100 taxAmount: 5 - number: 2 jurisdiction: code: '27000' type: CITY name: SAN FRANCISCO name: SALE rate: 10 taxableAmount: 100 taxAmount: 10 TaxEstimationRequestWithTaxInclusive: description: A sample tax estimation request with tax inclusive. value: seller: address: line1: 412 63rd South Avenue city: Baltimore state: MD country: US postalCode: '21230' customer: name: John Doe customerCode: customer_test address: line1: 20 W 34th St city: New York state: NY country: US postalCode: '10001' estimateDateTime: 2022-11-01T05:12:08.131Z currency: USD lineItems: - number: 1 itemCode: cbWatch description: A winding watch. quantity: 1 amount: 100 isTaxInclusive: true taxIdentifiers: - id: taxCode value: PT12312 TaxEstimationResponseWithTaxInclusive: description: A sample response to the tax estimation request with tax inclusive. value: seller: address: line1: 412 63rd South Avenue city: Baltimore state: MD country: US postalCode: '21230' hasNexus: true customer: name: John Doe customerCode: customer_test address: line1: 20 W 34th St city: New York state: NY country: US postalCode: '10001' estimateDateTime: 2022-11-01T05:12:08.131Z currency: USD discountAmount: 0 subtotal: 100 exemptAmount: 0 taxableAmount: 91.85 taxAmount: 8.15 total: 100 lineItems: - number: 1 itemCode: cbWatch description: A winding watch. quantity: 1 amount: 100 isTaxInclusive: true isTaxable: true taxIdentifiers: - id: taxCode value: PT12312 discountAmount: 0 subtotal: 100 exemptAmount: 0 taxableAmount: 91.85 taxAmount: 8.15 total: 100 taxes: - number: 1 jurisdiction: code: '24354' type: STATE name: NEW YORK name: SELLER_USE rate: 4 taxableAmount: 91.85 taxAmount: 3.67 - number: 2 jurisdiction: code: '25353' type: CITY name: NEW YORK name: SELLER_USE rate: 4.5 taxableAmount: 91.85 taxAmount: 4.14 - number: 3 jurisdiction: code: '79774' type: OTHER name: METROPOLITAN COMMUTER TRANSPORTATION DISTRICT name: SELLER_USE rate: 0.375 taxableAmount: 91.85 taxAmount: 0.34 TaxEstimationRequestWithLineItemDiscount: description: >- A sample tax estimation request consisting of a line item with a corresponding discount. value: seller: address: line1: 412 63rd South Avenue city: Baltimore state: MD country: US postalCode: '21230' customer: name: John Doe customerCode: customer_test address: line1: '59, Starlight Avenue' city: Newark state: NJ country: US postalCode: '98712' estimateDateTime: 2022-11-01T05:12:08.131Z currency: USD lineItems: - number: 1 amount: 100 itemCode: cbWatch description: A winding watch. quantity: 1 discountAmount: 10 isTaxInclusive: false TaxEstimationResponseWithLineItemDiscount: description: >- A sample response to the tax estimation request consisting of a line item with a corresponding discount. value: seller: address: line1: 412 63rd South Avenue city: Baltimore state: MD country: US postalCode: '21230' hasNexus: true customer: name: John Doe customerCode: customer_test address: line1: '59, Starlight Avenue' city: Newark state: NJ country: US postalCode: '98712' estimateDateTime: 2022-11-01T05:12:08.131Z currency: USD discountAmount: 10 subtotal: 110 exemptAmount: 0 taxableAmount: 100 taxAmount: 5 total: 115 lineItems: - number: 1 itemCode: cbWatch description: A winding watch. quantity: 1 amount: 110 isTaxInclusive: false isTaxable: true exemptAmount: 0 discountAmount: 10 subtotal: 100 taxableAmount: 100 taxAmount: 5 total: 110 taxes: - number: 1 jurisdiction: code: '48' type: STATE name: CALIFORNIA name: SALE rate: 2.5 taxableAmount: 100 taxAmount: 2.5 - number: 2 jurisdiction: code: '27000' type: CITY name: SAN FRANCISCO name: SALE rate: 2.5 taxableAmount: 100 taxAmount: 2.5 TaxEstimationRequestWithCustomerExemption: description: >- A sample tax estimation request for a tax-exempt customer using an exemption code. value: seller: address: line1: 412 63rd South Avenue city: Baltimore state: MD country: US postalCode: '21230' customer: name: John Doe customerCode: customer_test address: line1: '59, Starlight Avenue' city: Newark state: NJ country: US postalCode: '98712' taxIdentifiers: - id: exemptionCode value: ex_gg1s2149812312 estimateDateTime: 2022-11-01T05:12:08.131Z currency: USD lineItems: - number: 1 itemCode: cbWatch description: A winding watch. quantity: 1 amount: 110 isTaxInclusive: false taxIdentifiers: - id: taxCode value: PT12312 TaxEstimationResponseWithCustomerExemption: description: >- A sample response to the tax estimation request for a tax-exempt customer using an exemption code. value: seller: address: line1: 412 63rd South Avenue city: Baltimore state: MD country: US postalCode: '21230' hasNexus: true customer: name: John Doe customerCode: customer_test address: line1: '59, Starlight Avenue' city: Newark state: NJ country: US postalCode: '98712' taxIdentifiers: - id: exemptionCode value: ex_gg1s2149812312 - id: category value: category1 estimateDateTime: 2022-11-01T05:12:08.131Z currency: USD discountAmount: 0 subtotal: 110 exemptAmount: 110 taxableAmount: 0 taxAmount: 0 total: 110 lineItems: - number: 1 itemCode: cbWatch description: A winding watch. quantity: 1 amount: 110 isTaxInclusive: false isTaxable: true taxIdentifiers: - id: taxCode value: PT12312 taxExemptType: CUSTOMER_EXEMPT taxExemptReason: The customer is exempt from taxes exemptAmount: 110 discountAmount: 0 subtotal: 110 taxableAmount: 0 taxAmount: 0 total: 0 taxes: - number: 1 jurisdiction: code: '48' type: STATE name: CALIFORNIA name: SALE rate: 5 taxableAmount: 0 taxAmount: 0 - number: 2 jurisdiction: code: '27000' type: CITY name: SAN FRANCISCO name: SALE rate: 10 taxableAmount: 0 taxAmount: 0 InvoiceRequestSimple: description: A request to create a simple invoice in the tax provider system. value: invoiceCode: inv_1234 documentDateTime: 2022-11-01T05:12:08.131Z currency: USD seller: address: line1: 412 63rd South Avenue city: Baltimore state: MD country: US postalCode: '21230' customer: name: John Doe customerCode: customer_test address: line1: '59, Starlight Avenue' city: Newark state: NJ country: US postalCode: '98712' subtotal: 100 exemptAmount: 0 discountAmount: 0 taxableAmount: 100 taxAmount: 15 total: 115 lineItems: - number: 1 itemCode: cbWatch description: A winding watch. quantity: 1 amount: 100 isTaxInclusive: false isTaxable: true taxIdentifiers: - id: taxCode value: PT12312 discountAmount: 0 subtotal: 100 exemptAmount: 0 taxableAmount: 100 taxAmount: 15 total: 115 taxes: - number: 1 jurisdiction: code: '48' type: STATE name: CALIFORNIA name: SALE rate: 5 taxableAmount: 100 taxAmount: 5 - number: 2 jurisdiction: code: '27000' type: CITY name: SAN FRANCISCO name: SALE rate: 10 taxableAmount: 100 taxAmount: 10 InvoiceResponseSimple: description: A simple invoice in the tax provider system. value: invoiceId: disney_001 invoiceCode: inv_1234 status: PENDING documentDateTime: 2022-11-01T05:12:08.131Z currency: USD seller: address: line1: 412 63rd South Avenue city: Baltimore state: MD country: US postalCode: '21230' hasNexus: true customer: name: John Doe customerCode: customer_test address: line1: '59, Starlight Avenue' city: Newark state: NJ country: US postalCode: '98712' subtotal: 100 discountAmount: 0 exemptAmount: 0 taxableAmount: 100 taxAmount: 15 total: 115 lineItems: - number: 1 itemCode: cbWatch description: A winding watch. quantity: 1 amount: 100 isTaxInclusive: false isTaxable: true taxIdentifiers: - id: taxCode value: PT12312 exemptAmount: 0 discountAmount: 0 subtotal: 100 taxableAmount: 100 taxAmount: 15 total: 115 taxes: - number: 1 jurisdiction: code: '48' type: STATE name: CALIFORNIA name: SALE rate: 5 taxableAmount: 100 taxAmount: 5 - number: 2 jurisdiction: code: '27000' type: CITY name: SAN FRANCISCO name: SALE rate: 10 taxableAmount: 100 taxAmount: 10 InvoiceRequestWithTaxInclusive: description: >- A request to create a simple invoice in the tax provider system with tax inclusive. value: invoiceCode: inv_1234 documentDateTime: 2022-11-01T05:12:08.131Z currency: USD seller: address: line1: 412 63rd South Avenue city: Baltimore state: MD country: US postalCode: '21230' customer: name: John Doe customerCode: customer_test address: line1: 20 W 34th St city: New York state: NY country: US postalCode: '10001' subtotal: 91.85 exemptAmount: 0 discountAmount: 0 taxableAmount: 91.85 taxAmount: 8.15 total: 100 lineItems: - number: 1 itemCode: cbWatch description: A winding watch. quantity: 1 amount: 100 isTaxInclusive: true isTaxable: true taxIdentifiers: - id: taxCode value: PT12312 discountAmount: 0 subtotal: 100 exemptAmount: 0 taxableAmount: 91.85 taxAmount: 8.15 total: 100 taxes: - number: 1 jurisdiction: code: '24354' type: STATE name: NEW YORK name: SELLER_USE rate: 4 taxableAmount: 91.85 taxAmount: 3.67 - number: 2 jurisdiction: code: '25353' type: CITY name: NEW YORK name: SELLER_USE rate: 4.5 taxableAmount: 91.85 taxAmount: 4.14 - number: 3 jurisdiction: code: '79774' type: OTHER name: METROPOLITAN COMMUTER TRANSPORTATION DISTRICT name: SELLER_USE rate: 0.375 taxableAmount: 91.85 taxAmount: 0.34 InvoiceResponseWithTaxInclusive: description: A simple invoice in the tax provider system with tax inclusive. value: invoiceId: disney_001 invoiceCode: inv_1234 status: PENDING documentDateTime: 2022-11-01T05:12:08.131Z currency: USD seller: address: line1: 412 63rd South Avenue city: Baltimore state: MD country: US postalCode: '21230' hasNexus: true customer: name: John Doe customerCode: customer_test address: line1: 20 W 34th St city: New York state: NY country: US postalCode: '10001' subtotal: 91.85 exemptAmount: 0 discountAmount: 0 taxableAmount: 91.85 taxAmount: 8.15 total: 100 lineItems: - number: 1 itemCode: cbWatch description: A winding watch. quantity: 1 amount: 100 isTaxInclusive: true isTaxable: true taxIdentifiers: - id: taxCode value: PT12312 discountAmount: 0 subtotal: 100 exemptAmount: 0 taxableAmount: 91.85 taxAmount: 8.15 total: 100 taxes: - number: 1 jurisdiction: code: '24354' type: STATE name: NEW YORK name: SELLER_USE rate: 4 taxableAmount: 91.85 taxAmount: 3.67 - number: 2 jurisdiction: code: '25353' type: CITY name: NEW YORK name: SELLER_USE rate: 4.5 taxableAmount: 91.85 taxAmount: 4.14 - number: 3 jurisdiction: code: '79774' type: OTHER name: METROPOLITAN COMMUTER TRANSPORTATION DISTRICT name: SELLER_USE rate: 0.375 taxableAmount: 91.85 taxAmount: 0.34 CreditNoteRequestFull: description: A request to send a credit note to the Tax Service Adapter. value: creditNoteCode: cn_2023_11_24_178 invoiceCode: inv_2023_11_30_78 invoiceId: disney_001 creditNoteType: FULL documentDateTime: 2022-11-01T05:12:08.131Z currency: USD seller: address: line1: 412 63rd South Avenue city: Baltimore state: MD country: US postalCode: '21230' customer: name: John Doe customerCode: customer_test address: line1: '59, Starlight Avenue' city: Newark state: NJ country: US postalCode: '98712' subtotal: 100 exemptAmount: 0 discountAmount: 0 taxableAmount: 100 taxAmount: 15 total: 115 CreditNoteResponseFull: description: >- The response from the Tax Service Adapter SPI containing the details of a credit note sent by Chargebee. value: creditNoteId: disney_002 creditNoteCode: cn_2023_11_24_178 invoiceCode: inv_2023_11_30_78 invoiceId: disney_001 status: PENDING creditNoteType: FULL documentDateTime: 2022-11-01T05:12:08.131Z currency: USD seller: address: line1: 412 63rd South Avenue city: Baltimore state: MD country: US postalCode: '21230' hasNexus: true customer: name: John Doe customerCode: customer_test address: line1: '59, Starlight Avenue' city: Newark state: NJ country: US postalCode: '98712' discountAmount: 0 subTotal: 100 exemptAmount: 0 taxableAmount: 100 taxAmount: 15 total: 115 lineItems: - number: 1 itemCode: cbWatch description: A winding watch. quantity: 1 amount: 100 isTaxInclusive: false isTaxable: true taxIdentifiers: - id: taxCode value: PT12312 exemptAmount: 0 discountAmount: 0 subtotal: 100 taxableAmount: 100 taxAmount: 15 total: 115 taxes: - number: 1 jurisdiction: code: '48' type: STATE name: CALIFORNIA name: SALE rate: 5 taxableAmount: 100 taxAmount: 5 - number: 2 jurisdiction: code: '27000' type: CITY name: SAN FRANCISCO name: SALE rate: 10 taxableAmount: 100 taxAmount: 10 CreditNoteRequestFullWithTaxInclusive: description: >- A request to send a credit note to the Tax Service Adapter with tax inclusive.. value: creditNoteCode: inv_1235 invoiceCode: disney_001 creditNoteType: FULL documentDateTime: 2022-11-01T05:12:08.131Z seller: address: line1: 412 63rd South Avenue city: Baltimore state: MD country: US postalCode: '21230' customer: name: John Doe customerCode: customer_test address: line1: 20 W 34th St city: New York state: NY country: US postalCode: '10001' currency: USD discountAmount: 0 subtotal: 100 exemptAmount: 0 taxableAmount: 91.85 taxAmount: 8.15 total: 100 lineItems: - number: 1 itemCode: cbWatch description: A winding watch. quantity: 1 amount: 100 isTaxInclusive: true isTaxable: true taxIdentifiers: - id: taxCode value: PT12312 discountAmount: 0 subtotal: 100 exemptAmount: 0 taxableAmount: 91.85 taxAmount: 8.15 total: 100 taxes: - number: 1 jurisdiction: code: '24354' type: STATE name: NEW YORK name: SELLER_USE rate: 4 taxableAmount: 91.85 taxAmount: 3.67 - number: 2 jurisdiction: code: '25353' type: CITY name: NEW YORK name: SELLER_USE rate: 4.5 taxableAmount: 91.85 taxAmount: 4.14 - number: 3 jurisdiction: code: '79774' type: OTHER name: METROPOLITAN COMMUTER TRANSPORTATION DISTRICT name: SELLER_USE rate: 0.375 taxableAmount: 91.85 taxAmount: 0.34 CreditNoteResponseFullWithTaxInclusive: description: >- The response from the Tax Service Adapter SPI containing the details of a credit note sent by Chargebee with tax inclusive.. value: creditNoteId: disney_002 creditNoteCode: disney_001 invoiceCode: inv_1235 status: PENDING creditNoteType: FULL documentDateTime: 2022-11-01T05:12:08.131Z seller: address: line1: 412 63rd South Avenue city: Baltimore state: MD country: US postalCode: '21230' hasNexus: true customer: name: John Doe customerCode: customer_test address: line1: 20 W 34th St city: New York state: NY country: US postalCode: '10001' currency: USD discountAmount: 0 subtotal: 100 exemptAmount: 0 taxableAmount: 91.85 taxAmount: 8.15 total: 100 lineItems: - number: 1 itemCode: cbWatch description: A winding watch. quantity: 1 amount: 100 isTaxInclusive: true isTaxable: true taxIdentifiers: - id: taxCode value: PT12312 discountAmount: 0 subtotal: 100 exemptAmount: 0 taxableAmount: 91.85 taxAmount: 8.15 total: 100 taxes: - number: 1 jurisdiction: code: '24354' type: STATE name: NEW YORK name: SELLER_USE rate: 4 taxableAmount: 91.85 taxAmount: 3.67 - number: 2 jurisdiction: code: '25353' type: CITY name: NEW YORK name: SELLER_USE rate: 4.5 taxableAmount: 91.85 taxAmount: 4.14 - number: 3 jurisdiction: code: '79774' type: OTHER name: METROPOLITAN COMMUTER TRANSPORTATION DISTRICT name: SELLER_USE rate: 0.375 taxableAmount: 91.85 taxAmount: 0.34 Error400ResponseInvalidCreditNoteId: description: Credit note id is invalid. summary: Invalid credit note id. value: errors: - code: INVALID_DATA message: Credit note id is not valid. entity: CreditNoteId entityField: creditNoteId Error400ResponseInvalidTaxCode: description: Item tax code is invalid. summary: Invalid item tax code. value: errors: - code: INVALID_DATA message: Invalid tax code is provided. entity: LineItem entityField: 'lineItem[0].productTaxCode' helpUrl: 'https://taxes.provider.com/tax-codes' Error400ResponseMissingCustomerAddress: description: Customer address is empty. summary: Missing customer address. value: errors: - code: MISSING_REQUIRED_DATA entity: Customer entityField: customer.address message: Customer address cannot be empty. Error500Response: description: Unexpected error during processing the request. summary: Unexpected error. value: message: Unexpected error during processing the request. AddressValidationValidRequest: description: Valid address request summary: Valid address request for full address verification value: address: line1: 1000 main line2: '' line3: '' city: Irvine state: CA country: US postalCode: '92615' AddressValidationInvalidRequest: description: Invalid address request summary: Invalid address request for full address verification value: address: line1: 1000 MAIN ST line2: '' line3: '' city: IRVINE state: CA country: US postalCode: '92614' AddressValidationValidResponse: description: >- Valid address verification response when address is validated successfully summary: Valid address verification response value: status: VALID AddressValidationInvalidResponse: description: The address provided for verification was Invalid summary: Invalid address verification response value: status: INVALID CheckAddressTaxabilityValidRequest-Option1: description: >- Taxable address with combination of city,state,country,postalCode sent in a post request summary: Taxable address request (city + state + country + postalCode) value: address: line1: '' line2: '' line3: '' city: IRVINE state: CA country: US postalCode: '92614' CheckAddressTaxabilityInvalidRequest-Option1: description: >- Non-taxable address with combination of city,state,country,postalCode sent in a post request summary: Non-taxable address request (city + state + country + postalCode) value: address: line1: '' line2: '' line3: '' city: Irvine state: CA country: US postalCode: '88777' CheckAddressTaxabilityValidResponse-Option1: description: >- Valid Response based on combination of city,state,country,postalCode sent in a post request summary: Taxable address Response (city + state + country + postalCode) value: isTaxable: true CheckAddressTaxabilityInvalidResponse-Option1: description: >- Invalid Response based on combination of city,state,country,postalCode sent in a post request summary: Non-taxable address Response (city + state + country + postalCode) value: isTaxable: false CheckAddressTaxabilityValidRequest-Option2: description: >- Taxable address with combination of city,country,postalCode sent in a post request summary: Taxable address request (city + country + postalCode) value: address: line1: '' line2: '' line3: '' state: '' city: Irvine country: US postalCode: '92615' CheckAddressTaxabilityInvalidRequest-Option2: description: Shows a non-taxable address sent in a post request summary: Non-taxable address request (city + country + postalCode) value: address: line1: '' line2: '' line3: '' state: '' city: Irvine country: US postalCode: '83835' CheckAddressTaxabilityValidResponse-Option2: description: >- Valid Response based on combination of city,country,postalCode sent in a post request summary: Taxable address response (city + country + postalCode) value: isTaxable: true CheckAddressTaxabilityInvalidResponse-Option2: description: >- Invalid response based on combination of city,country,postalCode sent in a post request summary: Non-taxable address response (city + country + postalCode) value: isTaxable: false CheckAddressTaxabilityValidRequest-Option3: description: >- Taxable address with combination of city,state,postalCode sent in a post request summary: Taxable address request (postalCode) value: address: line1: '' line2: '' line3: '' city: '' state: '' country: '' postalCode: '92614' CheckAddressTaxabilityInvalidRequest-Option3: description: >- Non-taxable address with combination of city,state,postalCode sent in a post request summary: Non-taxable address request (postalCode) value: address: line1: '' line2: '' line3: '' city: '' state: '' country: '' postalCode: '45645' CheckAddressTaxabilityValidResponse-Option3: description: >- Valid response based on combination of city,state,postalCode sent in a post request summary: Taxable address response (postalCode) value: isTaxable: true CheckAddressTaxabilityInvalidResponse-Option3: description: >- Non-taxable address response based on combination of city,state,postalCode sent in a post request summary: Non-taxable address response (postalCode) value: isTaxable: false Error400ResponseMissingMerchantId: description: Merchant id is empty. summary: Empty merchant id. value: code: INVALID_REQUEST message: Merchant id cannot be empty. detail: Please provide a valid Merchant id. Error400ResponseInvalidMerchantId: description: Merchant id is invalid. summary: Empty merchant id. value: code: INVALID_REQUEST message: Invalid Merchant id. detail: Please provide a valid merchant id. parameters: InvoiceIdPathParam: description: >- The unique identifier of the invoice at the Tax Service Adapter or Tax Service Provider. explode: false in: path name: invoiceId required: true schema: type: string style: simple InvoiceIdQueryParam: description: >- The unique identifier of the invoice at the Tax Service Adapter or Tax Service Provider. explode: true in: query name: invoiceId required: false schema: type: string style: form CreditNoteIdPathParam: description: >- The unique identifier of the credit note at the Tax Service Adapter or Tax Service Provider. explode: false in: path name: creditNoteId required: true schema: type: string style: simple MerchantIdPathParam: description: The id of the merchantId provided to the tax provider. explode: false in: path name: merchantId required: true schema: maxLength: 50 type: string style: simple responses: Error400TaxEstimate: content: application/json: examples: Error400ResponseInvalidTaxCode: $ref: '#/components/examples/Error400ResponseInvalidTaxCode' Error400ResponseMissingCustomerAddress: $ref: '#/components/examples/Error400ResponseMissingCustomerAddress' schema: $ref: '#/components/schemas/ValidationErrorResponse' description: Bad request. Error400Invoice: content: application/json: examples: Error400ResponseInvalidTaxCode: $ref: '#/components/examples/Error400ResponseInvalidTaxCode' Error400ResponseMissingCustomerAddress: $ref: '#/components/examples/Error400ResponseMissingCustomerAddress' schema: $ref: '#/components/schemas/ValidationErrorResponse' description: Bad request. Error400CreditNote: content: application/json: examples: Error400ResponseInvalidCreditNoteId: $ref: '#/components/examples/Error400ResponseInvalidCreditNoteId' Error400ResponseMissingCustomerAddress: $ref: '#/components/examples/Error400ResponseMissingCustomerAddress' schema: $ref: '#/components/schemas/ValidationErrorResponse' description: Bad request. Error429: description: Too many requests. Error500: content: application/json: examples: Error500: $ref: '#/components/examples/Error500Response' schema: $ref: '#/components/schemas/BasicErrorResponse' description: Unexpected error while processing request. Error503: content: application/json: example: status: DOWN version: 1.0.0 description: The service is unhealthy. Several components are down. components: - id: app-db-memory name: Application Database Memory Usage type: DATABASE status: UP - id: adapter-server name: Adapter API Server type: ADAPTER status: DOWN - id: service-server name: API Server type: API status: DOWN time: 2022-11-01T05:12:08.131Z schema: $ref: '#/components/schemas/HealthCheckResponse' description: Service is unhealthy. Error401: description: Unauthenticated request. Error403: description: Unauthorized request. Error404: description: Not found. schemas: TaxEstimationRequest: additionalProperties: false description: >- Defines the parameters of a tax estimation request. This is sent to the Tax Service Adapter by Chargebee to estimate taxes for one or more line items. example: seller: address: country: country city: city postalCode: postalCode state: state line3: line3 line2: line2 line1: line1 taxRegistrationNumber: taxRegistrationNumber hasNexus: true lineItems: - unitPrice: 0.14658129805029452 number: 1 amount: 5.962133916683182 quantity: 0.6027456183070403 itemCode: itemCode description: description discountAmount: 5.637376656633329 isTaxInclusive: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value - unitPrice: 0.14658129805029452 number: 1 amount: 5.962133916683182 quantity: 0.6027456183070403 itemCode: itemCode description: description discountAmount: 5.637376656633329 isTaxInclusive: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value - unitPrice: 0.14658129805029452 number: 1 amount: 5.962133916683182 quantity: 0.6027456183070403 itemCode: itemCode description: description discountAmount: 5.637376656633329 isTaxInclusive: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value - unitPrice: 0.14658129805029452 number: 1 amount: 5.962133916683182 quantity: 0.6027456183070403 itemCode: itemCode description: description discountAmount: 5.637376656633329 isTaxInclusive: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value - unitPrice: 0.14658129805029452 number: 1 amount: 5.962133916683182 quantity: 0.6027456183070403 itemCode: itemCode description: description discountAmount: 5.637376656633329 isTaxInclusive: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value estimateDateTime: 2000-01-23T04:56:07.000Z currency: currency customer: address: country: country city: city postalCode: postalCode state: state line3: line3 line2: line2 line1: line1 name: name customerCode: customerCode taxRegistrationNumber: taxRegistrationNumber hasNexus: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value properties: seller: $ref: '#/components/schemas/Seller' customer: $ref: '#/components/schemas/Customer' estimateDateTime: description: >- The time as of which the tax estimation is to be calculated. This can be a value in the past. For example, if the value is provided as 2022-10-28T15:36:28.129+05:30, then the tax rates applicable on October 28, 2022, at 15:36:28.129, with an offset of +05:30 ahead of UTC/GMT are used for calculations. In case of a merchant site located in UTC, these data types would send a timestamp in the format 2022-11-11T15:40:44.65Z. This timestamp represents November 11, 2022, at 15:40:44.65, with the 'Z' indicating that the time is in UTC format: date-time type: string currency: description: >- The [currency](https://en.wikipedia.org/wiki/Currency) in the [ISO-4217 format](https://www.iso.org/iso-4217-currency-codes.html). maxLength: 3 minLength: 3 type: string lineItems: description: >- Contains the details of each line item in the tax estimation request. items: $ref: '#/components/schemas/TaxEstimationLineItemRequest' maxItems: 1250 minItems: 1 type: array required: - currency - customer - estimateDateTime - lineItems - seller type: object TaxEstimationLineItemRequest: additionalProperties: false description: Represents the details of a line item in a tax estimation request. example: unitPrice: 0.14658129805029452 number: 1 amount: 5.962133916683182 quantity: 0.6027456183070403 itemCode: itemCode description: description discountAmount: 5.637376656633329 isTaxInclusive: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value properties: number: description: Index or serial number of the line item. minimum: 1 type: integer itemCode: description: >- The unique identifier (in Chargebee) of the product corresponding to the line item. If the line item corresponds to a one-off charge, then this identifier is not provided. maxLength: 50 type: string description: description: The description of the line item. maxLength: 250 type: string quantity: description: The quantity associated with this line item. format: double minimum: 0 type: number unitPrice: description: >- The unit price for this line item. In case of [tiered pricing](https://www.chargebee.com/docs/1.0/plans.html#tiered-pricing) where the unit price varies for each quantity tier, this is the average unit price. format: double minimum: 0 type: number amount: description: The amount for this line item. This is `unitPrice` × `quantity`. format: double type: number discountAmount: description: The discount applied to this line item. format: double type: number isTaxInclusive: description: >- Indicates whether (`amount` - `discountAmount`) is inclusive of taxes. type: boolean taxIdentifiers: description: The tax code fields of the product used for tax calculation. items: $ref: '#/components/schemas/FieldItem' maxItems: 10 type: array required: - amount - isTaxInclusive - number type: object TaxEstimationResponse: additionalProperties: false description: >- The response sent by the Tax Service Adapter to Chargebee for a tax estimation request. example: seller: address: country: country city: city postalCode: postalCode state: state line3: line3 line2: line2 line1: line1 taxRegistrationNumber: taxRegistrationNumber hasNexus: true lineItems: - unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value - unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value - unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value - unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value - unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value estimateDateTime: 2000-01-23T04:56:07.000Z taxableAmount: 5.962133916683182 total: 2.3021358869347655 subtotal: 0.8008281904610115 discountAmount: 1.4658129805029452 currency: currency exemptAmount: 6.027456183070403 taxAmount: 5.637376656633329 customer: address: country: country city: city postalCode: postalCode state: state line3: line3 line2: line2 line1: line1 name: name customerCode: customerCode taxRegistrationNumber: taxRegistrationNumber hasNexus: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value properties: seller: $ref: '#/components/schemas/Seller' customer: $ref: '#/components/schemas/Customer' estimateDateTime: description: >- The time as of which the tax estimation is to be calculated. This can be a value in the past. For example, if the value is provided as 2022-10-28T15:36:28.129+05:30, then the tax rates applicable on October 28, 2022, at 15:36:28.129, with an offset of +05:30 ahead of UTC/GMT are used for calculations. In case of a merchant site located in UTC, these data types would send a timestamp in the format 2022-11-11T15:40:44.65Z. This timestamp represents November 11, 2022, at 15:40:44.65, with the 'Z' indicating that the time is in UTC format: date-time type: string currency: description: >- The [currency](https://en.wikipedia.org/wiki/Currency) in the [ISO-4217 format](https://www.iso.org/iso-4217-currency-codes.html). maxLength: 3 minLength: 3 type: string subtotal: description: >- The amount after discounts. This is the sum of all `lineItems.subtotal`. format: double type: number exemptAmount: description: The part of the `subtotal` that is exempted from tax. format: double type: number discountAmount: description: >- The total discount applied. This is the sum of all `lineItems.discount`. format: double type: number taxableAmount: description: The part of the `subtotal` that is taxable. format: double type: number taxAmount: description: The total tax payable. This is the sum of all `lineItems.taxAmount`. format: double type: number total: description: >- The total after discounts and taxes. This is the same as `subtotal` if it is tax inclusive; otherwise it is `subtotal` + `taxAmount`. `total` can also be expressed as `exemptAmount` + `taxableAmount` + `taxAmount`. format: double type: number lineItems: description: List of line item details for the tax estimation response. items: $ref: '#/components/schemas/InvoiceLineItem' maxItems: 1250 minItems: 1 type: array required: - currency - customer - discountAmount - estimateDateTime - exemptAmount - lineItems - seller - subtotal - taxAmount - taxableAmount - total type: object InvoiceLineItem: additionalProperties: false description: The details of a line item. example: unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value properties: number: description: Index or serial number of the line item. minimum: 1 type: integer itemCode: description: >- The unique identifier (in Chargebee) of the product corresponding to the line item. If the line item corresponds to a one-off charge, then this identifier is not present. maxLength: 50 type: string description: description: The description of the line item. maxLength: 250 type: string quantity: description: The quantity associated with this line item. format: double minimum: 0 type: number unitPrice: description: >- The unit price for this line item. In case of [tiered pricing](https://www.chargebee.com/docs/1.0/plans.html#tiered-pricing) where the unit price varies for each quantity tier, this is the average unit price. format: double minimum: 0 type: number amount: description: The amount for this line item. This is `unitPrice` × `quantity`. format: double type: number subtotal: description: >- The amount after discounts for this line item. This is `amount` - `discountAmount`. format: double type: number isTaxInclusive: description: >- Indicates whether the `subtotal` for this line item is inclusive of taxes. type: boolean isTaxable: description: Indicates whether this line item is taxable. type: boolean taxIdentifiers: description: The tax code fields of the product used for tax calculation. items: $ref: '#/components/schemas/FieldItem' maxItems: 10 type: array taxExemptType: $ref: '#/components/schemas/TaxExemptType' taxExemptReason: description: >- The reason due to which a line item is exempted from tax. This is a mandatory parameter while applying tax exemption on any line-item. example: The customer is exempt from taxes. maxLength: 250 type: string exemptAmount: description: The part of this line item's `subtotal` that is exempted from tax. format: double type: number discountAmount: description: The discount applied to this line item. format: double type: number taxableAmount: description: The part of this line item's `subtotal` that is taxable. format: double type: number taxAmount: description: >- The tax payable for this line item. This is the sum of all `taxes.taxAmount` for this line item. format: double type: number total: description: >- The total for this line item after discounts and taxes. This is the same as `subtotal` if it is tax inclusive; otherwise it is `subtotal` + `taxAmount`. `total` can also be expressed as `exemptAmount` + `taxableAmount` + `taxAmount`. format: double type: number isPartialTax: description: Indicates if taxes were applied only partially for this line item. type: boolean taxes: description: List of taxes applied for this line item under each jurisdiction. items: $ref: '#/components/schemas/TaxLineItem' maxItems: 10 minItems: 0 type: array required: - amount - discountAmount - exemptAmount - isTaxInclusive - isTaxable - number - subtotal - taxAmount - taxableAmount - taxes - total type: object FieldItem: example: id: id value: value properties: id: description: The id of the field. maxLength: 50 type: string value: description: The value of the field. maxLength: 50 type: string required: - id - value type: object TaxLineItem: additionalProperties: false description: The details of tax applied under a specific jurisdiction. example: number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 properties: number: description: Index or serial number of this tax line item. minimum: 1 type: integer jurisdiction: $ref: '#/components/schemas/TaxJurisdiction' name: description: The name of the tax applied. example: GST type: string rate: description: The tax rate expressed in percentage. format: double maximum: 100 type: number taxableAmount: description: >- The part of the line item's `subtotal` that is taxable under this jurisdiction. format: double type: number taxAmount: description: The tax payable for the line item under this jurisdiction. format: double type: number required: - jurisdiction - name - number - rate - taxAmount - taxableAmount type: object InvoiceRequest: additionalProperties: false description: The details of an invoice sent to the Tax Service Adapter by Chargebee. example: seller: address: country: country city: city postalCode: postalCode state: state line3: line3 line2: line2 line1: line1 taxRegistrationNumber: taxRegistrationNumber hasNexus: true lineItems: - unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value - unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value - unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value - unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value - unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value taxableAmount: 5.962133916683182 total: 2.3021358869347655 subtotal: 0.8008281904610115 discountAmount: 1.4658129805029452 currency: currency exemptAmount: 6.027456183070403 taxAmount: 5.637376656633329 invoiceCode: invoiceCode documentDateTime: 2000-01-23T04:56:07.000Z customer: address: country: country city: city postalCode: postalCode state: state line3: line3 line2: line2 line1: line1 name: name customerCode: customerCode taxRegistrationNumber: taxRegistrationNumber hasNexus: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value properties: invoiceCode: description: The unique identifier of the invoice in Chargebee. maxLength: 50 type: string documentDateTime: description: >- The date and time at which the invoice was generated in Chargebee. For example, if the value is 2022-10-28T15:36:28.129+05:30, then the timestamp represents October 28, 2022, at 15:36:28.129, with an offset of +05:30. This means that the time represented is 5 hours and 30 minutes ahead of UTC/GMT.In the case of a merchant site located in UTC, these data types would send a timestamp in the format 2022-11-11T15:40:44.65Z. This timestamp represents November 11, 2022, at 15:40:44.65, with the 'Z' indicating that the time is in UTC. format: date-time type: string currency: description: >- The [currency](https://en.wikipedia.org/wiki/Currency) in the [ISO-4217 format](https://www.iso.org/iso-4217-currency-codes.html). maxLength: 3 minLength: 3 type: string seller: $ref: '#/components/schemas/Seller' customer: $ref: '#/components/schemas/Customer' subtotal: description: >- The amount after discounts. This is the sum of all `lineItems.subtotal`. format: double type: number exemptAmount: description: The part of the `subtotal` that is exempted from tax. format: double type: number discountAmount: description: >- The total discount applied. This is the sum of all `lineItems.discount`. format: double type: number taxableAmount: description: The part of the `subtotal` that is taxable. format: double type: number taxAmount: description: The total tax payable. This is the sum of all `lineItems.taxAmount`. format: double type: number total: description: >- The total after discounts and taxes. This is the same as `subtotal` if it is tax inclusive; otherwise it is `subtotal` + `taxAmount`. `total` can also be expressed as `exemptAmount` + `taxableAmount` + `taxAmount`. format: double type: number lineItems: items: $ref: '#/components/schemas/InvoiceLineItem' maxItems: 1250 minItems: 1 type: array required: - currency - customer - discountAmount - documentDateTime - exemptAmount - invoiceCode - lineItems - seller - subtotal - taxAmount - taxableAmount - total type: object Invoice: additionalProperties: false description: The details of an invoice as returned by the Tax Service Adapter. example: seller: address: country: country city: city postalCode: postalCode state: state line3: line3 line2: line2 line1: line1 taxRegistrationNumber: taxRegistrationNumber hasNexus: true taxableAmount: 5.962133916683182 discountAmount: 1.4658129805029452 exemptAmount: 6.027456183070403 invoiceCode: invoiceCode lineItems: - unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value - unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value - unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value - unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value - unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value total: 2.3021358869347655 subtotal: 0.8008281904610115 invoiceId: invoiceId currency: currency taxAmount: 5.637376656633329 documentDateTime: 2000-01-23T04:56:07.000Z status: null customer: address: country: country city: city postalCode: postalCode state: state line3: line3 line2: line2 line1: line1 name: name customerCode: customerCode taxRegistrationNumber: taxRegistrationNumber hasNexus: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value properties: invoiceId: description: >- The unique identifier of the invoice in the Tax Service Adapter or the Tax Service Provider. type: string invoiceCode: description: The unique identifier of the invoice in Chargebee. maxLength: 50 type: string documentDateTime: description: >- The date and time at which the invoice was generated in Chargebee. For example, if the value is 2022-10-28T15:36:28.129+05:30, then the timestamp represents October 28, 2022, at 15:36:28.129, with an offset of +05:30. This means that the time represented is 5 hours and 30 minutes ahead of UTC/GMT.In the case of a merchant site located in UTC, these data types would send a timestamp in the format 2022-11-11T15:40:44.65Z. This timestamp represents November 11, 2022, at 15:40:44.65, with the 'Z' indicating that the time is in UTC. format: date-time type: string status: $ref: '#/components/schemas/DocumentStatus' currency: description: >- The [currency](https://en.wikipedia.org/wiki/Currency) in the [ISO-4217 format](https://www.iso.org/iso-4217-currency-codes.html). maxLength: 3 minLength: 3 type: string seller: $ref: '#/components/schemas/Seller' customer: $ref: '#/components/schemas/Customer' subtotal: description: >- The amount after discounts. This is the sum of all `lineItems.subtotal`. format: double type: number exemptAmount: description: The part of the `subtotal` that is exempted from tax. format: double type: number discountAmount: description: >- The total discount applied. This is the sum of all `lineItems.discount`. format: double type: number taxableAmount: description: The part of the `subtotal` that is taxable. format: double type: number taxAmount: description: The total tax payable. This is the sum of all `lineItems.taxAmount`. format: double type: number total: description: >- The total after discounts and taxes. This is the same as `subtotal` if it is tax inclusive; otherwise it is `subtotal` + `taxAmount`. `total` can also be expressed as `exemptAmount` + `taxableAmount` + `taxAmount`. format: double type: number lineItems: items: $ref: '#/components/schemas/InvoiceLineItem' maxItems: 1250 minItems: 1 type: array required: - currency - customer - discountAmount - documentDateTime - exemptAmount - invoiceCode - invoiceId - lineItems - seller - status - subtotal - taxAmount - taxableAmount - total type: object CreditNoteRequest: additionalProperties: false description: >- The details of a credit note sent to the Tax Service Adapter by Chargebee. A credit note is used to reduce the amount due on an invoice. If the credit note is issued after payments have been made for the invoice, refunds can be issued to the Customer. example: seller: address: country: country city: city postalCode: postalCode state: state line3: line3 line2: line2 line1: line1 taxRegistrationNumber: taxRegistrationNumber hasNexus: true creditNoteType: null taxableAmount: 5.962133916683182 roundingAmount: 2.3021358869347655 creditNoteCode: creditNoteCode discountAmount: 1.4658129805029452 exemptAmount: 6.027456183070403 invoiceCode: invoiceCode lineItems: - unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value - unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value - unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value - unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value - unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value total: 0.8008281904610115 invoiceId: invoiceId currency: currency taxAmount: 5.637376656633329 documentDateTime: 2000-01-23T04:56:07.000Z customer: address: country: country city: city postalCode: postalCode state: state line3: line3 line2: line2 line1: line1 name: name customerCode: customerCode taxRegistrationNumber: taxRegistrationNumber hasNexus: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value properties: creditNoteCode: description: The unique identifier of the credit note in Chargebee. maxLength: 50 type: string invoiceCode: description: >- The unique identifier of the invoice in Chargebee to which this credit note belongs. maxLength: 50 type: string invoiceId: description: >- The unique identifier of the invoice in the Tax Service Adapter or the Tax Service Provider. type: string creditNoteType: $ref: '#/components/schemas/CreditNoteType' documentDateTime: description: >- The date and time at which the credit note was created in Chargebee. For example, if the value is 2022-10-28T15:36:28.129+05:30, then the timestamp represents October 28, 2022, at 15:36:28.129, with an offset of +05:30. This means that the time represented is 5 hours and 30 minutes ahead of UTC/GMT. In the case of a merchant site located in UTC, these data types would send a timestamp in the format 2022-11-11T15:40:44.65Z. This timestamp represents November 11, 2022, at 15:40:44.65, with the 'Z' indicating that the time is in UTC. format: date-time type: string currency: description: >- The [currency](https://en.wikipedia.org/wiki/Currency) in the [ISO-4217 format](https://www.iso.org/iso-4217-currency-codes.html). maxLength: 3 minLength: 3 type: string seller: $ref: '#/components/schemas/Seller' customer: $ref: '#/components/schemas/Customer' total: description: >- The total amount of the credit note. `total` can be expressed as `exemptAmount` + `taxableAmount` + `taxAmount`. format: double type: number exemptAmount: description: The amount exempted from tax. format: double type: number discountAmount: description: >- The total discount applied. This is the sum of all `lineItems.discount`. format: double type: number taxableAmount: description: The amount upon which the tax is calculated. format: double type: number taxAmount: description: The total tax payable. This is the sum of all `lineItems.taxAmount`. format: double type: number roundingAmount: description: >- The rounding amount added to the total amount to account for fractional correction. format: double type: number lineItems: items: $ref: '#/components/schemas/InvoiceLineItem' maxItems: 1250 minItems: 1 type: array required: - creditNoteCode - creditNoteType - currency - customer - discountAmount - documentDateTime - exemptAmount - invoiceCode - seller - taxAmount - taxableAmount - total type: object CreditNote: additionalProperties: false description: >- The details of a credit note returned by the Tax Service Adapter. A credit note is used to reduce the amount due on an invoice. If the credit note is issued after payments have been made for the invoice, refunds can be issued to the Customer. example: seller: address: country: country city: city postalCode: postalCode state: state line3: line3 line2: line2 line1: line1 taxRegistrationNumber: taxRegistrationNumber hasNexus: true creditNoteType: null taxableAmount: 5.962133916683182 roundingAmount: 7.061401241503109 creditNoteCode: creditNoteCode discountAmount: 0.8008281904610115 exemptAmount: 1.4658129805029452 invoiceCode: invoiceCode lineItems: - unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value - unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value - unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value - unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value - unitPrice: 0.3616076749251911 taxableAmount: 1.0246457001441578 amount: 2.027123023002322 quantity: 0.9301444243932576 itemCode: itemCode description: description isTaxable: true discountAmount: 1.2315135367772556 taxes: - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 - number: 1 taxableAmount: 4.965218492984954 rate: 11.730742509559434 jurisdiction: code: code name: name type: null name: GST taxAmount: 5.025004791520295 exemptAmount: 7.386281948385884 taxExemptType: null number: 1 total: 6.84685269835264 subtotal: 4.145608029883936 isTaxInclusive: true taxAmount: 1.4894159098541704 taxExemptReason: The customer is exempt from taxes. isPartialTax: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value total: 2.3021358869347655 subtotal: 6.027456183070403 invoiceId: invoiceId currency: currency creditNoteId: creditNoteId taxAmount: 5.637376656633329 documentDateTime: 2000-01-23T04:56:07.000Z status: null customer: address: country: country city: city postalCode: postalCode state: state line3: line3 line2: line2 line1: line1 name: name customerCode: customerCode taxRegistrationNumber: taxRegistrationNumber hasNexus: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value properties: creditNoteId: description: >- The unique identifier of the credit note at the Tax Service Provider or Tax Service Adapter. type: string creditNoteCode: description: The unique identifier of the credit note in Chargebee. maxLength: 50 type: string invoiceCode: description: >- The unique identifier of the invoice in Chargebee to which this credit note belongs. maxLength: 50 type: string invoiceId: description: >- The unique identifier of the invoice in the Tax Service Adapter or the Tax Service Provider. type: string creditNoteType: $ref: '#/components/schemas/CreditNoteType' documentDateTime: description: >- The date and time at which the credit note was created in Chargebee. For example, if the value is 2022-10-28T15:36:28.129+05:30, then the timestamp represents October 28, 2022, at 15:36:28.129, with an offset of +05:30. This means that the time represented is 5 hours and 30 minutes ahead of UTC/GMT. In the case of a merchant site located in UTC, these data types would send a timestamp in the format 2022-11-11T15:40:44.65Z. This timestamp represents November 11, 2022, at 15:40:44.65, with the 'Z' indicating that the time is in UTC. format: date-time type: string status: $ref: '#/components/schemas/DocumentStatus' currency: description: >- The [currency](https://en.wikipedia.org/wiki/Currency) in the [ISO-4217 format](https://www.iso.org/iso-4217-currency-codes.html). maxLength: 3 minLength: 3 type: string seller: $ref: '#/components/schemas/Seller' customer: $ref: '#/components/schemas/Customer' discountAmount: description: >- The total discount applied. This is the sum of all `lineItems.discount`. format: double type: number subtotal: description: >- The amount after discounts. This is the sum of all `lineItems.subtotal`. format: double type: number exemptAmount: description: The amount exempted from tax. format: double type: number taxableAmount: description: The amount upon which the tax is calculated. format: double type: number taxAmount: description: The total tax payable. This is the sum of all `lineItems.taxAmount`. format: double type: number total: description: >- The total amount of the credit note. `total` can be expressed as `exemptAmount` + `taxableAmount` + `taxAmount`. format: double type: number roundingAmount: description: >- The rounding amount added to the total amount to account for fractional correction. format: double type: number lineItems: items: $ref: '#/components/schemas/InvoiceLineItem' maxItems: 1250 minItems: 1 type: array required: - creditNoteCode - creditNoteId - creditNoteType - currency - customer - discountAmount - documentDateTime - exemptAmount - invoiceCode - lineItems - seller - status - subTotal - taxAmount - taxableAmount - total type: object Seller: additionalProperties: false description: >- The details of the seller involved in the transaction including company code and address. example: address: country: country city: city postalCode: postalCode state: state line3: line3 line2: line2 line1: line1 taxRegistrationNumber: taxRegistrationNumber hasNexus: true properties: taxRegistrationNumber: description: >- The tax registration number of a business in a country. For example, this is the GSTIN for India or the VAT number for EU or Australia. maxLength: 30 type: string address: $ref: '#/components/schemas/Address' hasNexus: description: >- Determines whether a tax nexus exists between the Seller and the tax authority at the address provided. type: boolean required: - address type: object Customer: additionalProperties: false description: The details of the Customer. example: address: country: country city: city postalCode: postalCode state: state line3: line3 line2: line2 line1: line1 name: name customerCode: customerCode taxRegistrationNumber: taxRegistrationNumber hasNexus: true taxIdentifiers: - id: id value: value - id: id value: value - id: id value: value - id: id value: value - id: id value: value properties: name: description: The name of the Customer in Chargebee. maxLength: 50 type: string customerCode: description: The unique identifier for the Customer in Chargebee. maxLength: 50 type: string address: $ref: '#/components/schemas/Address' taxRegistrationNumber: description: >- The tax registration number of a business in a country. For example, this is the GSTIN for India or the VAT number for EU or Australia. maxLength: 30 type: string taxIdentifiers: description: >- It represents the information related to the customer's tax identifiers. This includes details such as exemption status etc. items: $ref: '#/components/schemas/FieldItem' maxItems: 10 type: array hasNexus: description: >- Determines whether a tax nexus exists between the Seller and the tax authority at the address provided. type: boolean required: - address - customerCode type: object CreditNoteType: description: >- Whether the credit note was created for the full amount on the invoice or only for a part of the invoice amount. enum: - FULL - PARTIAL type: string DocumentStatus: description: Status of the invoice document. enum: - PENDING - COMMITTED - VOIDED type: string TaxRegistrationNumber: description: >- The tax registration number of a business in a country. For example, this is the GSTIN for India or the VAT number for EU or Australia. maxLength: 30 type: string TaxExemptType: description: >- The tax exemption type for a line item. This is a mandatory parameter while applying tax exemption on any line-item. enum: - PRODUCT_EXEMPT - CUSTOMER_EXEMPT - REGION_EXEMPT - REVERSE_CHARGE - ZERO_RATE_TAX - HIGH_VALUE_PHYSICAL_GOODS - EXPORT - ZERO_VALUE_ITEM - TAX_NOT_CONFIGURED type: string TaxExemptReason: description: >- The reason due to which a line item is exempted from tax. This is a mandatory parameter while applying tax exemption on any line-item. example: The customer is exempt from taxes. maxLength: 250 type: string TaxJurisdiction: additionalProperties: false description: The tax jurisdiction details. example: code: code name: name type: null properties: code: description: The jurisdiction code. maxLength: 50 type: string type: $ref: '#/components/schemas/TaxJurisdictionType' name: description: The jurisdiction name. maxLength: 50 type: string required: - code - name - type type: object TaxJurisdictionType: description: The type of tax jurisdiction. enum: - COUNTRY - FEDERAL - STATE - COUNTY - CITY - SPECIAL - OTHER type: string Currency: description: >- The [currency](https://en.wikipedia.org/wiki/Currency) in the [ISO-4217 format](https://www.iso.org/iso-4217-currency-codes.html). maxLength: 3 minLength: 3 type: string TaxRate: description: The tax rate expressed in percentage. format: double maximum: 100 type: number AddressValidationRequest: additionalProperties: false description: >- The verification request containing the address. The following fields are mandatory - - line1 - city - postalCode - state - country example: address: country: country city: city postalCode: postalCode state: state line3: line3 line2: line2 line1: line1 properties: address: $ref: '#/components/schemas/Address' type: object CheckAddressTaxabilityRequest: additionalProperties: false description: >- The taxability request containing the address. Postal code & Country is mandatory. example: address: country: country city: city postalCode: postalCode state: state line3: line3 line2: line2 line1: line1 properties: address: $ref: '#/components/schemas/Address' type: object AddressValidationResponse: example: status: null properties: status: $ref: '#/components/schemas/AddressValidationStatus' required: - status type: object CheckAddressTaxabilityResponse: example: isTaxable: true properties: isTaxable: description: The taxability of the address. type: boolean required: - isTaxable type: object AddressValidationStatus: description: The validation status of an address. enum: - VALID - INVALID type: string Address: description: Represents the address used for validation. example: country: country city: city postalCode: postalCode state: state line3: line3 line2: line2 line1: line1 properties: line1: description: First line of the street address maxLength: 180 type: string line2: description: Second line of the street address maxLength: 150 type: string line3: description: Third line of the street address maxLength: 150 type: string city: description: The city of the address maxLength: 50 type: string state: description: >- The state of the address following the ISO 3166-2 state/province code without the country prefix. maxLength: 50 type: string postalCode: description: Postal Code / Zip Code of the address. maxLength: 20 type: string country: description: >- The country of the address following the ISO 3166-1 alpha-2 standard. maxLength: 2 type: string type: object BasicErrorResponse: additionalProperties: false description: >- The basic error response containing the error message and the help documentation link. properties: message: description: The description of the error with details about it's cause. example: Invalid Credentials maxLength: 250 type: string helpUrl: description: >- The link to the documentation for more information about the error and the corrective action. example: 'https://apidocs.chargebee.com#Authentication' format: uri type: string required: - message type: object ValidationErrorResponse: description: >- The error response for validation errors with the respective entity and its field information. properties: errors: items: $ref: '#/components/schemas/ValidationErrorResponse_errors_inner' type: array required: - errors type: object ErrorCode: description: >- The error codes classify the type of exception that occurred during processing the request. enum: - INVALID_OPERATION - SERVICE_EXCEPTION - SERVICE_UNAVAILABLE - SERVICE_LIMIT_EXCEEDED - MISSING_REQUIRED_DATA - INVALID_DATA - INVALID_TYPE - INVALID_FORMAT - INVALID_RANGE type: string HealthCheckResponse: example: components: - endpoints: - endpoints - endpoints name: name description: description id: id type: OTHER status: null - endpoints: - endpoints - endpoints name: name description: description id: id type: OTHER status: null description: description time: 2000-01-23T04:56:07.000Z version: version status: null properties: version: minLength: 1 type: string description: description: >- The description of the health status returned by the Service Adapter. maxLength: 250 type: string status: $ref: '#/components/schemas/HealthStatus' components: description: >- List of health status details for each component reported by the Service Adapter. items: $ref: '#/components/schemas/HealthCheckComponent' type: array time: description: The timestamp of the health status reported by the Service Adapter. format: date-time type: string required: - components - status - time type: object HealthStatus: description: The status of a specific component reported by the Service Adapter. enum: - UP - DOWN - WARN type: string HealthCheckComponent: description: >- The health status details of a specific component reported by the Service Adapter. example: endpoints: - endpoints - endpoints name: name description: description id: id type: OTHER status: null properties: id: description: The id of the component. maxLength: 50 type: string name: description: The name of the component. maxLength: 150 type: string type: description: > The type of component affected when `status` is `WARN` or `DOWN`. The possible values are: - `ADAPTER`: The reported status is for the Service Adapter. - `API`: The reported status is for the Service Provider. - `DATABASE`: The reported status is for a database dependency of the Service Provider. - `SYSTEM`: The reported status is for any other known system component such as cache or gateway. - `OTHER`: The reported status is either for a component that does not belong to the types described above or the source of the issue is unknown. enum: - OTHER - SYSTEM - API - ADAPTER - DATABASE type: string description: description: The detailed status of the component. maxLength: 250 type: string status: $ref: '#/components/schemas/HealthStatus' endpoints: description: >- When the `status` of the component is not `UP`, then the list of endpoints affected. items: type: string type: array required: - id - name - status - type type: object CredentialValidationResponse: example: status: null properties: status: $ref: '#/components/schemas/CredentialStatus' required: - status type: object CredentialStatus: description: The status of the credentials used for authentication. enum: - VALID - INVALID type: string ValidationErrorResponse_errors_inner: properties: entity: description: The target entity that has the invalid field or value. example: customer maxLength: 20 type: string entityField: description: The field of an entity that has the invalid value. example: 'lineItems[0].taxIdentifiers[0].value' maxLength: 250 type: string code: $ref: '#/components/schemas/ErrorCode' message: description: A short message describing the reason for the error. example: Invalid tax code provided. maxLength: 250 type: string helpUrl: description: >- The link to the documentation for more information about the error and the corrective action. example: 'https://apidocs.chargebee.com#Authentication' format: uri type: string required: - code - message type: object securitySchemes: bearerAuth: scheme: bearer type: http apiKey: description: Bearer token based authentication. in: header name: bearer type: apiKey

Â