Open Budget API Documentation

Usage Overview

This API is compliant with the JSON API specification, which defines conventions for listing, reading, creating, updating, and deleting resources. When fetching a resource or resources, the spec also offers conventions for: sorting the returned resources, limiting the fields returned in each resource, including related resources to form compound documents, etc. Accordingly, these features of the Open Budget API aren’t redocumented here; simply see the JSON API spec to learn how to use them.

Unsupported JSON API features

This implementation of JSON API does not allow clients to set a resource’s id; any attempt to do so will be silently ignored, with the server-generated id being used instead.

Resource Types

Card

Address and contact information for a company, person, organization. It tries to mimick the format available at http://microformats.org/wiki/h-card

Fields

Field NameTypeDescription
idId
Default Value
(auto generated)
categoryString
Allowed Values
business, person
nameString
givenNameString
additionalNameString
familyNameString
nicknameString
emailString
String
photoString
urlString
extendedAddressString
streetAddressString
localityString
regionString
postalCodeString
countryCodeString
geoLatitudeString
geoLongitudeString
telephoneString
notesString
birthdayDate
publicKeyString
organizationString
roleString
ibanStringIBAN is needed in case of a card attached to an organization!
bicStringIBAN is usually enough, unless we deal with non-Euro currencies (and non-SEPA IBANs)
currencyString
Allowed Values
EUR, GBP
Default Value
EUR
aliasesArray[undefined]e.g. payment references to match when uploading bulk transactions
updatedAtDate
createdAtDate

Organization

Organization

Fields

Field NameTypeDescription
idId
Default Value
(auto generated)
nameString
aliasString
parentOrganizationId
Default Value
[object Object]
cardCardId
Default Value
[object Object]
peopleArray[undefined]
feeAsGatewayNumberPercent value. 1 === 0.01%, 100 === 1%
updatedAtDate
createdAtDate

Transaction

Transaction

Fields

Field NameTypeDescription
idId
Default Value
(auto generated)
typeTransactionTypeId
Default Value
[object Object]
fromCardId
Default Value
[object Object]
gatewayOrganizationId
Default Value
[object Object]
toCardId
Default Value
[object Object]
grossNumber
vatNumber
gatewayFeeNumber
netNumber
statusString
Allowed Values
pending, processed
sourceString
Allowed Values
manual, csv, data_sync
Default Value
manual
originalTransactionTransactionIdIn case this transaction originates from another recorded transaction (e.g.: refund), please use this field
Default Value
[object Object]
invoiceStringLink to a third-party invoice, if any
externalReferenceStringReference ID to a third-party system
updatedAtDate
createdAtDate

TransactionType

Transaction types and related VAT rates

Fields

Field NameTypeDescription
idId
Default Value
(auto generated)
typeString
Allowed Values
taxes, ticket, donation, ads, sponsorship, refund, online_service, physical_service, physical_good
valueNumberPercent value. 1 === 0.01%, 100 === 1%
noteStringNote added to invoices using this transaction type
fromCountryString
toCountryString
updatedAtDate
createdAtDate