Consultar uma Nota de Serviço

Requisição

Parâmetros Path

service_invoice_id

string

requerido

Identificador único da nota de serviço.

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

reference_id

string

requerido

ID de referência

number

requerido

Número de controle (sequencial)

municipal_service_id

string

requerido

ID do serviço municipal

status

enum<string>

requerido

Status da nota

Valores permitidos:

ISSUEDCANCELLEDPROCESSINGREJECTEDCANCELLING

amount_cents

integer

requerido

Valor da nota

borrower_id

string

requerido

borrower

object (Borrower)

requerido

Tomador da nota

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

reference_number

string

opcional

Número da nota

issued_at

string

opcional

Data da emissão

cancelled_at

string

opcional

Data de cancelamento

reason

string

opcional

Motivo da rejeição

additional_information

string

opcional

Informações adicionais

Exemplo

{
    "id": "string",
    "reference_id": "string",
    "number": 0,
    "municipal_service_id": "string",
    "status": "ISSUED",
    "amount_cents": 0,
    "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"
        }
    },
    "reference_number": "string",
    "issued_at": "string",
    "cancelled_at": "string",
    "reason": "string",
    "additional_information": "string"
}

🟠404Nota de serviço não encontrada