Criar uma Pré-Autorização

Request

Header Params

Authorization

string

required

Token de acesso obtido no enpoint de Autenticação.

Example:

Body Params application/json

projectIdentifier

string

required

Identificador do projeto na pré-autorização

uniqueId

string

required

Identificador externo referente ao projeto. Obrigatório somente via integração

clientTaxId

string

required

CNPJ do cliente indicado na pré-autorização. Sem formatação

contractedTaxId

string

required

CNPJ do contratado (fornecedor) indicado na pré-autorização. Sem formatação

contractedEmail

string

required

E-mail do contratado (fornecedor) indicado na pré-autorização.

contractedReceiptNumber

string

optional

Número da nota fiscal do fornecedor

constructorInvoice

object

required

Informações da fatura da construtora

originalAmount

number <float>

required

Valor Bruto da fatura

Examples:

1000.052000.6520000.5

withHoldTaxAmount

number <float>

optional

Valor da retenção fiscal da fatura

Examples:

1000100.051250.55

dueDate

string

required

Data de vencimento

number

string

required

Número da nota

description

string

optional

Descrição da nota

contractedReceipt

object

optional

Arquivo da nota fiscal do fornecedor no formato PDF em Base64

contentBase64

string

optional

Nota fiscal do contratado em base64. Apenas extensões .pdf e .xml são aceitas.

Example

{
  "projectIdentifier": "Projeto Maracanã",
  "uniqueId": "PRJ-01",
  "clientTaxId": "string",
  "contractedTaxId": "99999999999999",
  "contractedEmail": "test@test.com",
  "contractedReceiptNumber": "0001",
  "constructorInvoice": {
    "originalAmount": 10000,
    "withHoldTaxAmount": 1000,
    "discountedAmount": 9000,
    "dueDate": "2022-10-05",
    "number": "0001",
    "description": "Compra de cimento"
  },
  "contractedReceipt": {
    "contentBase64": "string"
  }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://one.app-hm.oneos.com.br/api/v1/oneos/prospects/pre-authorizations' \
--header 'Authorization: ' \
--header 'Content-Type: application/json' \
--data-raw '{
  "projectIdentifier": "Projeto Maracanã",
  "uniqueId": "PRJ-01",
  "clientTaxId": "string",
  "contractedTaxId": "99999999999999",
  "contractedEmail": "test@test.com",
  "contractedReceiptNumber": "0001",
  "constructorInvoice": {
    "originalAmount": 10000,
    "withHoldTaxAmount": 1000,
    "discountedAmount": 9000,
    "dueDate": "2022-10-05",
    "number": "0001",
    "description": "Compra de cimento"
  },
  "contractedReceipt": {
    "contentBase64": "string"
  }
}'

Responses

🟢200OK

application/json

Body

id

integer

required

Identificador Interno

projectIdentifier

string

required

Identificador do projeto na pré-autorização

contractedName

string

required

Nome do contratado

contractedTaxId

string

required

CNPJ do contratado

clientName

string

required

Nome do cliente

clientPersonType

string

required

Tipo de cliente (PJ ou PF)

clientTaxId

string

required

CNPJ do cliente indicado na pré-autorição

constructorName

string

required

Nome da construtora

constructorTaxId

string

required

CNPJ da construtora

prospectAnticipationId

integer

optional

Id da solicitação de antecipação gerada a partir da pré-autorização

expirationDate

string

required

Data de expiração da pré-autorização

uniqueId

string

optional

Identificador externo referente ao projeto. Obrigatório somente via integração

status

string

required

Status da pré-autorização

revocationReasons

string

optional

Motivo da revogação

constructorInvoice

object

required

Informações da fatura da construtora

originalAmount

number <float>

required

Valor Bruto da fatura

Examples:

1000010000.512500.55

withHoldTaxAmount

number <float>

optional

Valor da retenção fiscal da fatura

Examples:

10001000.5125.3222347.65

discountedAmount

string

required

Valor líquido da nota fiscal

dueDate

string

required

Data de vencimento

number

string

required

Número da nota

description

string

optional

Descrição da nota

contractedReceiptNumber

string

optional

Número da nota fiscal do fornecedor

origin

string

required

Origem da pré-autorização

Example

{
  "id": 1,
  "projectIdentifier": "Projeto Maracanã",
  "constructorName": "One Construction",
  "clientTaxId": "99999999999999",
  "prospectAnticipationId": 1,
  "expirationDate": "2022-10-05",
  "uniqueId": "Projeto Maracanã",
  "status": "WAITING_CONTRACTED",
  "revocationReason": "string",
  "constructorInvoice": {
    "originalAmount": 1000,
    "withHoldTaxAmount": 100,
    "dueDate": "2022-10-05",
    "number": "0001",
    "description": "Compra de cimento"
  },
  "contractedReceiptNumber": "string"
}