Debt Positions API

Return the list of the organization debt positions. The due dates interval is mutually exclusive with the payment dates interval.

get/organizations/{organizationfiscalcode}/debtpositions

Path parameters

organizationfiscalcodestring required

Organization fiscal code, the fiscal code of the Organization.

Query parameters

limitinteger

Number of elements on one page. Default = 50

pageinteger

Page number. Page value starts from 0

due_date_fromstring date

Filter from due_date (if provided use the format yyyy-MM-dd). If not provided will be set to 30 days before the due_date_to.

due_date_tostring date

Filter to due_date (if provided use the format yyyy-MM-dd). If not provided will be set to 30 days after the due_date_from.

payment_date_fromstring date

Filter from payment_date (if provided use the format yyyy-MM-dd). If not provided will be set to 30 days before the payment_date_to.

payment_date_tostring date

Filter to payment_date (if provided use the format yyyy-MM-dd). If not provided will be set to 30 days after the payment_date_from

status'DRAFT' | 'PUBLISHED' | 'VALID' | 'INVALID' | 'EXPIRED' | 'PARTIALLY_PAID' | 'PAID' | 'REPORTED'

Filter by debt position status

orderby'INSERTED_DATE' | 'IUPD' | 'STATUS' | 'COMPANY_NAME'

Order by INSERTED_DATE, COMPANY_NAME, IUPD or STATUS

ordering'ASC' | 'DESC'

Direction of ordering

Response

Obtained all organization payment positions.

Example response

{
  "payment_position_list": [
    {
      "paymentOption": [
        {
          "transfer": [
            {
              "stamp": {
                "provincialResidence": "RM"
              }
            }
          ]
        }
      ]
    }
  ]
}

Changes

Changed in 5 of the 17 revisions of this API.328

    • the endpoint scheme security Authorization was removed from the API

      api-security-removed

    • added the non-success response with the status 403

      response-non-success-status-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 40898e9a8f8b222See the full diff
    • for the query request parameter limit, default value was changed from 50 to 10

      request-parameter-default-value-changed

    • for the query request parameter limit, the max was decreased from 100.00 to 50.00

      request-parameter-max-decreased

    • removed the optional property payment_position_list/items/aca from the response with the 200 status

      response-optional-property-removed

    • removed the optional property payment_position_list/items/payStandIn from the response with the 200 status

      response-optional-property-removed

    • the query request parameter page became optional

      request-parameter-became-optional

    • added the optional property payment_position_list/items/paymentOption/items/transfer/items/companyName to the response with the 200 status

      response-optional-property-added

    • the aca response's property default value false was added for the status 200

      response-property-default-value-added

    • the payStandIn response's property default value true was added for the status 200

      response-property-default-value-added

    • added the optional property payment_position_list/items/aca to the response with the 200 status

      response-optional-property-added

    • added the optional property payment_position_list/items/payStandIn to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • for the query request parameter orderby, default value was changed from COMPANY_NAME to INSERTED_DATE

      request-parameter-default-value-changed