Products

List all products of an administration

GET /products(.:format)

Returns a paginated list of products in the administration. Each page contains 10 products. You can use the page parameter to fetch the next page of products.

Parameters

Parameter	Type	Description
`query`	`String`	Allows filtering by product name.
`page`	`Integer`	The page to fetch, starting at 1.
`currency`	`String`	ISO three-character currency code, e.g. EUR or USD.

Example: returns a list of products

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/products.json?
    
    

Response

        
          
          Status: 200 OK

      [
  {
    "id": "303632953743771008",
    "administration_id": 123,
    "description": "My product description",
    "price": "100.0",
    "currency": "EUR",
    "frequency": null,
    "frequency_type": null,
    "tax_rate_id": "303632814934328427",
    "ledger_account_id": "303632814802207831",
    "created_at": "2020-10-27T08:22:51.315Z",
    "updated_at": "2020-10-27T08:22:51.315Z"
  }
]

Example: allows filtering by query

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/products.json?query=My+product+description
    
    

Response

        
          
          Status: 200 OK

      [
  {
    "id": "303632955797931393",
    "administration_id": 123,
    "description": "My product description",
    "price": "100.0",
    "currency": "EUR",
    "frequency": null,
    "frequency_type": null,
    "tax_rate_id": "303632814934328427",
    "ledger_account_id": "303632814802207831",
    "created_at": "2020-10-27T08:22:53.271Z",
    "updated_at": "2020-10-27T08:22:53.271Z"
  }
]

Example: handles empty search result

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/products.json?query=kjashdfjksadhfjk
    
    

Response

        
          
          Status: 200 OK

      [

]

Returns information about a product

GET /products/:id(.:format)

Example: returns a single product

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/products/303632957937026435.json?
    
    

Response

        
          
          Status: 200 OK

      {
  "id": "303632957937026435",
  "administration_id": 123,
  "description": "My product description",
  "price": "100.0",
  "currency": "EUR",
  "frequency": null,
  "frequency_type": null,
  "tax_rate_id": "303632814934328427",
  "ledger_account_id": "303632814802207831",
  "created_at": "2020-10-27T08:22:55.310Z",
  "updated_at": "2020-10-27T08:22:55.310Z"
}

Example: returns 404 when product does not exist

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/products/34123123.json?
    
    

Response

        
          
          Status: 404 Not Found

      {
  "error": "record not found",
  "symbolic": {
    "id": "not_found"
  }
}

Creates a new product

POST /products(.:format)

Parameters

Parameter	Type	Description
`product[description]`	`String`	Required
`product[price]`	`Decimal`	Required Both a decimal and a string ‘10,95’ are accepted.
`product[tax_rate_id]`	`Integer`	Required Should be a valid tax rate id.
`product[ledger_account_id]`	`Integer`	Required Should be a valid ledger account id.
`product[currency]`	`String`	Required ISO three-character currency code, e.g. EUR or USD.
`product[frequency_type]`	`String`	Can be `day`, `week`, `month`, `quarter` or `year`.
`product[frequency]`	`Integer`	Should be an integer >= 1.
`product[frequency_preset]`	`String`

Example: creates a new product

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"product":{"description":"Geldvogel","price":"50,50","tax_rate_id":303632958189733255,"ledger_account_id":303632958211753353}}' \
  https://moneybird.com/api/v2/123/products.json
    
    

Response

        
          
          Status: 201 Created

      {
  "id": "303632958289347979",
  "administration_id": 123,
  "description": "Geldvogel",
  "price": "50.5",
  "currency": "EUR",
  "frequency": null,
  "frequency_type": null,
  "tax_rate_id": "303632958189733255",
  "ledger_account_id": "303632958211753353",
  "created_at": "2020-10-27T08:22:55.645Z",
  "updated_at": "2020-10-27T08:22:55.645Z"
}

Example: returns an error when information is missing

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"product":{"description":"","price":"","tax_rate_id":303632958363796878,"ledger_account_id":303632958385816976}}' \
  https://moneybird.com/api/v2/123/products.json
    
    

Response

        
          
          Status: 422 Unprocessable Entity

      {
  "error": {
    "description": [
      "cannot be empty"
    ],
    "price": [
      "cannot be empty"
    ]
  }
}

Updates a product

PATCH /products/:id(.:format)

Parameters

Parameter	Type	Description
`product[description]`	`String`
`product[price]`	`Decimal`	Both a decimal and a string ‘10,95’ are accepted.
`product[tax_rate_id]`	`Integer`	Should be a valid tax rate id.
`product[ledger_account_id]`	`Integer`	Should be a valid ledger account id.
`product[currency]`	`String`	ISO three-character currency code, e.g. EUR or USD.
`product[frequency_type]`	`String`	Can be `day`, `week`, `month`, `quarter` or `year`.
`product[frequency]`	`Integer`	Should be an integer >= 1.
`product[frequency_preset]`	`String`

Example: updates a contact

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"product":{"description":"Updated","price":"123"}}' \
  https://moneybird.com/api/v2/123/products/303632958526326162.json
    
    

Response

        
          
          Status: 200 OK

      {
  "id": "303632958526326162",
  "administration_id": 123,
  "description": "Updated",
  "price": "123.0",
  "currency": "EUR",
  "frequency": null,
  "frequency_type": null,
  "tax_rate_id": "303632814934328427",
  "ledger_account_id": "303632814802207831",
  "created_at": "2020-10-27T08:22:55.870Z",
  "updated_at": "2020-10-27T08:22:55.936Z"
}

Deletes a product

DELETE /products/:id(.:format)

Example: deletes a product

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XDELETE \
  -d '{}' \
  https://moneybird.com/api/v2/123/products/303632958658446739.json
    
    

Response

        
          
          Status: 204 No Content