# Lista os itens do XML

Retorna uma lista de itens do XML.

Endpoint: GET /api/v3/purchase-invoices/{purchaseInvoiceId}/items
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

## Path parameters:

  - `purchaseInvoiceId` (integer, required)
    ID do arquivo xml de entrada

Você pode localizar os IDs dos XMLs no _endpoint_ de listagem de XMLs de entrada.
    Example: 123

## Query parameters:

  - `search_term` (string)
    Filtra pelo número da nota ou razão social ou cnpj.
    Example: "CPlug Supplier Chain"

  - `status` (string)
    Filtra pelo status do item.

Exemplo:
  - all Todos os status;
  - not_saved Somente os itens não salvos;
  - saved Somente os itens salvos.
    Enum: "all", "not_saved", "saved"

  - `page` (number)
    Indica a página da paginação.

  - `per_page` (number)
    Indica a quantidade de itens por página.

  - `updated_from` (string)
    Filtra por dados que foram atualizadas a partir de uma data. (Formato: YYYY-MM-DDThh:mm:ss+hh:mm).

  - `deleted` (string)
    Filtro para indicar se deve retornar dados apagados ou não.
    Enum: "not_include", "include", "only"

## Response 200 fields (application/json):

  - `data` (object)

  - `data.purchase-invoice-items` (array)
    Representa a lista de itens do XML

  - `data.purchase-invoice-items.id` (integer)
    Identificador único do item do XML.
    Example: 123

  - `data.purchase-invoice-items.number` (string)
    Número do item no XML.
    Example: "001"

  - `data.purchase-invoice-items.item_code` (string)
    Código do item.
    Example: "7"

  - `data.purchase-invoice-items.name` (string)
    Nome do item.
    Example: "CC Sem Acucar LT 350ml 6U FL"

  - `data.purchase-invoice-items.amount` (number)
    Quantidade do item.
    Example: 10

  - `data.purchase-invoice-items.status` (string)
    Status do item. Se este item foi salvo ou não.

Exemplo:
  - not_saved Não salvo.
  - saved Salvo.
    Enum: "not_saved", "saved"

  - `data.purchase-invoice-items.supplier_code` (string)
    Código do item no fornecedor.
    Example: "55388"

  - `data.purchase-invoice-items.xml_barcode` (string)
    Código de barra que consta na nota fiscal.
    Example: "7894900709834"

  - `data.purchase-invoice-items.unitary_value` (object)
    Valor unitário do item.

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

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

  - `data.purchase-invoice-items.discount` (object)
    Valor do desconto no item.

  - `data.purchase-invoice-items.other_values` (object)
    Outros valores.

  - `data.purchase-invoice-items.total_value` (object)
    Valor total do item.

  - `data.purchase-invoice-items.unitary_sale_value` (object)
    Valor unitário de venda do item.

  - `data.purchase-invoice-items.is_available_for_sale` (boolean)
    Indica se o item está disponível para a venda.
    Example: true

  - `data.purchase-invoice-items.barcode` (string)
    Código de barra do item.
    Example: "7894900709834"

  - `data.purchase-invoice-items.is_component` (boolean)
    Indica se o item é um componente.
    Example: true

  - `data.purchase-invoice-items.is_perishable` (boolean)
    Indica se o item é perecível.
    Example: true

  - `data.purchase-invoice-items.expiration_date` (string)
    Validade do item
