Sign in

v17

latestOpenAPI 3.1.0raw.githubusercontent.com2026-02-1291962.1 KB
Debt Positions API

The Organization creates a debt Position.

post/organizations/{organizationfiscalcode}/debtpositions

Path parameters

organizationfiscalcodestring required

Organization fiscal code, the fiscal code of the Organization.

Query parameters

toPublishboolean

Request body

iupdstring required
type'F' | 'G' required
payStandInboolean

feature flag to enable a debt position in stand-in mode

fiscalCodestring required
fullNamestring required
streetNamestring
civicNumberstring
postalCodestring
citystring
provincestring
regionstring
countrystring
emailstring
phonestring
switchToExpiredboolean required

feature flag to enable the debt position to expire after the due date

companyNamestring required
officeNamestring
validityDatestring date-time
paymentDatestring date-time
status'DRAFT' | 'PUBLISHED' | 'VALID' | 'INVALID' | 'EXPIRED' | 'PARTIALLY_PAID' | 'PAID' | 'REPORTED'

Example request

{
  "payStandIn": true,
  "country": "IT",
  "email": "email@domain.com",
  "paymentOption": [
    {
      "transfer": [
        {
          "organizationFiscalCode": "00000000000",
          "iban": "IT0000000000000000000000000",
          "postalIban": "IT0000000000000000000000000",
          "stamp": {
            "provincialResidence": "RM"
          }
        }
      ]
    }
  ]
}

Response

Request created.

iupdstring required
type'F' | 'G' required
payStandInboolean

feature flag to enable a debt position in stand-in mode

fiscalCodestring required
fullNamestring required
streetNamestring
civicNumberstring
postalCodestring
citystring
provincestring
regionstring
countrystring
emailstring
phonestring
switchToExpiredboolean required

feature flag to enable the debt position to expire after the due date

companyNamestring required
officeNamestring
validityDatestring date-time
paymentDatestring date-time
status'DRAFT' | 'PUBLISHED' | 'VALID' | 'INVALID' | 'EXPIRED' | 'PARTIALLY_PAID' | 'PAID' | 'REPORTED'

Example response

{
  "payStandIn": true,
  "country": "IT",
  "email": "email@domain.com",
  "paymentOption": [
    {
      "transfer": [
        {
          "organizationFiscalCode": "00000000000",
          "iban": "IT0000000000000000000000000",
          "postalIban": "IT0000000000000000000000000",
          "stamp": {
            "provincialResidence": "RM"
          }
        }
      ]
    }
  ]
}