API Documentation

API Endpoint

Invoice Attributions

Invoice Attributions

An invoice attribution object represents a link between a budget and an invoice.

Following diagram shows invoice attributions in our data hierarchy:

Invoice attributions diagram

Supported filter params

  • invoice_id (array)

  • budget_id (array)

GET /api/v2/invoice_attributions
Requestsreturns invoice_attributions

GET  /api/v2/invoice_attributions

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": "1",
      "type": "invoice_attributions",
      "attributes": {
        "date_from": null,
        "date_to": null,
        "amount": 10000,
        "amount_default": 12500,
        "amount_normalized": 10000,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "639"
          }
        },
        "invoice": {
          "meta": {
            "included": false
          }
        },
        "budget": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "2",
      "type": "invoice_attributions",
      "attributes": {
        "date_from": null,
        "date_to": null,
        "amount": 10000,
        "amount_default": 12500,
        "amount_normalized": 10000,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "639"
          }
        },
        "invoice": {
          "meta": {
            "included": false
          }
        },
        "budget": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/invoice_attributions?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/invoice_attributions?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 2,
    "page_size": 30,
    "max_page_size": 200
  }
}

Get invoice attributions
GET/api/v2/invoice_attributions


GET /api/v2/invoice_attributions/1
Requestsreturns invoice_attribution

GET  /api/v2/invoice_attributions/3

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": "3",
    "type": "invoice_attributions",
    "attributes": {
      "date_from": null,
      "date_to": null,
      "amount": 10000,
      "amount_default": 12500,
      "amount_normalized": 10000,
      "currency": "EUR",
      "currency_default": "USD",
      "currency_normalized": "EUR"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "640"
        }
      },
      "invoice": {
        "meta": {
          "included": false
        }
      },
      "budget": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Gets an invoice attribution
GET/api/v2/invoice_attributions/{id}

URI Parameters
HideShow
id
number (required) Example: 1

invoice attribution id


POST /api/v2/invoice_attributions
Requestscreates invoice_attributionreturns error

POST  /api/v2/invoice_attributions

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": "invoice_attributions",
    "attributes": {
      "amount": 2000
    },
    "relationships": {
      "invoice": {
        "data": {
          "type": "invoices",
          "id": "18"
        }
      },
      "budget": {
        "data": {
          "type": "deals",
          "id": "608"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "8",
    "type": "invoice_attributions",
    "attributes": {
      "date_from": null,
      "date_to": null,
      "amount": 2000,
      "amount_default": 2500,
      "amount_normalized": 2000,
      "currency": "EUR",
      "currency_default": "USD",
      "currency_normalized": "EUR"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "643"
        }
      },
      "invoice": {
        "meta": {
          "included": false
        }
      },
      "budget": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

POST  /api/v2/invoice_attributions

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": "invoice_attributions",
    "attributes": {
      "amount": ""
    },
    "relationships": {
      "invoice": {
        "data": {
          "type": "invoices",
          "id": "19"
        }
      },
      "budget": {
        "data": {
          "type": "deals",
          "id": "609"
        }
      }
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/amount"
      }
    }
  ]
}

Create an invoice attribution
POST/api/v2/invoice_attributions

URI Parameters
HideShow
invoice_id
number (required) Example: 1

invoice id

deal_id
number (required) Example: 1

deal id

amount
number (required) Example: 100

amount


PATCH /api/v2/invoice_attributions/1
Requestsupdates invoice attributionreturns error

PATCH  /api/v2/invoice_attributions/10

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": "invoice_attributions",
    "attributes": {
      "amount": 5000
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "10",
    "type": "invoice_attributions",
    "attributes": {
      "date_from": null,
      "date_to": null,
      "amount": 5000,
      "amount_default": 6250,
      "amount_normalized": 5000,
      "currency": "EUR",
      "currency_default": "USD",
      "currency_normalized": "EUR"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "645"
        }
      },
      "invoice": {
        "meta": {
          "included": false
        }
      },
      "budget": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/invoice_attributions/11

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": "invoice_attributions",
    "attributes": {
      "amount": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/amount"
      }
    }
  ]
}

Update an invoice attribution
PATCH/api/v2/invoice_attributions/{id}

URI Parameters
HideShow
id
number (required) Example: 1

invoice attribution id


DELETE /api/v2/invoice_attributions/1
Requestsarchives invoice attribution

DELETE  /api/v2/invoice_attributions/14

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
Responses204
This response has no content.

Deletes an invoice attribution
DELETE/api/v2/invoice_attributions/{id}

URI Parameters
HideShow
id
number (required) Example: 1

invoice attribution id


Generated by aglio on 25 Jul 2025