Retorna os dados dos orçamentos ou dos pedidos

curl --request GET \
  --url https://backend-pied-prod.piedadmin.com.br/api/v2/requests/{requestType}/{pageNumber}/{pageLimit} \
  --header 'Authorization: Bearer <token>'

{
  "id": "Identificador (ID) da requisição",
  "name": "Nome da requisição",
  "code": "200000000",
  "kind": "Kit Personalizado",
  "totalPower": 22.75,
  "budgetCreated": "2022-01-01T12:00:00.000Z",
  "orderCreated": "2022-01-01T12:00:00.000Z",
  "dealStatus": "Novo",
  "stockStatus": "reserved",
  "originalValue": 10000,
  "discount": 10,
  "surcharge": 10,
  "finalValue": 9000,
  "differenceWithPaymentConditionApplied": 0,
  "notes": "<p>Anotações internas</p>",
  "addedBy": {
    "name": "Nome",
    "surname": "Sobrenome",
    "email": "[email protected]",
    "cellphone": "(00) 00000-0000"
  },
  "payment": {
    "type": "pix / boleto / debito / credito / financiamento / other",
    "condition": {
      "name": "À vista",
      "quantityOfInstallments": 1,
      "conditionType": "notUpdate / increase / decrease",
      "modifierType": "percentage / fixed",
      "value": 10
    },
    "status": "notRequested / requested / received / cancelled",
    "description": "Codigo PIX: XYZ",
    "files": [
      {
        "path": "",
        "originalName": ""
      }
    ],
    "transactionStatus": "pending",
    "transactionId": "AAABBB123AA",
    "authorizationNsu": "123123",
    "authorizationCode": "123123",
    "paidAt": "2025-01-01T00:00",
    "creditCard": {
      "brand": "visa",
      "last4digits": "1234",
      "first6digits": "123456",
      "holderName": "John Doe"
    }
  },
  "responsible": {
    "name": "Nome do responsável",
    "surname": "Sobrenome do responsável",
    "email": "[email protected]",
    "cellphone": "(00) 00000-0000"
  },
  "company": {
    "cnpj": "00.000.000/0000-00",
    "cpf": "000.000.000-00",
    "fantasyName": "Nome fantasia",
    "companyName": "Razão social",
    "mainContact": {
      "name": "Nome",
      "surname": "Sobrenome",
      "email": "[email protected]",
      "cellphone": "(00) 00000-0000"
    },
    "address": {
      "CEP": "00000-000",
      "state": "SC",
      "city": "Nome da Cidade",
      "neighborhood": "Nome do Bairro",
      "patio": "Nome da Rua",
      "number": "1000",
      "complement": "Bloco X, Casa Y"
    }
  },
  "products": [
    {
      "type": "module / inverter / stringBox / complementaryEquipment / extraItem",
      "productCode": "codigo123",
      "name": "Nome do produto",
      "quantity": 10,
      "singlePrice": 1000,
      "totalPrice": 10000,
      "structure": {
        "name": "Cerâmica Colonial",
        "type": "cerâmica",
        "amount": 1,
        "price": 1000
      },
      "center": {
        "name": "Primeiro CD",
        "code": "CD001"
      }
    }
  ],
  "files": [
    {
      "category": "CPF",
      "uploadedFiles": [
        "CPF.png"
      ]
    }
  ],
  "customForm": [
    {
      "question": "Data de nascimento",
      "answer": "01/01/1900"
    }
  ],
  "structure": [
    {
      "kind": "Sem Estrutura",
      "arrangements": [
        {
          "linesAmount": 2,
          "modulesByLine": 25,
          "orientation": "Retrato / Paisagem"
        }
      ]
    }
  ],
  "freight": {
    "type": "CIF / FOB",
    "zoneType": "Rural / Urbana",
    "timeRestriction": "Restrição de horário",
    "truckPossible": "Sim / Não",
    "price": 1000,
    "integrationData": {
      "id": "ID da integração (se houver)",
      "name": "Nome da integração",
      "logisticProviderName": "Nome do provedor logístico"
    },
    "address": {
      "CEP": "00000-000",
      "state": "SC",
      "city": "Nome da Cidade",
      "neighborhood": "Nome do Bairro",
      "patio": "Nome da Rua",
      "number": "1000",
      "complement": "Bloco X, Casa Y",
      "patioFormatted": "Logradouro",
      "patioType": "Tipo do Logradouro"
    }
  },
  "invoice": {
    "razaoSocial": "Razão Social",
    "nomeFantasia": "Nome Fantasia",
    "cnpj": "00.000.000/0000-00",
    "temInscricaoEstadual": "sim",
    "ie": "000000000",
    "cpf": "000.000.000-00",
    "rg": "0000000",
    "telephone": "(00) 0000-0000",
    "email": "[email protected]",
    "originalInvoiceValue": 100000,
    "serviceToAddInvoiceValue": 10000,
    "requestedInvoiceValue": 120000,
    "address": {
      "CEP": "00000-000",
      "state": "SC",
      "city": "Nome da Cidade",
      "neighborhood": "Nome do Bairro",
      "patio": "Nome da Rua",
      "number": "1000",
      "complement": "Bloco X, Casa Y",
      "patioFormatted": "Logradouro",
      "patioType": "Tipo do Logradouro"
    }
  },
  "apiSent": true,
  "apiSentUpdated": "2022-01-01T12:00:00.000Z",
  "billingDate": "2025-01-01",
  "customData": [
    {
      "key": "<string>",
      "value": "0000",
      "type": "text"
    }
  ],
  "removed": false
}

