Consultar uma Nota de Produto

Requisição

Parâmetros Path

product_invoice_id

string

requerido

Identificador único da nota de produto.

Parâmetros Header

Authorization

string

requerido

Token de autorização

Exemplos de Requisição

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Respostas

🟢200Sucesso

application/json

Body

id

string

requerido

Identificador único

number

integer

requerido

Número de controle (sequencial)

Padrão:

0

reference_id

string

requerido

Identificador único da referência

company_id

string

requerido

Identificador único da empresa

borrower_id

string

requerido

Identificador único do tomador

borrower

object (Borrower)

requerido

Tomador

document_number

enum<string>

requerido

CPF ou CNPJ

Valores permitidos:

serviceproduct

name

string

requerido

Nome ou Razão Social

email

string

requerido

E-mail

state_tax_number

string

requerido

Inscrição Estadual

phone_number

string

requerido

Telefone

type

enum<string>

requerido

Tipo do tomador

Valores permitidos:

LEGALNATURAL

address

object (Address)

requerido

Endereço

status

enum<string>

requerido

Valores permitidos:

ISSUEDPROCESSINGCANCELLINGCANCELLEDREJECTED

invoice_order_id

string

requerido

Identificador único do pedido

finality

string

requerido

Finalidade

cancelled_at

string

opcional

Data de cancelamento

issued_at

string

opcional

Data de emissão

invoice_payment_id

string

opcional

Identificador único do invoice payment

reason

string

opcional

Motivo da rejeição

reference_number

string

opcional

Número da nota

Exemplo

{
    "id": "string",
    "number": "0",
    "reference_id": "string",
    "company_id": "string",
    "borrower_id": "string",
    "borrower": {
        "document_number": "service",
        "name": "string",
        "email": "string",
        "state_tax_number": "string",
        "phone_number": "string",
        "type": "LEGAL",
        "address": {
            "postal_code": "string",
            "district": "string",
            "district_type": "string",
            "city": "string",
            "city_code": "string",
            "state": "string",
            "neighborhood": "string",
            "number": "string",
            "additional_information": "string"
        }
    },
    "status": "ISSUED",
    "invoice_order_id": "string",
    "finality": "string",
    "cancelled_at": "string",
    "issued_at": "string",
    "invoice_payment_id": "string",
    "reason": "string",
    "reference_number": "string"
}

🟠404Nota de produto não encontrada