Invoice installments

List invoice installments using invoice details

get

Query invoice installments using invoice details such as number, series, installment, and either a specific issue date or a range of issue dates.

Query parameters

invoice_numberstringOptional

invoice_seriesstringOptional

installmentstringOptional

issue_datestring · dateOptional

issue_date_fromstring · dateOptional

issue_date_tostring · dateOptional

Responses

200

List of matching invoice installments

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

GET /financing/invoice_installments HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "invoice_installments": [
    {
      "issue_date": "2025-07-01",
      "invoice_number": "12345",
      "invoice_series": "1",
      "installment": "1",
      "installment_due_date": "2025-08-01",
      "installment_amount": 5000,
      "document_supplier": "12345678000199",
      "anticipation_status": "Created",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    {
      "issue_date": "2025-07-01",
      "invoice_number": "12345",
      "invoice_series": "1",
      "installment": "1",
      "installment_due_date": "2025-08-01",
      "installment_amount": 5000,
      "document_supplier": "12345678000199",
      "anticipation_status": "Settled",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa7",
      "factoring_payable_id": "3fa85f64-5717-4562-b3fc-2c963f66afa8",
      "stages": [
        {
          "anticipation_status": "created",
          "timestamp": "2025-07-10T18:44:06.456370Z",
          "error_message": null,
          "error_code": null
        },
        {
          "anticipation_status": "Requested",
          "timestamp": "2025-07-12T18:44:06.456370Z",
          "error_message": null,
          "error_code": null
        },
        {
          "anticipation_status": "Approved",
          "timestamp": "2025-07-13T18:44:06.456370Z",
          "error_message": null,
          "error_code": null
        },
        {
          "anticipation_status": "Settled",
          "timestamp": "2025-07-14T18:44:06.456370Z",
          "error_message": null,
          "error_code": null
        }
      ]
    }
  ]
}

Create invoice installments that are able to receive anticipation

post

Submits one or more invoice installments to the platform to receive anticipation.

Body

Responses

200

Successfully created invoice installments

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post

POST /financing/invoice_installments HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 408

{
  "invoice_installments": [
    {
      "issue_date": "2025-07-01",
      "invoice_number": "12345",
      "invoice_series": "1",
      "installment": "1",
      "installment_due_date": "2025-08-01",
      "installment_amount": 5000,
      "document_supplier": "12345678000199"
    },
    {
      "issue_date": "2025-07-01",
      "invoice_number": "12345",
      "invoice_series": "1",
      "installment": "2",
      "installment_due_date": "2025-09-01",
      "installment_amount": 5000,
      "document_supplier": "12345678000199"
    }
  ]
}

{
  "invoice_installments": [
    {
      "issue_date": "2025-07-01",
      "invoice_number": "12345",
      "invoice_series": "1",
      "installment": "1",
      "installment_due_date": "2025-08-01",
      "installment_amount": 5000,
      "document_supplier": "12345678000199",
      "anticipation_status": "Created",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    {
      "issue_date": "2025-07-01",
      "invoice_number": "12345",
      "invoice_series": "1",
      "installment": "1",
      "installment_due_date": "2025-08-01",
      "installment_amount": 5000,
      "document_supplier": "12345678000199",
      "anticipation_status": "Created",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa7"
    }
  ]
}

Update of invoice installments

put

The only fields that can be updated are the status (only to 'Deleted'), the due date, and the amount. The other fields are used solely to identify the invoice installments.

Body

Responses

200

Invoice installments updated successfully

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

put

PUT /financing/invoice_installments HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 558

{
  "invoice_installments": [
    {
      "issue_date": "2025-07-01",
      "invoice_number": "12345",
      "invoice_series": "1",
      "installment": "1",
      "installment_due_date": "2025-08-01",
      "installment_amount": 5000,
      "document_supplier": "12345678000199",
      "anticipation_status": "Delete",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    {
      "issue_date": "2025-07-01",
      "invoice_number": "12345",
      "invoice_series": "1",
      "installment": "2",
      "installment_due_date": "2025-09-01",
      "installment_amount": 5000,
      "document_supplier": "12345678000199",
      "anticipation_status": "Delete",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa7"
    }
  ]
}

{
  "invoice_installments": [
    {
      "issue_date": "2025-07-01",
      "invoice_number": "12345",
      "invoice_series": "1",
      "installment": "1",
      "installment_due_date": "2025-08-01",
      "installment_amount": 5000,
      "document_supplier": "12345678000199",
      "anticipation_status": "Deleted",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    {
      "issue_date": "2025-07-01",
      "invoice_number": "12345",
      "invoice_series": "1",
      "installment": "1",
      "installment_due_date": "2025-08-01",
      "installment_amount": 5000,
      "document_supplier": "12345678000199",
      "anticipation_status": "Deleted",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa7"
    }
  ]
}

Get invoice installment

get

Get invoice installment by ID

Path parameters

idstring · uuidRequired

Responses

200

Invoice installment found

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

GET /financing/invoice_installments/{id} HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "issue_date": "2025-07-01",
  "invoice_number": "12345",
  "invoice_series": "1",
  "installment": "1",
  "installment_due_date": "2025-08-01",
  "installment_amount": 5000,
  "document_supplier": "12345678000199",
  "anticipation_status": "Deleted",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa7"
}

Update a invoice installment

patch

Update a invoice installment by ID

Path parameters

idstring · uuidRequired

Body

issue_datestring · dateRequired

invoice_numberstringRequired

invoice_seriesstringRequired

installmentstringRequired

installment_due_datestring · dateRequired

installment_amountnumber · floatRequired

document_supplierstringRequired

anticipation_statusstring · enumOptionalPossible values:

idstring · uuidOptional

factoring_payable_idstring · uuidOptional

Responses

200

Invoice installment updated

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

patch

PATCH /financing/invoice_installments/{id} HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 94

{
  "installment_due_date": "2025-08-01",
  "installment_amount": 5000,
  "anticipation_status": "Delete"
}

{
  "issue_date": "2025-07-01",
  "invoice_number": "12345",
  "invoice_series": "1",
  "installment": "1",
  "installment_due_date": "2025-08-01",
  "installment_amount": 5000,
  "document_supplier": "12345678000199",
  "anticipation_status": "Deleted",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa7"
}

PreviousWebhooks NextWebhooks

Was this helpful?