Skip to content

Commit

Permalink
spec release
Browse files Browse the repository at this point in the history
  • Loading branch information
Adyen Automation committed Oct 2, 2024
1 parent 3cbfa17 commit 0db5ba8
Show file tree
Hide file tree
Showing 6 changed files with 1,056 additions and 0 deletions.
217 changes: 217 additions & 0 deletions json/LegalEntityService-v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@
{
"name" : "Terms of Service"
},
{
"name" : "Tax eDelivery consent"
},
{
"name" : "Hosted Onboarding"
},
Expand Down Expand Up @@ -1235,6 +1238,102 @@
}
}
},
"/legalEntities/{id}/checkTaxElectronicDeliveryConsent" : {
"post" : {
"tags" : [
"Tax eDelivery consent"
],
"summary" : "Check the status of consent for electronic delivery of tax forms",
"description" : "Returns the consent status for electronic delivery of tax forms.",
"x-addedInVersion" : "1",
"operationId" : "post-legalEntities-id-checkTaxElectronicDeliveryConsent",
"x-sortIndex" : 2,
"x-methodName" : "checkStatusOfConsentForElectronicDeliveryOfTaxForms",
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CheckTaxElectronicDeliveryConsentResponse"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/legalEntities/{id}/onboardingLinks" : {
"post" : {
"tags" : [
Expand Down Expand Up @@ -1791,6 +1890,104 @@
}
}
},
"/legalEntities/{id}/setTaxElectronicDeliveryConsent" : {
"post" : {
"tags" : [
"Tax eDelivery consent"
],
"summary" : "Set the consent status for electronic delivery of tax forms",
"description" : "Set the consent status for electronic delivery of tax forms.",
"x-addedInVersion" : "1",
"operationId" : "post-legalEntities-id-setTaxElectronicDeliveryConsent",
"x-sortIndex" : 1,
"x-methodName" : "setConsentStatusForElectronicDeliveryOfTaxForms",
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SetTaxElectronicDeliveryConsentRequest"
}
}
}
},
"parameters" : [
{
"description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"description" : "No Content - look at the actual response code for the status of the request. "
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/legalEntities/{id}/termsOfService" : {
"post" : {
"tags" : [
Expand Down Expand Up @@ -3319,6 +3516,16 @@
},
"type" : "object"
},
"CheckTaxElectronicDeliveryConsentResponse" : {
"additionalProperties" : false,
"properties" : {
"US1099k" : {
"description" : "Consent to electronically deliver tax form US1099-K.",
"type" : "boolean"
}
},
"type" : "object"
},
"Document" : {
"additionalProperties" : false,
"properties" : {
Expand Down Expand Up @@ -4384,6 +4591,16 @@
},
"type" : "object"
},
"SetTaxElectronicDeliveryConsentRequest" : {
"additionalProperties" : false,
"properties" : {
"US1099k" : {
"description" : "Consent to electronically deliver tax form US1099-K.",
"type" : "boolean"
}
},
"type" : "object"
},
"SourceOfFunds" : {
"additionalProperties" : false,
"properties" : {
Expand Down
Loading

0 comments on commit 0db5ba8

Please sign in to comment.