top of page
Início > Faturamentos > Get faturamentos
Versão: 1.0

Get faturamentos

Última Atualização: 18/03/2024

Este endpoint tem o objetivo de coletar faturamentos.

Endpoint Get

Parâmetros da requisição

chave_acesso : String

Ex: "chave_acesso"

Sintaxe da Resposta

Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:

Elementos da Resposta

content

Lista de faturamentos.

Tipo: Array de JSON.

objectType

Tipo de objeto.

Tipo: String.

id

id.

Tipo: Integer.

createdBy

createdBy.

Tipo: String.

createdDate

Data de criação.

Tipo: Datetime.

lastModifiedBy

lastModifiedBy.

Tipo: String.

lastModifiedDate

Data da última modificação.

Tipo: Datetime.

customerReference

customerReference.

Tipo: String.

date

Data.

Tipo: Datetime.

dueDate

Data de vencimento.

Tipo: Datetime.

errorReason

Razão do erro.

Tipo: String.

externalReference

Chave da nf.

Tipo: String.

amount

Valor do faturamento.

Tipo: Float.

currency

Tipo de moeda.

Tipo: String.

state

state.

Tipo: String.

status

status.

Tipo: String.

rawInvoice

rawInvoice.

Tipo: String.

negotiableInstruments

Instrumento negociável. 

Tipo: String.

objectType

Tipo de objeto.

Tipo: String.

id

id.

Tipo: String.

createdBy

createdBy.

Tipo: String.

createdDate

Data de criação.

Tipo: Datetime.

lastModifiedBy

lastModifiedBy.

Tipo: String.

lastModifiedDate

Data da última alteração.

Tipo: Datetime.

customerReference

Urn e pgid (nome do fornecedor).

Tipo: String.

date

Data.

Tipo: Datetime.

dueDate

Data de vencimento.

Tipo: Datetime.

errorReason

Razão do erro, em caso de erros.

Tipo: String.

externalReference

urn do objeto com o número da NF + Parcela.

Tipo: Datetime.

amount

valor do faturamento.

Tipo: Float.

currency

Tipo de moeda.

Tipo: String.

state

Estado do faturamento.

Tipo: String.

status

Status do faturamento.

Tipo: String.

discountAmount

Desconto.

Tipo: Float.

documentReference

Numero da NF + Parcela.

Tipo: String.

rawNegotiableInstrument

rawNegotiableInstrument.

Tipo: String.

Boleto

Dados do boleto. 

Tipo: JSON.

id

id do boleto.

Tipo: Integer.

createdBy

createdBy

Tipo: String.

createdDate

Data de criação.

Tipo: Datetime.

lastModifiedBy

lastModifiedBy

Tipo: String.

lastModifiedDate

Data da última modificação.

Tipo: Datetime.

amount

Valor do boleto.

Tipo: Float.

available

Disponibilidade do boleto.

Tipo: Bolean.

bankReference

bankReference

Tipo: String.

barcode

Código de barras do boleto.

Tipo: String.

currency

Tipo de moeda.

Tipo: String.

customerReference

Urn e pgid (nome do fornecedor).

Tipo: Bolean.

date

Data do boleto.

Tipo: Date.

documentReference

Número do boleto - Nosso Número

Tipo: String.

dueDate

Data de vencimento.

Tipo: Date.

internalReference

internalReference

Tipo: String.

paidAmount

Valor pago.

Tipo: Float.

paymentDate

Data do pagamento.

Tipo: Date.

url

url.

Tipo: String.

totalElements

Total de elementos.

Tipo: Integer.

size

size.

Tipo: Integer.

number

number.

Tipo: Integer.

pageable

Informações da paginação.

Tipo: Array de JSON.

pageSize

Tamanho da página.

Tipo: Integer.

pageNumber

Número da página atual.

Tipo: Integer.

totalPages

Quantidade de conciliações bancarias.

Tipo: Integer.

numberOfElements

numberOfElements.

Tipo: Integer.

Respostas para erros

Caso ocorra algum erro durante a requisição, os possíveis erros são:

422 Validation Error

bottom of page