Se o item é perecível, então este campo é obrigatório.
    Example: "2026-12-31"

  - `data.purchase-invoice-items.category` (object)
    Dados da categoria do item.

  - `data.purchase-invoice-items.category.id` (integer)
    Id único da categoria.
    Example: 7

  - `data.purchase-invoice-items.category.name` (string)
    Nome da categoria.
    Example: "Mercadoria para Revenda"

  - `data.purchase-invoice-items.taxes` (object)
    Dados fiscais do item.

  - `data.purchase-invoice-items.taxes.cest` (object)
    Dados do CEST do item.

  - `data.purchase-invoice-items.taxes.cest.id` (integer)
    Id único da CEST.
    Example: 444

  - `data.purchase-invoice-items.taxes.cest.description` (string)
    Descrição da CEST.
    Example: "1701000 - Sucos de frutas ou de produtos hortícolas; mistura de sucos"

  - `data.purchase-invoice-items.taxes.cfop` (object)
    Dados do CFOP do item.

  - `data.purchase-invoice-items.taxes.cfop.id` (integer)
    Id único da CFOP.
    Example: 5104

  - `data.purchase-invoice-items.taxes.cfop.description` (string)
    Descrição da CFOP.
    Example: "5104 - Venda de mercadoria adquirida ou recebida de terceiros, efetuada fora do estabelecimento"

  - `data.purchase-invoice-items.taxes.ncm` (object)
    Dados do NCM do item.

  - `data.purchase-invoice-items.taxes.ncm.id` (integer)
    Id único do NCM.
    Example: 1510

  - `data.purchase-invoice-items.taxes.ncm.description` (string)
    Descrição do NCM.
    Example: "22021000 - Água incl.mineral\\/gaseif.adicion.açúcar, aromatizada, etc"

  - `data.purchase-invoice-items.taxes.icms_source` (object)
    Representa um ICMS de Origem.

  - `data.purchase-invoice-items.taxes.icms_source.id` (integer)
    ID do ICMS de Origem.
    Example: 1

  - `data.purchase-invoice-items.taxes.icms_source.description` (string)
    Descrição do ICMS de Origem.
    Example: "0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8"

  - `data.purchase-invoice-items.taxes.icms_group` (object)
    Representa um grupo de ICMS.

  - `data.purchase-invoice-items.taxes.icms_group.id` (integer)
    Identificador único do Grupo de ICMS.
    Example: 211

  - `data.purchase-invoice-items.taxes.icms_group.name` (string)
    Nome do grupo de ICMS.
    Example: "ICMS Outras - Campos Opcionais"

  - `data.purchase-invoice-items.taxes.icms_group.tributary_group` (object)
    Grupo tributário associado ao ICMS.

  - `data.purchase-invoice-items.taxes.icms_group.tributary_group.id` (integer)
    Identificador único do grupo tributário.
    Example: 900

  - `data.purchase-invoice-items.taxes.icms_group.tributary_group.code` (string)
    Código do grupo tributário.
    Example: "900"

  - `data.purchase-invoice-items.taxes.icms_group.tributary_group.description` (string)
    Descrição do grupo tributário.
    Example: "900 - Outros"

  - `data.purchase-invoice-items.taxes.icms_group.icms_percentage` (number)
    Percentual do ICMS.
    Example: 18

  - `data.purchase-invoice-items.taxes.icms_group.is_default` (boolean)
    Indica se este é o grupo de ICMS padrão.

  - `data.purchase-invoice-items.taxes.icms_group.is_shared_with_all_companies` (boolean)
    Indica se este grupo de ICMS é compartilhado com todas as empresas.
    Example: true

  - `data.purchase-invoice-items.taxes.icms_group.created_at` (string)
    Data e hora de criação do registro.
    Example: "2025-07-18T23:37:49.000000Z"

  - `data.purchase-invoice-items.taxes.icms_group.updated_at` (string)
    Data e hora da última atualização do registro.
    Example: "2025-07-18T23:37:49.000000Z"

  - `data.purchase-invoice-items.taxes.pis_cofins` (object)
    Representa um grupo de PIS/COFINS.

  - `data.purchase-invoice-items.taxes.pis_cofins.id` (integer)
    Identificador único do Grupo de PIS/COFINS.
    Example: 1

  - `data.purchase-invoice-items.taxes.pis_cofins.name` (string)
    Nome do grupo de PIS/COFINS.
    Example: "Pis Cofins"

  - `data.purchase-invoice-items.taxes.pis_cofins.pis_tributary_group` (object)
    Situação do PIS.

  - `data.purchase-invoice-items.taxes.pis_cofins.pis_tributary_group.id` (integer, required)
    ID da situação do PIS.
    Example: 4

  - `data.purchase-invoice-items.taxes.pis_cofins.pis_tributary_group.code` (string, required)
    Código da situação do PIS.
    Example: "04"

  - `data.purchase-invoice-items.taxes.pis_cofins.pis_tributary_group.description` (string, required)
    Descrição da situação do PIS.
    Example: "04 - Operação Tributável (tributação monofásica (alíquota zero))"

  - `data.purchase-invoice-items.taxes.pis_cofins.cofins_tributary_group` (object)
    Situação do COFINS.

  - `data.purchase-invoice-items.taxes.pis_cofins.cofins_tributary_group.id` (integer, required)
    ID da situação do COFINS.
    Example: 4

  - `data.purchase-invoice-items.taxes.pis_cofins.cofins_tributary_group.code` (string, required)
    Código da situação do COFINS.
    Example: "04"

  - `data.purchase-invoice-items.taxes.pis_cofins.cofins_tributary_group.description` (string, required)
    Descrição da situação do COFINS.
    Example: "04 - Operação Tributável (tributação monofásica, alíquota zero)"

  - `data.purchase-invoice-items.taxes.pis_cofins.percent_pis` (number,null)
    Percentual do PIS.

  - `data.purchase-invoice-items.taxes.pis_cofins.percent_cofins` (number,null)
    Percentual do COFINS.

  - `data.purchase-invoice-items.taxes.pis_cofins.is_default` (boolean)
    Indica se é o grupo de PIS/COFINS padrão.

  - `data.purchase-invoice-items.taxes.pis_cofins.is_shared_with_all_companies` (boolean)
    Indica se este grupo de PIS/COFINS é compartilhado com todas as empresas.
    Example: true

  - `data.purchase-invoice-items.taxes.pis_cofins.created_at` (string)
    Data de criação do grupo de PIS/COFINS.
    Example: "2025-07-31T19:05:18.000000Z"

  - `data.purchase-invoice-items.taxes.pis_cofins.updated_at` (string)
    Data da última atualização do grupo de PIS/COFINS.
    Example: "2025-07-31T19:55:49.000000Z"

  - `data.purchase-invoice-items.taxes.ipi` (object)
    Representa um grupo de IPI.

  - `data.purchase-invoice-items.taxes.ipi.id` (integer)
    Identificador único do Grupo de IPI.
    Example: 5

  - `data.purchase-invoice-items.taxes.ipi.name` (string)
    Nome do grupo de IPI.
    Example: "IPI novo"

  - `data.purchase-invoice-items.taxes.ipi.tributary_group` (object)
    Grupo tributário do IPI.

  - `data.purchase-invoice-items.taxes.ipi.tributary_group.id` (integer, required)
    ID do grupo tributário.

  - `data.purchase-invoice-items.taxes.ipi.ipi_percent` (number)
    Percentual do IPI.
    Example: 10

  - `data.purchase-invoice-items.taxes.ipi.is_default` (boolean)
    Indica se é o grupo de IPI padrão.

  - `data.purchase-invoice-items.taxes.ipi.is_shared_with_all_companies` (boolean)
    Indica se este grupo de IPI é compartilhado com todas as empresas.
    Example: true

  - `data.purchase-invoice-items.taxes.ipi.created_at` (string)
    Data de criação do grupo de IPI.
    Example: "2025-07-30T13:13:51.000000Z"

  - `data.purchase-invoice-items.taxes.ipi.updated_at` (string)
    Data da última atualização do grupo de IPI.
    Example: "2025-07-30T13:34:36.000000Z"

  - `data.purchase-invoice-items.taxes.ipi_value` (object)
    Valor monetário do IPI do item.

  - `data.purchase-invoice-items.taxes.fcp` (object)
    Dados do FCP do item.

  - `data.purchase-invoice-items.taxes.fcp.value` (object)
    Valor monetário do FCP do item.

  - `data.purchase-invoice-items.taxes.fcpst` (object)
    Dados do FCPST do item.

  - `data.purchase-invoice-items.taxes.fcpst.value` (object)
    Valor monetário do FCPST do item.

  - `data.purchase-invoice-items.taxes.icmsst` (object)
    Dados do ICMSST do item.

  - `data.purchase-invoice-items.taxes.icmsst.value` (object)
    Valor monetário do ICMSST do item.

  - `data.purchase-invoice-items.xml_unit_of_measure` (object)
    Unidade de medida do item no XML.

  - `data.purchase-invoice-items.xml_unit_of_measure.abbreviation` (string)
    Simbolo da unidade de medida.
    Example: "Un"

  - `data.purchase-invoice-items.item` (object)
    Informações item que foi associado.

  - `data.purchase-invoice-items.item.id` (integer)
    Identificador único do item.
    Example: 17

  - `data.purchase-invoice-items.item.unit_of_measure` (object)
    Unidade de medida do item.

  - `data.purchase-invoice-items.item.unit_of_measure.id` (integer)
    Identificador único da unidade de medida.
    Example: 8

  - `data.purchase-invoice-items.item.unit_of_measure.name` (string)
    Nome da unidade de medida.
    Example: "Unidade"

  - `data.purchase-invoice-items.item.unit_of_measure.precision` (integer)
    Precisão da unidade de medida.
    Example: 2

  - `data.purchase-invoice-items.xml_options` (array)
    Lista de opções do item.

  - `data.purchase-invoice-items.xml_options.conversion` (object)
    Informações sobre a conversão de unidade.

  - `data.purchase-invoice-items.xml_options.conversion.code` (string)
    Código do item com estes atributos.
    Example: "55388"

  - `data.purchase-invoice-items.xml_options.conversion.factor` (number)
    Fator de conversão.
    Example: 1

  - `data.purchase-invoice-items.xml_options.conversion.amount` (number)
    Quantidade de conversão.
    Example: 10

  - `data.purchase-invoice-items.xml_options.conversion.barcode` (string)
    Código de barra do item com estes atributos.
    Example: "3029575386736"

  - `data.purchase-invoice-items.xml_options.options` (array)
    Lista de opções do item.

  - `data.purchase-invoice-items.xml_options.options.id` (integer)
    Id único da opção

