{"openapi":"3.0.4","info":{"title":"Batch upsert Withholding Tax rate rows, applying the write-time gates before any row lands.","description":"Row identity is the series identifiers plus effectiveAt; a rate is superseded by loading a row with a\r\nlater effectiveAt for the same series identifiers. One batch carries one rule source, so a feed mixing rows\r\nfrom a source with rows that apply at every source is loaded in two calls.","version":"0.0.1"},"servers":[{"url":"https://fbn-prd.lusid.com/api"}],"paths":{"/api/withholdingtax/rates/{scope}/{code}/$batchUpsert":{"post":{"tags":["Withholding Tax"],"summary":"Batch upsert Withholding Tax rate rows, applying the write-time gates before any row lands.","description":"Row identity is the series identifiers plus effectiveAt; a rate is superseded by loading a row with a\r\nlater effectiveAt for the same series identifiers. One batch carries one rule source, so a feed mixing rows\r\nfrom a source with rows that apply at every source is loaded in two calls.","operationId":"BatchUpsertWithholdingTaxRates","parameters":[{"name":"scope","in":"path","description":"The Scope of the rate dataset's relational dataset definition.","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_]+$","type":"string"}},{"name":"code","in":"path","description":"The Code of the rate dataset's relational dataset definition.","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_]+$","type":"string"}},{"name":"successMode","in":"query","description":"Atomic or Partial; defaults to Atomic, because a partly loaded feed silently\r\n            under-withholds. In Partial mode failures are returned in the response body with a 200 status.","schema":{"maxLength":64,"minLength":1,"type":"string","default":"Atomic"}},{"name":"ruleSource","in":"query","description":"The source every row in the batch is attributed to, compared against the\r\n            configuration's source priority. Omit it for rows that apply at every source. A row may not carry ruleSource\r\n            in its own series identifiers.","schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_]+$","type":"string"}}],"requestBody":{"description":"The rate rows to upsert, keyed by a correlation id echoed back in the response.","content":{"application/json-patch+json":{"schema":{"type":"object","additionalProperties":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/UpsertWithholdingTaxRateRequest"}},"example":{"gb-equity":{"seriesIdentifiers":{"taxCountry":"GB","profileType":"CorporateFund","assetClass":"Equity"},"effectiveAt":"2026-01-01T00:00:00.0000000+00:00","valueFields":{"countryRate":0.35,"treatyRate":0.15,"treatyRAS":true}},"gb-equity-custodian-b":{"seriesIdentifiers":{"taxCountry":"GB","profileType":"CorporateFund","assetClass":"Equity","custodian":"CustodianB"},"effectiveAt":"2026-01-01T00:00:00.0000000+00:00","valueFields":{"countryRate":0.35,"treatyRate":0.15,"treatyRAS":false}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/UpsertWithholdingTaxRateRequest"}},"example":{"gb-equity":{"seriesIdentifiers":{"taxCountry":"GB","profileType":"CorporateFund","assetClass":"Equity"},"effectiveAt":"2026-01-01T00:00:00.0000000+00:00","valueFields":{"countryRate":0.35,"treatyRate":0.15,"treatyRAS":true}},"gb-equity-custodian-b":{"seriesIdentifiers":{"taxCountry":"GB","profileType":"CorporateFund","assetClass":"Equity","custodian":"CustodianB"},"effectiveAt":"2026-01-01T00:00:00.0000000+00:00","valueFields":{"countryRate":0.35,"treatyRate":0.15,"treatyRAS":false}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/UpsertWithholdingTaxRateRequest"}},"example":{"gb-equity":{"seriesIdentifiers":{"taxCountry":"GB","profileType":"CorporateFund","assetClass":"Equity"},"effectiveAt":"2026-01-01T00:00:00.0000000+00:00","valueFields":{"countryRate":0.35,"treatyRate":0.15,"treatyRAS":true}},"gb-equity-custodian-b":{"seriesIdentifiers":{"taxCountry":"GB","profileType":"CorporateFund","assetClass":"Equity","custodian":"CustodianB"},"effectiveAt":"2026-01-01T00:00:00.0000000+00:00","valueFields":{"countryRate":0.35,"treatyRate":0.15,"treatyRAS":false}}}},"application/*+json":{"schema":{"type":"object","additionalProperties":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/UpsertWithholdingTaxRateRequest"}},"example":{"gb-equity":{"seriesIdentifiers":{"taxCountry":"GB","profileType":"CorporateFund","assetClass":"Equity"},"effectiveAt":"2026-01-01T00:00:00.0000000+00:00","valueFields":{"countryRate":0.35,"treatyRate":0.15,"treatyRAS":true}},"gb-equity-custodian-b":{"seriesIdentifiers":{"taxCountry":"GB","profileType":"CorporateFund","assetClass":"Equity","custodian":"CustodianB"},"effectiveAt":"2026-01-01T00:00:00.0000000+00:00","valueFields":{"countryRate":0.35,"treatyRate":0.15,"treatyRAS":false}}}}},"required":true},"responses":{"200":{"description":"The Withholding Tax rate rows that were upserted.","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/BatchUpsertWithholdingTaxRatesResponse"},"example":{"values":{"gb-equity":{"relationalDatasetDefinitionId":{"scope":"WithholdingTax","code":"wht-main-rates"},"seriesIdentifiers":{"taxCountry":{"value":"GB"},"profileType":{"value":"CorporateFund"},"assetClass":{"value":"Equity"},"ruleSource":{"value":"TaxVendor"}},"effectiveAt":"2026-01-01T00:00:00.0000000+00:00","valueFields":{"countryRate":{"value":0.35},"treatyRate":{"value":0.15},"treatyRAS":{"value":true}},"metaDataFields":{},"effectiveAtEntered":""},"gb-equity-custodian-b":{"relationalDatasetDefinitionId":{"scope":"WithholdingTax","code":"wht-main-rates"},"seriesIdentifiers":{"taxCountry":{"value":"GB"},"profileType":{"value":"CorporateFund"},"assetClass":{"value":"Equity"},"custodian":{"value":"CustodianB"},"ruleSource":{"value":"TaxVendor"}},"effectiveAt":"2026-01-01T00:00:00.0000000+00:00","valueFields":{"countryRate":{"value":0.35},"treatyRate":{"value":0.15},"treatyRAS":{"value":false}},"metaDataFields":{},"effectiveAtEntered":""}},"failed":{},"href":"https://example.lusid.com/api/withholdingtax/rates/WithholdingTax/wht-main-rates/$batchUpsert?successMode=Atomic&ruleSource=TaxVendor"}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/BatchUpsertWithholdingTaxRatesResponse"},"example":{"values":{"gb-equity":{"relationalDatasetDefinitionId":{"scope":"WithholdingTax","code":"wht-main-rates"},"seriesIdentifiers":{"taxCountry":{"value":"GB"},"profileType":{"value":"CorporateFund"},"assetClass":{"value":"Equity"},"ruleSource":{"value":"TaxVendor"}},"effectiveAt":"2026-01-01T00:00:00.0000000+00:00","valueFields":{"countryRate":{"value":0.35},"treatyRate":{"value":0.15},"treatyRAS":{"value":true}},"metaDataFields":{},"effectiveAtEntered":""},"gb-equity-custodian-b":{"relationalDatasetDefinitionId":{"scope":"WithholdingTax","code":"wht-main-rates"},"seriesIdentifiers":{"taxCountry":{"value":"GB"},"profileType":{"value":"CorporateFund"},"assetClass":{"value":"Equity"},"custodian":{"value":"CustodianB"},"ruleSource":{"value":"TaxVendor"}},"effectiveAt":"2026-01-01T00:00:00.0000000+00:00","valueFields":{"countryRate":{"value":0.35},"treatyRate":{"value":0.15},"treatyRAS":{"value":false}},"metaDataFields":{},"effectiveAtEntered":""}},"failed":{},"href":"https://example.lusid.com/api/withholdingtax/rates/WithholdingTax/wht-main-rates/$batchUpsert?successMode=Atomic&ruleSource=TaxVendor"}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/BatchUpsertWithholdingTaxRatesResponse"},"example":{"values":{"gb-equity":{"relationalDatasetDefinitionId":{"scope":"WithholdingTax","code":"wht-main-rates"},"seriesIdentifiers":{"taxCountry":{"value":"GB"},"profileType":{"value":"CorporateFund"},"assetClass":{"value":"Equity"},"ruleSource":{"value":"TaxVendor"}},"effectiveAt":"2026-01-01T00:00:00.0000000+00:00","valueFields":{"countryRate":{"value":0.35},"treatyRate":{"value":0.15},"treatyRAS":{"value":true}},"metaDataFields":{},"effectiveAtEntered":""},"gb-equity-custodian-b":{"relationalDatasetDefinitionId":{"scope":"WithholdingTax","code":"wht-main-rates"},"seriesIdentifiers":{"taxCountry":{"value":"GB"},"profileType":{"value":"CorporateFund"},"assetClass":{"value":"Equity"},"custodian":{"value":"CustodianB"},"ruleSource":{"value":"TaxVendor"}},"effectiveAt":"2026-01-01T00:00:00.0000000+00:00","valueFields":{"countryRate":{"value":0.35},"treatyRate":{"value":0.15},"treatyRAS":{"value":false}},"metaDataFields":{},"effectiveAtEntered":""}},"failed":{},"href":"https://example.lusid.com/api/withholdingtax/rates/WithholdingTax/wht-main-rates/$batchUpsert?successMode=Atomic&ruleSource=TaxVendor"}}}},"400":{"description":"The details of the input related failure","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidValidationProblemDetails"}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidValidationProblemDetails"}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidValidationProblemDetails"}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidProblemDetails"}}}}},"security":[{"BearerAuth":[]}],"x-fbn-apistatus":"EarlyAccess"}}},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}}}