project_payment_schedules.md

Project Payment Schedules

German: "Projekte / Geplante Abrechnungen"

• Attributes
• GET /projects/payment_schedules
• GET /projects/{project_id}/payment_schedules
• GET /projects/{project_id}/payment_schedules/{id}
• POST /projects/{project_id}/payment_schedules
• PUT /projects/{project_id}/payment_schedules/{id}
• DELETE /projects/{project_id}/payment_schedules/{id}

Attributes

Payment schedules for fixed price projects.

{
  "id": 760153573,
  "date": "2017-04-05",
  "title": "Erste Anzahlung",
  "net_total": 1000,
  "project": {
    "id": 822322322,
    "identifier": "P0077",
    "name": "New website"
  },
  "checked": false,
  "billed": false,
  "created_at": "2018-10-17T09:33:46Z",
  "updated_at": "2018-10-17T09:33:46Z"
}

GET /projects/payment_schedules

Retrieve all payment schedules independent of a project:

curl -X GET \
  'https://{domain}.mocoapp.com/api/v1/projects/payment_schedules' \
  -H 'Authorization: Token token=YOUR_API_KEY'

Additionally, these parameters can be supplied:

• from – "2021-02-01"
• to – "2021-02-28"
• checked – true / false (show checked off payment schedules or unchecked schedules)
• company_id - 1234
• project_id - 1234 (There's also /projects/{id}/payment_schedules)

GET /projects/{project_id}/payment_schedules

Retrieve all payment schedules for the project:

curl -X GET \
  'https://{domain}.mocoapp.com/api/v1/projects/{project_id}/payment_schedules' \
  -H 'Authorization: Token token=YOUR_API_KEY'

Additionally, these parameters can be supplied:

• from – "2021-02-01"
• to – "2021-02-28"
• checked – true / false (show checked off payment schedules or unchecked schedules)

GET /projects/{project_id}/payment_schedules/{id}

Retrieve a single payment schedule on a project:

curl -X GET \
  'https://{domain}.mocoapp.com/api/v1/projects/{project_id}/payment_schedules/{id}' \
  -H 'Authorization: Token token=YOUR_API_KEY'

POST /projects/{project_id}/payment_schedules

Create a paymennt schedule for the project:

curl -X POST \
  'https://{domain}.mocoapp.com/api/v1/projects/{project_id}/payment_schedules' \
  -H 'Authorization: Token token=YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
     	"net_total": 1800,
     	"title": "Erste Anzahlung",
	    "date": "2019-10-28"
      }'

Mandatory fields are marked with a star (*):

• net_total* – 12000
• date* – "2019-10-28"
• title – "Erste Anzahlung"
• checked – true/false

PUT /projects/{project_id}/payment_schedules/{id}

Update a payment schedule for a project:

curl -X PUT \
  'https://{domain}.mocoapp.com/api/v1/projects/{project_id}/payment_schedules/{id}' \
  -H 'Authorization: Token token=YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
        "checked": true
      }'

Fields are analogous to the POST request.

DELETE /projects/{project_id}/payment_schedules/{id}

⚠ Delete the payment schedule.

curl -X DELETE \
  'https://{domain}.mocoapp.com/api/v1/projects/{project_id}/payment_schedules/{id}' \
  -H 'Authorization: Token token=YOUR_API_KEY'