Você pode localizar os IDs da opção no _endpoint_ de [listagem de opções de atributos](#tag/attributeoptions/get-attributes-options).
    Example: 1

  - `data.purchase-invoice-items.xml_options.options.name` (string)
    Nome da opção.
    Example: "Branca"

  - `data.purchase-invoice-items.xml_options.type` (string)
    Tipo do atributo que será criado/atualizado no final da importação.

Exemplo:
  - composition Composto.
  - grid Grid.
    Enum: "composition", "grid"

  - `data.purchase-invoice-items.attributes` (array)
    Lista de atributos do item.

  - `data.purchase-invoice-items.attributes.id` (integer)
    Id único do atributo
    Example: 1

  - `data.purchase-invoice-items.attributes.name` (string)
    Nome do atributo.
    Example: "Cor"

  - `data.purchase-invoice-items.stock` (object)
    Informações sobre o estoque deste item.

  - `data.purchase-invoice-items.stock.id` (integer)
    Identificador único do estoque.
    Example: 1

  - `data.purchase-invoice-items.stock.is_stock_control` (boolean)
    Indica se o item é controlado pelo estoque.
    Example: true

  - `data.purchase-invoice-items.stock.is_stock_notification` (boolean)
    Indica se o item possui notificação de máxima e mínimo.
    Example: true

  - `data.purchase-invoice-items.stock.min` (number)
    Quantidade de item mínimo no estoque.
    Example: 1

  - `data.purchase-invoice-items.stock.max` (number)
    Quantidade de item máximo no estoque.
    Example: 100

  - `data.purchase-invoice-items.unit_of_measure_equivalent` (object)
    Unidade de medida equivalente do item. É a unidade de medida que será convertida para ser usada no sistema.

  - `data.purchase-invoice-items.unit_of_measure_equivalent.id` (integer)
    Identificador único da unidade de medida.

Você pode localizar os IDs das unidades de medida no _endpoint_ de [listagem de unidades de medida](#tag/Units/operation/get-units).
    Example: 8

  - `data.purchase-invoice-items.unit_of_measure_equivalent.precision` (integer)
    Identificador único da unidade de medida.
    Example: 2

  - `data.purchase-invoice-items.unit_of_measure_equivalent.factor` (number)
    Fator de conversão. É o valor que será multiplicado para encontrar a conversão e armazenar no sistema.
    Example: 100

  - `data.purchase-invoice-items.companies` (array)
    Lista de empresas que permite visualizar
    Example: [[1,2,3]]

  - `data.purchase-invoice-items.created_at` (string)
    Data da última criação.
    Example: "2020-01-01T09:00:00-03:00"

  - `data.purchase-invoice-items.updated_at` (string)
    Data da última atualização.
    Example: "2020-01-01T09:00:00-03:00"

  - `data.purchase-invoice-items.delete_at` (string)
    Data que foi apagado.
    Example: "2020-01-01T09:00:00-03:00"

  - `meta` (object)
    Representa as informações de Metadado da paginação da listagem.

  - `meta.current_page` (integer, required)
    Página atual na paginação.
    Example: 1

  - `meta.last_page` (integer, required)
    Quantidade total de páginas.
    Example: 10

  - `meta.per_page` (integer, required)
    Quantidade de resultados por página.
    Example: 20

  - `meta.total` (integer, required)
    Quantidade total de itens.
    Example: 200

## 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