Skip to content
campai
Book a consultationTry for free
GET/{organizationId}/finance/settings

Get finances settings

Returns the finances settings of a given organization

Required permissions:

  • financesSettings.read

Path Parameters

organizationIdstringrequired

Query Parameters

modifiedBeforedate-timeoptional
modifiedAfterdate-timeoptional

Authentication: X-API-Key

Request

GET/{organizationId}/finance/settings
curl --request GET 'https://cloud.campai.com/api/{organizationId}/finance/settings' \
  --header 'X-API-Key: YOUR_API_KEY'

Responses

This endpoint returns different response codes based on the request outcome.

200Successful response

Content-Type: application/json

Additional properties are not allowed.

fiscalMonthStartintegerrequired

minimum: 1

maximum: 12

vatDueMethodstringrequired

Options:

receiptpayment
accountingModestringrequired

Options:

fullexportnone

Additional properties are not allowed.

Additional properties are not allowed.

Additional properties are not allowed.

receiptNumberScopestringrequired

Options:

globallocal
taxOfficeNamestringrequired

maxLength: 40

donationEnabledbooleanoptional
donationMembershipFeesbooleanrequired
reversePostingsOnCancelationbooleanrequired
taxIDstringrequired

Response

200
{
  "vatID": "",
  "datev": {
    "advisorNumber": "",
    "mandateNumber": ""
  },
  "fiscalMonthStart": 1,
  "vatDueMethod": "receipt",
  "accountingMode": "full",
  "reminders": {
    "automaticRemindersEnabledAt": "string",
    "level1": {
      "enabled": true,
      "daysOverdue": 1,
      "fee": 0,
      "messages": {
        "general": {
          "title": "string",
          "intro": "string",
          "note": "string",
          "subject": "string",
          "message": "string"
        },
        "invoice": {
          "title": "string",
          "intro": "string",
          "note": "string",
          "subject": "string",
          "message": "string"
        },
        "invoiceMembershipFee": {
          "title": "string",
          "intro": "string",
          "note": "string",
          "subject": "string",
          "message": "string"
        },
        "invoiceBooking": {
          "title": "string",
          "intro": "string",
          "note": "string",
          "subject": "string",
          "message": "string"
        }
      }
    },
    "level2": {
      "enabled": true,
      "daysOverdue": 1,
      "fee": 0,
      "messages": {
        "general": {
          "title": "string",
          "intro": "string",
          "note": "string",
          "subject": "string",
          "message": "string"
        },
        "invoice": {
          "title": "string",
          "intro": "string",
          "note": "string",
          "subject": "string",
          "message": "string"
        },
        "invoiceMembershipFee": {
          "title": "string",
          "intro": "string",
          "note": "string",
          "subject": "string",
          "message": "string"
        },
        "invoiceBooking": {
          "title": "string",
          "intro": "string",
          "note": "string",
          "subject": "string",
          "message": "string"
        }
      }
    },
    "level3": {
      "enabled": true,
      "daysOverdue": 1,
      "fee": 0,
      "messages": {
        "general": {
          "title": "string",
          "intro": "string",
          "note": "string",
          "subject": "string",
          "message": "string"
        },
        "invoice": {
          "title": "string",
          "intro": "string",
          "note": "string",
          "subject": "string",
          "message": "string"
        },
        "invoiceMembershipFee": {
          "title": "string",
          "intro": "string",
          "note": "string",
          "subject": "string",
          "message": "string"
        },
        "invoiceBooking": {
          "title": "string",
          "intro": "string",
          "note": "string",
          "subject": "string",
          "message": "string"
        }
      }
    },
    "level4": {
      "enabled": true,
      "daysOverdue": 1,
      "fee": 0,
      "messages": {
        "general": {
          "title": "string",
          "intro": "string",
          "note": "string",
          "subject": "string",
          "message": "string"
        },
        "invoice": {
          "title": "string",
          "intro": "string",
          "note": "string",
          "subject": "string",
          "message": "string"
        },
        "invoiceMembershipFee": {
          "title": "string",
          "intro": "string",
          "note": "string",
          "subject": "string",
          "message": "string"
        },
        "invoiceBooking": {
          "title": "string",
          "intro": "string",
          "note": "string",
          "subject": "string",
          "message": "string"
        }
      }
    },
    "donationReminders": {
      "automaticRemindersEnabledAt": "string",
      "level1": {
        "enabled": true,
        "daysOverdue": 1,
        "fee": 0,
        "messages": {
          "general": {
            "title": "string",
            "intro": "string",
            "note": "string",
            "subject": "string",
            "message": "string"
          }
        }
      },
      "level2": {
        "enabled": true,
        "daysOverdue": 1,
        "fee": 0,
        "messages": {
          "general": {
            "title": "string",
            "intro": "string",
            "note": "string",
            "subject": "string",
            "message": "string"
          }
        }
      },
      "level3": {
        "enabled": true,
        "daysOverdue": 1,
        "fee": 0,
        "messages": {
          "general": {
            "title": "string",
            "intro": "string",
            "note": "string",
            "subject": "string",
            "message": "string"
          }
        }
      },
      "level4": {
        "enabled": true,
        "daysOverdue": 1,
        "fee": 0,
        "messages": {
          "general": {
            "title": "string",
            "intro": "string",
            "note": "string",
            "subject": "string",
            "message": "string"
          }
        }
      }
    }
  },
  "returnedPaymentNotification": {
    "retry": {
      "title": "string",
      "intro": "string",
      "note": "string",
      "subject": "string",
      "message": "string"
    },
    "manual": {
      "title": "string",
      "intro": "string",
      "note": "string",
      "subject": "string",
      "message": "string"
    }
  },
  "paymentMethods": {
    "sepaCreditTransfer": {
      "paymentTerms": "string"
    },
    "sepaDirectDebit": {
      "paymentTerms": "string",
      "creditorIdentifier": "string",
      "minLeadTimeDays": 0,
      "maxLeadTimeDays": 0,
      "b2b": true
    },
    "online": {
      "paymentTerms": "string"
    },
    "cash": {
      "paymentTerms": "string"
    }
  },
  "receiptNumberFormats": {},
  "receiptNumberScope": "global",
  "taxOfficeName": "string",
  "donationMembershipFees": true,
  "reversePostingsOnCancelation": true,
  "taxID": "string"
}

400Invalid input data

Content-Type: application/json

The error information

messagestringrequired

The error message

codestringrequired

The error code

An array of issues that were responsible for the error

Response

400
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

401Authorization not provided

Content-Type: application/json

The error information

messagestringrequired

The error message

codestringrequired

The error code

An array of issues that were responsible for the error

Response

401
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

403Insufficient access

Content-Type: application/json

The error information

messagestringrequired

The error message

codestringrequired

The error code

An array of issues that were responsible for the error

Response

403
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

404Not found

Content-Type: application/json

The error information

messagestringrequired

The error message

codestringrequired

The error code

An array of issues that were responsible for the error

Response

404
{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

500Internal server error

Content-Type: application/json

The error information

messagestringrequired

The error message

codestringrequired

The error code

An array of issues that were responsible for the error

Response

500
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}