API Documentation

API Endpoint

Subsidiaries

Subsidiaries

Supported filter params

  • status (1: active, 2: archived)
GET /api/v2/subsidiaries
Requestsreturns subsidiary

GET  /api/v2/subsidiaries

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "2426",
      "type": "subsidiaries",
      "attributes": {
        "name": "company",
        "invoice_number_format": null,
        "invoice_number_scope": null,
        "archived_at": null,
        "show_delivery_date": false,
        "einvoice_payment_means_type_id": null,
        "einvoice_download_format_id": null,
        "facility_costs_breakdown": {},
        "peppol_id": null,
        "export_integration_type_id": null,
        "invoice_logo_url": null,
        "facility_costs": 0,
        "facility_costs_default": 0,
        "facility_costs_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1950"
          }
        },
        "bill_from": {
          "meta": {
            "included": false
          }
        },
        "custom_domain": {
          "meta": {
            "included": false
          }
        },
        "default_tax_rate": {
          "meta": {
            "included": false
          }
        },
        "default_bank_account": {
          "meta": {
            "included": false
          }
        },
        "integration": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/subsidiaries?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/subsidiaries?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200
  }
}

Gets all subsidiaries
GET/api/v2/subsidiaries

GET /api/v2/subsidiaries/1
Requestsreturns subsidiary

GET  /api/v2/subsidiaries/2427

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "2427",
    "type": "subsidiaries",
    "attributes": {
      "name": "company",
      "invoice_number_format": null,
      "invoice_number_scope": null,
      "archived_at": null,
      "show_delivery_date": false,
      "einvoice_payment_means_type_id": null,
      "einvoice_download_format_id": null,
      "facility_costs_breakdown": {},
      "peppol_id": null,
      "export_integration_type_id": null,
      "invoice_logo_url": null,
      "facility_costs": 0,
      "facility_costs_default": 0,
      "facility_costs_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1951"
        }
      },
      "bill_from": {
        "meta": {
          "included": false
        }
      },
      "custom_domain": {
        "meta": {
          "included": false
        }
      },
      "default_tax_rate": {
        "meta": {
          "included": false
        }
      },
      "default_bank_account": {
        "meta": {
          "included": false
        }
      },
      "integration": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Gets a subsidiary
GET/api/v2/subsidiaries/{id}

URI Parameters
HideShow
id
number (required) Example: 1

subsidiary id

POST /api/v2/subsidiaries
Requestscreates subsidiaryreturns error

POST  /api/v2/subsidiaries

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "subsidiaries",
    "attributes": {
      "name": "Name"
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "2429",
    "type": "subsidiaries",
    "attributes": {
      "name": "Name",
      "invoice_number_format": null,
      "invoice_number_scope": null,
      "archived_at": null,
      "show_delivery_date": false,
      "einvoice_payment_means_type_id": null,
      "einvoice_download_format_id": null,
      "facility_costs_breakdown": null,
      "peppol_id": null,
      "export_integration_type_id": null,
      "invoice_logo_url": null,
      "facility_costs": 0,
      "facility_costs_default": 0,
      "facility_costs_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1952"
        }
      },
      "bill_from": {
        "meta": {
          "included": false
        }
      },
      "custom_domain": {
        "meta": {
          "included": false
        }
      },
      "default_tax_rate": {
        "meta": {
          "included": false
        }
      },
      "default_bank_account": {
        "meta": {
          "included": false
        }
      },
      "integration": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Create a subsidiary
POST/api/v2/subsidiaries

URI Parameters
HideShow
name
string (required) Example: Name

name

PATCH /api/v2/subsidiaries/
Requestsupdates subsidiaryreturns error

PATCH  /api/v2/subsidiaries/2431

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "subsidiaries",
    "attributes": {
      "name": "New Name"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "2431",
    "type": "subsidiaries",
    "attributes": {
      "name": "New Name",
      "invoice_number_format": null,
      "invoice_number_scope": null,
      "archived_at": null,
      "show_delivery_date": false,
      "einvoice_payment_means_type_id": null,
      "einvoice_download_format_id": null,
      "facility_costs_breakdown": {},
      "peppol_id": null,
      "export_integration_type_id": null,
      "invoice_logo_url": null,
      "facility_costs": 0,
      "facility_costs_default": 0,
      "facility_costs_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1954"
        }
      },
      "bill_from": {
        "meta": {
          "included": false
        }
      },
      "custom_domain": {
        "meta": {
          "included": false
        }
      },
      "default_tax_rate": {
        "meta": {
          "included": false
        }
      },
      "default_bank_account": {
        "meta": {
          "included": false
        }
      },
      "integration": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Update a subsidiary
PATCH/api/v2/subsidiaries/

URI Parameters
HideShow
name
string (optional) Example: New+name

name

default_tax_rate_id
number (optional) Example: 1

ID of default tax rate for the subsidiary

PATCH /api/v2/subsidiaries/1/archive
Requestsarchives subsidiaryreturns error

PATCH  /api/v2/subsidiaries/2435/archive

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "2435",
    "type": "subsidiaries",
    "attributes": {
      "name": "company",
      "invoice_number_format": null,
      "invoice_number_scope": null,
      "archived_at": "2025-06-17T06:15:24.000+02:00",
      "show_delivery_date": false,
      "einvoice_payment_means_type_id": null,
      "einvoice_download_format_id": null,
      "facility_costs_breakdown": {},
      "peppol_id": null,
      "export_integration_type_id": null,
      "invoice_logo_url": null,
      "facility_costs": 0,
      "facility_costs_default": 0,
      "facility_costs_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1958"
        }
      },
      "bill_from": {
        "meta": {
          "included": false
        }
      },
      "custom_domain": {
        "meta": {
          "included": false
        }
      },
      "default_tax_rate": {
        "meta": {
          "included": false
        }
      },
      "default_bank_account": {
        "meta": {
          "included": false
        }
      },
      "integration": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Archives a subsidiary
PATCH/api/v2/subsidiaries/{id}/archive

URI Parameters
HideShow
id
number (required) Example: 1

subsidiary id

Generated by aglio on 17 Jun 2025