Requests

Retorna os dados dos orçamentos ou dos pedidos

Retorna uma lista dos orçamentos/pedidos cadastrados na plataforma ordenados pela data de criação, sendo o primeiro registro o orçamento/pedido criado mais recentemente. Para a pesquisa retornar exclusivamente os novos registros de orçamentos/pedidos, ou seja, todos os orçamentos/pedidos que foram criados ou que tiveram algum de seus dados alterados desde a última requisição, deve-se realizar a pesquisa sem a utilização de parâmetros de pesquisa.

GET

requests

{requestType}

{pageNumber}

{pageLimit}

Retorna os dados dos orçamentos ou dos pedidos

curl --request GET \
  --url https://backend-pied-prod.piedadmin.com.br/api/v2/requests/{requestType}/{pageNumber}/{pageLimit} \
  --header 'Authorization: Bearer <token>'

{
  "id": "Identificador (ID) da requisição",
  "name": "Nome da requisição",
  "code": "200000000",
  "kind": "Kit Personalizado",
  "totalPower": 22.75,
  "budgetCreated": "2022-01-01T12:00:00.000Z",
  "orderCreated": "2022-01-01T12:00:00.000Z",
  "dealStatus": "Novo",
  "stockStatus": "reserved",
  "originalValue": 10000,
  "discount": 10,
  "surcharge": 10,
  "finalValue": 9000,
  "differenceWithPaymentConditionApplied": 0,
  "notes": "<p>Anotações internas</p>",
  "addedBy": {
    "name": "Nome",
    "surname": "Sobrenome",
    "email": "[email protected]",
    "cellphone": "(00) 00000-0000"
  },
  "payment": {
    "type": "pix / boleto / debito / credito / financiamento / other",
    "condition": {
      "name": "À vista",
      "quantityOfInstallments": 1,
      "conditionType": "notUpdate / increase / decrease",
      "modifierType": "percentage / fixed",
      "value": 10
    },
    "status": "notRequested / requested / received / cancelled",
    "description": "Codigo PIX: XYZ",
    "files": [
      {
        "path": "",
        "originalName": ""
      }
    ],
    "transactionStatus": "pending",
    "transactionId": "AAABBB123AA",
    "authorizationNsu": "123123",
    "authorizationCode": "123123",
    "paidAt": "2025-01-01T00:00",
    "creditCard": {
      "brand": "visa",
      "last4digits": "1234",
      "first6digits": "123456",
      "holderName": "John Doe"
    }
  },
  "responsible": {
    "name": "Nome do responsável",
    "surname": "Sobrenome do responsável",
    "email": "[email protected]",
    "cellphone": "(00) 00000-0000"
  },
  "company": {
    "cnpj": "00.000.000/0000-00",
    "cpf": "000.000.000-00",
    "fantasyName": "Nome fantasia",
    "companyName": "Razão social",
    "mainContact": {
      "name": "Nome",
      "surname": "Sobrenome",
      "email": "[email protected]",
      "cellphone": "(00) 00000-0000"
    },
    "address": {
      "CEP": "00000-000",
      "state": "SC",
      "city": "Nome da Cidade",
      "neighborhood": "Nome do Bairro",
      "patio": "Nome da Rua",
      "number": "1000",
      "complement": "Bloco X, Casa Y"
    }
  },
  "products": [
    {
      "type": "module / inverter / stringBox / complementaryEquipment / extraItem",
      "productCode": "codigo123",
      "name": "Nome do produto",
      "quantity": 10,
      "singlePrice": 1000,
      "totalPrice": 10000,
      "structure": {
        "name": "Cerâmica Colonial",
        "type": "cerâmica",
        "amount": 1,
        "price": 1000
      },
      "center": {
        "name": "Primeiro CD",
        "code": "CD001"
      }
    }
  ],
  "files": [
    {
      "category": "CPF",
      "uploadedFiles": [
        "CPF.png"
      ]
    }
  ],
  "customForm": [
    {
      "question": "Data de nascimento",
      "answer": "01/01/1900"
    }
  ],
  "structure": [
    {
      "kind": "Sem Estrutura",
      "arrangements": [
        {
          "linesAmount": 2,
          "modulesByLine": 25,
          "orientation": "Retrato / Paisagem"
        }
      ]
    }
  ],
  "freight": {
    "type": "CIF / FOB",
    "zoneType": "Rural / Urbana",
    "timeRestriction": "Restrição de horário",
    "truckPossible": "Sim / Não",
    "price": 1000,
    "integrationData": {
      "id": "ID da integração (se houver)",
      "name": "Nome da integração",
      "logisticProviderName": "Nome do provedor logístico"
    },
    "address": {
      "CEP": "00000-000",
      "state": "SC",
      "city": "Nome da Cidade",
      "neighborhood": "Nome do Bairro",
      "patio": "Nome da Rua",
      "number": "1000",
      "complement": "Bloco X, Casa Y",
      "patioFormatted": "Logradouro",
      "patioType": "Tipo do Logradouro"
    }
  },
  "invoice": {
    "razaoSocial": "Razão Social",
    "nomeFantasia": "Nome Fantasia",
    "cnpj": "00.000.000/0000-00",
    "temInscricaoEstadual": "sim",
    "ie": "000000000",
    "cpf": "000.000.000-00",
    "rg": "0000000",
    "telephone": "(00) 0000-0000",
    "email": "[email protected]",
    "originalInvoiceValue": 100000,
    "serviceToAddInvoiceValue": 10000,
    "requestedInvoiceValue": 120000,
    "address": {
      "CEP": "00000-000",
      "state": "SC",
      "city": "Nome da Cidade",
      "neighborhood": "Nome do Bairro",
      "patio": "Nome da Rua",
      "number": "1000",
      "complement": "Bloco X, Casa Y",
      "patioFormatted": "Logradouro",
      "patioType": "Tipo do Logradouro"
    }
  },
  "apiSent": true,
  "apiSentUpdated": "2022-01-01T12:00:00.000Z",
  "billingDate": "2025-01-01",
  "customData": [
    {
      "key": "<string>",
      "value": "0000",
      "type": "text"
    }
  ],
  "removed": false
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

requestType

enum<string>

required

Determina se será pesquisado orçamentos ou pedidos.

Available options:

order,

budget

pageNumber

integer

required

Determina o número da página a ser retornada.

pageLimit

integer

required

Limita a quantidade de registros retornados por página.

Query Parameters

lastUpdateAfter

string

A pesquisa retorna registros atualizados pela última vez a partir desta data passada no parâmetro. Formato (AAAA-MM-DD).

lastUpdateBefore

string

A pesquisa retorna registros atualizados pela última vez até esta data passada no parâmetro. Formato (AAAA-MM-DD).

code

string

A pesquisa retorna registros nos quais o código de orçamento/pedido ou parte deste código é igual ao passado no parâmetro.

Exemplo: Para a pesquisa retornar registros com o código 12345, pode-se passar tanto o parâmetro 12345, quanto os parâmetros 1, 2, 3, 4, 5, 12, 23, 123, 345…

name

string

A pesquisa retorna registros nos quais o nome de orçamento/pedido ou parte deste nome é igual ao passado no parâmetro.

Exemplo: Para a pesquisa retornar registros com o nome ABCDE, pode-se passar tanto o parâmetro ABCDE, quanto os parâmetros A, B, C, D, E, AB, BC, ABC, CDE…

powerGTE

number

A pesquisa retorna registros criados com potência em Wp superior ou igual à passada no parâmetro.

powerLTE

number

A pesquisa retorna registros criados com potência em Wp inferior ou igual à passada no parâmetro.

freightState

string

A pesquisa retorna registros criados com o estado do frete de entrega igual ao da Unidade Federativa passada no parâmetro. Formato (UF).

freightCity

string

A pesquisa retorna registros nos quais o nome da cidade do frete de entrega ou parte deste nome é igual ao passado no parâmetro.

Exemplo: Para a pesquisa retornar registros com o nome da cidade ABCDE, pode-se passar tanto o parâmetro ABCDE, quanto os parâmetros A, B, C, D, E, AB, BC, ABC, CDE…

companyCNPJ

string

A pesquisa retorna registros nos quais o CNPJ da empresa de energia solar ou parte deste CNPJ é igual ao passado no parâmetro. Formato (00.000.000/000-00).

Exemplo: Para a pesquisa retornar registros com o CNPJ 01.234.567/0001-89, pode-se passar tanto o parâmetro 01.234.567/0001-89, quanto os parâmetros 0, 1, 2, 3, 4, 01, 56, 0001, 567/0001…

responsibleEmail

string

A pesquisa retorna registros nos quais o e-mail do colaborador responsável pelo orçamento/pedido ou parte deste e-mail é igual ao passado no parâmetro.

Exemplo: Para a pesquisa retornar registros com o e-mail [email protected], pode-se passar tanto o parâmetro [email protected], quanto os parâmetros e, m, a, @, ail, .com, email, @email.com…

removed

boolean

A pesquisa retorna os registros que foram removidos.

Response

string

Example:

"Identificador (ID) da requisição"

name

string

Example:

"Nome da requisição"

code

string

Example:

"200000000"

kind

string

Example:

"Kit Personalizado"

totalPower

number

Example:

22.75

budgetCreated

string

Example:

"2022-01-01T12:00:00.000Z"

orderCreated

string

Example:

"2022-01-01T12:00:00.000Z"

dealStatus

string

Example:

"Novo"

stockStatus

string

Example:

"reserved"

originalValue

number

Example:

10000

discount

number

Example:

10

surcharge

number

Example:

10

finalValue

number

Example:

9000

differenceWithPaymentConditionApplied

number

Diferença entre o valor do pedido/orçamento e o valor final com a forma de pagamento aplicada.

Example:

0

notes

string

Example:

"<p>Anotações internas</p>"

addedBy

object

Show child attributes

addedBy.name

string

Example:

"Nome"

addedBy.surname

string

Example:

"Sobrenome"

addedBy.email

string

Example:

"[email protected]"

addedBy.cellphone

string

Example:

"(00) 00000-0000"

payment

object

Show child attributes

payment.type

string

Example:

"pix / boleto / debito / credito / financiamento / other"

payment.condition

object

Show child attributes

payment.condition.name

string

Example:

"À vista"

payment.condition.quantityOfInstallments

number

Example:

1

payment.condition.conditionType

string

Example:

"notUpdate / increase / decrease"

payment.condition.modifierType

string

Example:

"percentage / fixed"

payment.condition.value

number

Example:

10

payment.status

string

Example:

"notRequested / requested / received / cancelled"

payment.description

string

Example:

"Codigo PIX: XYZ"

payment.files

object[]

Show child attributes

payment.files.path

string

Example:

""

payment.files.originalName

string

Example:

""

payment.transactionStatus

enum<string>

Available options:

pending,

pre_approved,

approved,

canceled,

voided,

failed,

unknown

Example:

"pending"

payment.transactionId

string

Example:

"AAABBB123AA"

payment.authorizationNsu

string

Example:

"123123"

payment.authorizationCode

string

Example:

"123123"

payment.paidAt

string

Example:

"2025-01-01T00:00"

payment.creditCard

object

Show child attributes

payment.creditCard.brand

string

Example:

"visa"

payment.creditCard.last4digits

string

Example:

"1234"

payment.creditCard.first6digits

string

Example:

"123456"

payment.creditCard.holderName

string

Example:

"John Doe"

responsible

object

Show child attributes

responsible.name

string

Example:

"Nome do responsável"

responsible.surname

string

Example:

"Sobrenome do responsável"

responsible.email

string

Example:

"[email protected]"

responsible.cellphone

string

Example:

"(00) 00000-0000"

company

object

Show child attributes

company.cnpj

string

Example:

"00.000.000/0000-00"

company.cpf

string

Example:

"000.000.000-00"

company.fantasyName

string

Example:

"Nome fantasia"

company.companyName

string

Example:

"Razão social"

company.mainContact

object

Show child attributes

company.mainContact.name

string

Example:

"Nome"

company.mainContact.surname

string

Example:

"Sobrenome"

company.mainContact.email

string

Example:

"[email protected]"

company.mainContact.cellphone

string

Example:

"(00) 00000-0000"

company.address

object

Show child attributes

company.address.CEP

string

Example:

"00000-000"

company.address.state

string

Example:

"SC"

company.address.city

string

Example:

"Nome da Cidade"

company.address.neighborhood

string

Example:

"Nome do Bairro"

company.address.patio

string

Example:

"Nome da Rua"

company.address.number

string

Example:

"1000"

company.address.complement

string

Example:

"Bloco X, Casa Y"

products

object[]

Show child attributes

products.type

string

Example:

"module / inverter / stringBox / complementaryEquipment / extraItem"

products.productCode

string

Example:

"codigo123"

products.name

string

Example:

"Nome do produto"

products.quantity

number

Example:

10

products.singlePrice

number

Example:

1000

products.totalPrice

number

Example:

10000

products.structure

object

Show child attributes

products.structure.name

string

Example:

"Cerâmica Colonial"

products.structure.type

string

Example:

"cerâmica"

products.structure.amount

number

Example:

1

products.structure.price

number

Example:

1000

products.center

object

Show child attributes

products.center.name

string

Example:

"Primeiro CD"

products.center.code

string

Example:

"CD001"

files

object[]

Show child attributes

files.category

string

Example:

"CPF"

files.uploadedFiles

string[]

customForm

object[]

Show child attributes

customForm.question

string

Example:

"Data de nascimento"

customForm.answer

string

Example:

"01/01/1900"

structure

object[]

Show child attributes

structure.kind

string

Example:

"Sem Estrutura"

structure.arrangements

object[]

Show child attributes

structure.arrangements.linesAmount

number

Example:

2

structure.arrangements.modulesByLine

number

Example:

25

structure.arrangements.orientation

string

Example:

"Retrato / Paisagem"

freight

object

Show child attributes

freight.type

string

Example:

"CIF / FOB"

freight.zoneType

string

Example:

"Rural / Urbana"

freight.timeRestriction

string

Example:

"Restrição de horário"

freight.truckPossible

string

Example:

"Sim / Não"

freight.price

number

Example:

1000

freight.integrationData

object

Show child attributes

freight.integrationData.id

string

Example:

"ID da integração (se houver)"

freight.integrationData.name

string

Example:

"Nome da integração"

freight.integrationData.logisticProviderName

string

Example:

"Nome do provedor logístico"

freight.address

object

Show child attributes

freight.address.CEP

string

Example:

"00000-000"

freight.address.state

string

Example:

"SC"

freight.address.city

string

Example:

"Nome da Cidade"

freight.address.neighborhood

string

Example:

"Nome do Bairro"

freight.address.patio

string

Example:

"Nome da Rua"

freight.address.number

string

Example:

"1000"

freight.address.complement

string

Example:

"Bloco X, Casa Y"

freight.address.patioFormatted

string

Example:

"Logradouro"

freight.address.patioType

string

Example:

"Tipo do Logradouro"

invoice

object

Show child attributes

Example:

"Razão Social"

invoice.nomeFantasia

string

Example:

"Nome Fantasia"

invoice.cnpj

string

Example:

"00.000.000/0000-00"

invoice.temInscricaoEstadual

string

Example:

"sim"

invoice.ie

string

Este campo é retornado caso o campo 'temInscricaoEstadual' seja igual a 'sim'.

Example:

"000000000"

invoice.cpf

string

Example:

"000.000.000-00"

invoice.rg

string

Example:

"0000000"

invoice.telephone

string

Example:

"(00) 0000-0000"

invoice.email

string

Example:

"[email protected]"

invoice.originalInvoiceValue

number

Example:

100000

invoice.serviceToAddInvoiceValue

number

Example:

10000

invoice.requestedInvoiceValue

number

Example:

120000

invoice.address

object

Show child attributes

invoice.address.CEP

string

Example:

"00000-000"

invoice.address.state

string

Example:

"SC"

invoice.address.city

string

Example:

"Nome da Cidade"

invoice.address.neighborhood

string

Example:

"Nome do Bairro"

invoice.address.patio

string

Example:

"Nome da Rua"

invoice.address.number

string

Example:

"1000"

invoice.address.complement

string

Example:

"Bloco X, Casa Y"

invoice.address.patioFormatted

string

Example:

"Logradouro"

invoice.address.patioType

string

Example:

"Tipo do Logradouro"

apiSent

boolean

Example:

true

apiSentUpdated

string

Example:

"2022-01-01T12:00:00.000Z"

billingDate

string

Example:

"2025-01-01"

customData

object[]

Show child attributes

customData.key

string

Código de identificação do campo

customData.value

default:0000

Texto aberto

customData.type

enum<string>

Tipo do campo

Available options:

text,

date,

integer,

decimal,

currency,

currencyGeneric,

singleSelect,

multiSelect

removed

boolean

Example:

false

Visão Geral da API Atualiza o status do orçamento/pedido

⌘I

Visão Geral

Requests

Empresas

Produtos

Campos customizados

Retorna os dados dos orçamentos ou dos pedidos

Authorizations

Path Parameters

Query Parameters

Response