Self invoices

Supported Formats

json
>>>

DELETE /api/self_invoices/:id
Delete self invoice

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Invoice Id Not Found
422 Unprocessable Entity.

Params

Param name Description
id
required

Invoice Id

Validations:

  • Must be a String
>>>

POST /api/self_invoices/mass_delete
This does mass payment

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Params

Param name Description
invoice_ids
required

Invoice Ids

Validations:

  • Must be an array of any type
>>>

POST /api/self_invoices/:id/pay
Pays an invoice and returns Offline Payment

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Invoice Id Not Found
422 Unprocessable Entity

Params

Param name Description
notes
optional

Payment Notes

Validations:

  • Must be a String
>>>

GET /api/self_invoices/summary
Returns invoice summaries

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
begin_date
optional

Begin date

Validations:

  • Must be a Date
end_date
optional

End date (inclusive)

Validations:

  • Must be a Date
country_scope
optional

Validations:

  • Must be one of: eu, non-eu, nl.
payment_state
optional

Validations:

  • Must be one of: paid, cancelled, failed, processing, pending.
>>>

GET /api/self_invoices/zip_summary
Returns 202 status code

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
begin_date
optional

Begin date

Validations:

  • Must be a Date
end_date
optional

End date (inclusive)

Validations:

  • Must be a Date
country_scope
optional

Validations:

  • Must be one of: eu, non-eu, nl.
>>>

GET /api/users/:user_id/self_invoices
List user invoices

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 User Not Found

Params

Param name Description
user_id
required

User Id

Validations:

  • Must be a String
>>>

POST /api/users/:user_id/self_invoices
Creates Invoice

There are 4 kinds of error messages for now. Those messages comes under base attribute in JSON. Those errors are: invoice_profile_needs_to_be_created, invoice_profile_has_required_fields dutch_citizen_cannot_create_invoice, transaction_not_found

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 User Not Found
422 Unprocessable Entity

Params

Param name Description
user_id
required

User Id

Validations:

  • Must be a String
from_accountant
optional

Tells that if user is accountant or not.

Validations:

  • Must be one of: 0, 1.
>>>

GET /api/users/:user_id/self_invoices/:id
Returns invoice detail

Supported Formats

pdf, json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 User Id Not Found
404 Invoice Id Not Found

Params

Param name Description
user_id
required

User id

Validations:

  • Must be a String
id
required

Invoice Id

Validations:

  • Must be a String