# Upload de XML

Adiciona um novo arquivo xml.

Este endpoint aceita solicitações HTTP no formato Form-Data. Veja um exemplo:


curl --location 'http://{BASE_URL}/api/v3/purchase-invoices' \
--header 'CPlug-Company-Id: COMPANY_ID' \
--header 'Idempotency-Key: IDEMPOTENCY_KEY' \
--header 'Authorization: Bearer TOKEN' \
--form 'files=@"/path/to/nfeIn.xml"'


O tamanho máximo do arquivo é 5 MB.

Endpoint: POST /api/v3/purchase-invoices
Version: 3.0.0
Security: OAuth2

## Header parameters:

  - `CPlug-Company-Id` (number, required)
    Id da Empresa (Company).

Você pode localizar os IDs das empresas no _endpoint_ de listagem de empresas.
    Example: 12

  - `Idempotency-Key` (string, required)
    UUID aleatório gerado por você. Nós utilizamos esse header para evitar duplicidade de registros, ou seja, caso você não tenha recebido a resposta de alguma requisição e mandar o mesmo UUID, nós não duplicaremos o registro.

## Request fields (multipart/form-data):

  - `file` (string, required)

## Response 200 fields (application/json):

  - `data` (object)
    Representa um xml;

  - `data.id` (integer)
    Identificador único do arquivo xml de entrada.
    Example: 1

  - `data.serie` (string)
    Número de séria da nota fiscal de entrada.
    Example: "001"

  - `data.number` (string)
    Número da nota fiscal de entrada.
    Example: "2340003"

  - `data.company_name` (string)
    Razão social do fornecedor.
    Example: "CPlug Supplier Chain LTDA"

  - `data.document` (string)
    CNPJ do fornecedor.
    Example: "22423374000152"

  - `data.value` (object)
    Valor total da nota fiscal.

  - `data.value.amount` (number, required)
    Valor expresso como um número decimal das principais unidades monetárias
    Example: 99.95

  - `data.value.currency` (string, required)
    Código de moeda de 3 letras conforme definido pela ISO-4217
    Example: "BRL"

  - `data.issue_date` (string)
    Data de emissão da nota.
    Example: "2025-01-10"

  - `data.imported_date` (string)
    Data da importação.
    Example: "2025-01-21"

  - `data.source` (string)
    Origem.
    Example: "Importação de XML"

  - `data.status` (string)
    Status da importação.

- imported Somente os importados;
- not_imported Somente os não importados.
    Enum: "imported", "not_imported"

  - `data.url` (string)
    URL do arquivo xml.
    Example: "https://erp.connectplug.com.br/file/eyJ..."

  - `data.is_deleted` (boolean)
    Indica se a nota foi apagado ou não.

  - `data.created_at` (string)
    Data da criação do estoque.
    Example: "2020-01-01T09:00:00-03:00"

  - `data.updated_at` (string)
    Data da atualização do estoque.
    Example: "2020-01-01T09:00:00-03:00"

## Response 400 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "missing_headers"

  - `message` (string)
    Descrição do erro.
    Example: "error message"

  - `meta` (array)
    Dados adicionais sobre o erro.

## Response 422 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "uneditable_entity"

  - `message` (string)
    Descrição do erro.
    Example: "description error"

  - `meta` (array)
    Dados adicionais sobre o erro.

  - `meta.field` (string, required)
    Nome do campo no qual existe um erro de validação.
    Example: "name"

  - `meta.validations` (array)

  - `meta.validations.type` (string, required)
    Tipo da validação aplicada.
    Example: "Required"

  - `meta.validations.value` (array)
    Tipo de valor aplicável (esse campo pode ser vazio).


## Response 401 fields

## Response 404 fields