Criar uma Pré-Autorização

POST

/api/v1/oneos/prospects/pre-authorizations

Enpoint responsável por criar as pré-autorizações via integração.

Request

Header Params

Body Params application/json

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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

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"
}

Modified at 2024-07-19 19:04:21

Entendendo a Pré-Autorização

Cancelar uma Pré-Autorização