Companies

POST /companies

Crear nueva Empresa

Petición de ejemplo:

POST /companies HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "name": "string",
    "legalName": "string",
    "tradeName": "string",
    "operationCountry": "string",
    "companyType": "string",
    "taxType": "string",
    "taxValue": "string",
    "taxCondition": "string",
    "legalAddress": {
        "streetName": "string",
        "streetNumber": "string",
        "floor": "string",
        "apartment": "string",
        "zipCode": "string",
        "neighborhood": "string",
        "city": "string",
        "region": "string",
        "country": "string"
    }
}

• Status Codes:

  • 201 Created –

    Company created

    Ejemplo de respuesta:

    HTTP/1.1 201 Created
    Content-Type: application/json
    
    {
        "uuid": "string",
        "name": "string",
        "legalName": "string",
        "taxInfomation": {
            "type": "CUIT",
            "value": "string",
            "condition": "VAT_REGISTERED"
        },
        "legalAddress": {
            "streetName": "string",
            "streetNumber": "string",
            "floor": "string",
            "apartment": "string",
            "zipCode": "string",
            "neighborhood": "string",
            "city": "string",
            "region": "string",
            "country": "string"
        }
    }

  • 400 Bad Request –

    Invalid payload

    Ejemplo de respuesta:

    HTTP/1.1 400 Bad Request
    Content-Type: application/json
    
    {
        "name": "string",
        "message": "string",
        "detail": {
            "items": [
                {
                    "path": "string",
                    "message": "string",
                    "type": "required"
                }
            ]
        }
    }

  • 401 Unauthorized –

    Unauthorized

    Ejemplo de respuesta:

    HTTP/1.1 401 Unauthorized
    Content-Type: application/json
    
    {
        "name": "string",
        "message": "string"
    }

GET /companies/all

Get all companies

Petición de ejemplo:

GET /companies/all HTTP/1.1
Host: example.com

• Status Codes:

  • 200 OK –

    List of companies

    Ejemplo de respuesta:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    [
        {
            "uuid": "string",
            "name": "string",
            "legalName": "string",
            "taxInfomation": {
                "type": "CUIT",
                "value": "string",
                "condition": "VAT_REGISTERED"
            },
            "legalAddress": {
                "streetName": "string",
                "streetNumber": "string",
                "floor": "string",
                "apartment": "string",
                "zipCode": "string",
                "neighborhood": "string",
                "city": "string",
                "region": "string",
                "country": "string"
            }
        }
    ]

  • 401 Unauthorized –

    Unauthorized

    Ejemplo de respuesta:

    HTTP/1.1 401 Unauthorized
    Content-Type: application/json
    
    {
        "name": "string",
        "message": "string"
    }

  • 404 Not Found –

    Company not found

    Ejemplo de respuesta:

    HTTP/1.1 404 Not Found
    Content-Type: application/json
    
    {
        "name": "string",
        "message": "string",
        "detail": {
            "item": "string"
        }
    }

GET /companies/[uuid]

Get company information

• Parameters:
  • uuid (string) –

Petición de ejemplo:

GET /companies/[uuid] HTTP/1.1
Host: example.com

• Status Codes:

  • 200 OK –

    Company details

    Ejemplo de respuesta:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "uuid": "string",
        "name": "string",
        "legalName": "string",
        "taxInfomation": {
            "type": "CUIT",
            "value": "string",
            "condition": "VAT_REGISTERED"
        },
        "legalAddress": {
            "streetName": "string",
            "streetNumber": "string",
            "floor": "string",
            "apartment": "string",
            "zipCode": "string",
            "neighborhood": "string",
            "city": "string",
            "region": "string",
            "country": "string"
        }
    }

  • 401 Unauthorized –

    Unauthorized

    Ejemplo de respuesta:

    HTTP/1.1 401 Unauthorized
    Content-Type: application/json
    
    {
        "name": "string",
        "message": "string"
    }

  • 404 Not Found –

    User not found

    Ejemplo de respuesta:

    HTTP/1.1 404 Not Found
    Content-Type: application/json
    
    {
        "name": "string",
        "message": "string",
        "detail": {
            "item": "string"
        }
    }

PATCH /companies/[uuid]

Modify company information

• Parameters:
  • uuid (string) –

Petición de ejemplo:

PATCH /companies/[uuid] HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "dataSection": "datosBasicos",
    "data": []
}

• Status Codes:

  • 200 OK – Company information updated

  • 400 Bad Request –

    Invalid payload

    Ejemplo de respuesta:

    HTTP/1.1 400 Bad Request
    Content-Type: application/json
    
    {
        "name": "string",
        "message": "string",
        "detail": {
            "items": [
                {
                    "path": "string",
                    "message": "string",
                    "type": "required"
                }
            ]
        }
    }

  • 401 Unauthorized –

    Unauthorized

    Ejemplo de respuesta:

    HTTP/1.1 401 Unauthorized
    Content-Type: application/json
    
    {
        "name": "string",
        "message": "string"
    }

  • 404 Not Found –

    User not found

    Ejemplo de respuesta:

    HTTP/1.1 404 Not Found
    Content-Type: application/json
    
    {
        "name": "string",
        "message": "string",
        "detail": {
            "item": "string"
        }
    }

DELETE /companies/[uuid]

Delete company

• Parameters:

  • uuid (string) –

• Status Codes:

  • 204 No Content – Company deleted

  • 401 Unauthorized –

    Unauthorized

    Ejemplo de respuesta:

    HTTP/1.1 401 Unauthorized
    Content-Type: application/json
    
    {
        "name": "string",
        "message": "string"
    }

  • 404 Not Found –

    User not found

    Ejemplo de respuesta:

    HTTP/1.1 404 Not Found
    Content-Type: application/json
    
    {
        "name": "string",
        "message": "string",
        "detail": {
            "item": "string"
        }
    }