Delete an entry

curl --request POST \
  --url https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}/delete

import requests

url = "https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}/delete"

response = requests.post(url)

print(response.text)

const options = {method: 'POST'};

fetch('https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}/delete', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}/delete",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}/delete"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}/delete")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}/delete")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

{
  "id": "3f9a1c2e-7b4d-4e8a-9c1f-2d5b6a7c8e90",
  "identifier": "MONTHLY_PLAN",
  "invoice": "0b7c2a44-6f1e-4d3b-9a8e-5c2f1d0e9b7a",
  "amount": 15000,
  "chargeMethod": "LATER",
  "productType": "RECURRENT",
  "effectiveAt": "2026-10-01T09:00:00.000Z",
  "external": {
    "transaction": "6711b4c0d8e1a30012b7c9f2"
  },
  "description": "Mensalidade do plano Pro",
  "status": "DELETED",
  "createdBy": "5f0c2b1e-8a3d-4e6f-9b7c-2d1a0e9f8c7b",
  "updatedBy": "5f0c2b1e-8a3d-4e6f-9b7c-2d1a0e9f8c7b",
  "createdAt": "2026-10-01T09:00:00.000Z",
  "updatedAt": "2026-10-01T09:00:00.000Z"
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "NEGATIVE_INVOICE_AMOUNT",
  "origin": "BILLING",
  "message": "Invoice amount can't be less than credit parties amount"
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "INSUFFICIENT_PERMISSIONS",
  "origin": "BILLING",
  "message": "insufficient permissions"
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "INVOICE_NOT_FOUND",
  "origin": "BILLING",
  "message": "invoice not found"
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "INVOICE_NOT_OPEN",
  "origin": "BILLING",
  "message": "invoice is not open for changes"
}

POST

realms

{realmId}

organizations

{organizationId}

invoices

{invoiceId}

entries

{invoiceEntryId}

delete

Delete an entry

curl --request POST \
  --url https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}/delete

import requests

url = "https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}/delete"

response = requests.post(url)

print(response.text)

const options = {method: 'POST'};

fetch('https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}/delete', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}/delete",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}/delete"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}/delete")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}/delete")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

{
  "id": "3f9a1c2e-7b4d-4e8a-9c1f-2d5b6a7c8e90",
  "identifier": "MONTHLY_PLAN",
  "invoice": "0b7c2a44-6f1e-4d3b-9a8e-5c2f1d0e9b7a",
  "amount": 15000,
  "chargeMethod": "LATER",
  "productType": "RECURRENT",
  "effectiveAt": "2026-10-01T09:00:00.000Z",
  "external": {
    "transaction": "6711b4c0d8e1a30012b7c9f2"
  },
  "description": "Mensalidade do plano Pro",
  "status": "DELETED",
  "createdBy": "5f0c2b1e-8a3d-4e6f-9b7c-2d1a0e9f8c7b",
  "updatedBy": "5f0c2b1e-8a3d-4e6f-9b7c-2d1a0e9f8c7b",
  "createdAt": "2026-10-01T09:00:00.000Z",
  "updatedAt": "2026-10-01T09:00:00.000Z"
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "NEGATIVE_INVOICE_AMOUNT",
  "origin": "BILLING",
  "message": "Invoice amount can't be less than credit parties amount"
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "INSUFFICIENT_PERMISSIONS",
  "origin": "BILLING",
  "message": "insufficient permissions"
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "INVOICE_NOT_FOUND",
  "origin": "BILLING",
  "message": "invoice not found"
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "INVOICE_NOT_OPEN",
  "origin": "BILLING",
  "message": "invoice is not open for changes"
}

The entry is not removed: it is kept with status DELETED and no longer counts toward the invoice amount. The invoice must be OPEN; a closed, paid or canceled invoice refuses the request with INVOICE_NOT_OPEN. Only an admin of the organization, or an admin of the realm, can delete an entry. When taking the amount off would leave the invoice amount negative, the request is refused with NEGATIVE_INVOICE_AMOUNT and nothing changes. Delete each entry once: the entry’s status is not checked, so repeating the call takes its amount off the invoice again. Answers the entry, with status DELETED and updatedBy set to the ID of the authenticated caller; its updatedAt is not refreshed.

Path Parameters

realmId

string<uuid>

required

ID of your realm.

Format: UUID

organizationId

string<uuid>

required

ID of the organization that issued the invoice.

Format: UUID

invoiceId

string<uuid>

required

ID of the invoice the entry belongs to.

Format: UUID

invoiceEntryId

string<uuid>

required

ID of the entry to delete, as returned by GET .../invoices/{invoiceId}/entries.

Format: UUID

Response

Successful response

One charge (line item) of an invoice. The invoice amount is the sum of the amounts of its OPEN entries.

string<uuid>

required

ID of the entry.

Example:

"3f9a1c2e-7b4d-4e8a-9c1f-2d5b6a7c8e90"

identifier

string

required

What the charge is for: the identifier of the deal product that generated the entry, or the label sent when it was added through the API. Free text.

Example:

"MONTHLY_PLAN"

invoice

string<uuid>

required

ID of the invoice the entry belongs to.

Example:

"0b7c2a44-6f1e-4d3b-9a8e-5c2f1d0e9b7a"

amount

integer

required

Amount of the charge in centavos (15000 is R$ 150,00). It counts toward the invoice amount while the entry is OPEN.

Example:

15000

chargeMethod

enum<string>

required

When the charge is collected. LATER: it is added to the invoice and paid with it. INSTANT: it is also debited from the payer's Portão 3 account as soon as it is added.

Available options:

INSTANT,

LATER

Example:

"LATER"

productType

enum<string>

required

When the charge's product is billed. RECURRENT: on every invoice of the deal. ONE_TIME: on the first invoice only. ON_EVENT: never automatically; such an entry is added through the API, when the event happens.

Available options:

RECURRENT,

ONE_TIME,

ON_EVENT

Example:

"RECURRENT"

effectiveAt

string<date-time>

required

When the entry took effect: the moment it was created.

Example:

"2026-10-01T09:00:00.000Z"

external

object

required

References of the entry outside the invoice.

Show child attributes

description

string

required

Free text describing the charge. Empty when there is none.

Example:

"Mensalidade do plano Pro"

status

enum<string>

required

OPEN: the entry counts toward the invoice amount. DELETED: the entry was deleted and no longer counts.

Available options:

OPEN,

DELETED

Example:

"DELETED"

createdBy

string

required

ID of who created the entry: the authenticated caller of the API that added it, or the Portão 3 service that generated it from the deal.

Example:

"5f0c2b1e-8a3d-4e6f-9b7c-2d1a0e9f8c7b"

updatedBy

string

required

ID of who last changed the entry: who created it, until someone deletes it.

Example:

"5f0c2b1e-8a3d-4e6f-9b7c-2d1a0e9f8c7b"

createdAt

string<date-time>

required

When the entry was created. Entries added in the same request are one minute apart, in the order they were sent, so that a listing keeps that order.

Example:

"2026-10-01T09:00:00.000Z"

updatedAt

string<date-time>

required

When the entry was last changed. Deleting an entry does not refresh it.

Example:

"2026-10-01T09:00:00.000Z"

Overview

Identity

Banking

Billing

Accounting

Registry

Platform

Notification

Rule Engine

Scheduling

Travel

Vehicles

Attachments

Delete an entry

Path Parameters

Response