diff --git a/api/account-memberships/index.html b/api/account-memberships/index.html index 1a003008c..21f8711d8 100644 --- a/api/account-memberships/index.html +++ b/api/account-memberships/index.html @@ -19,7 +19,7 @@

Businesses

A Business represents a company registered with the New Zealand Companies Office. It is associated with a single Account  API .

+

Businesses

A Business represents a company registered with the New Zealand Companies Office. It is associated with a single Account  API .

Attributes

  • nzbn

    stringrequired

    The unique NZBN identifier.

  • accountId

    string

    The Centrapay accountId.

  • test

    string

    The created Centrapay org account will have the test flag.

  • taxNumber

    object

    The value-added tax configuration.

Errors

  • INVALID_ACCOUNT

    403

    Account does not exist, is not authorized, is of the wrong type, or is not in the NZ region.

  • INVALID_NZBN

    403

    The NZBN provided does not match any NZ business.

Request
POST/api/businesses
curl -X POST \
+
  • INVALID_ACCOUNT

    403

    Account does not exist, is not authorized, is of the wrong type, or is not in the NZ region.

  • INVALID_NZBN

    403

    The NZBN provided does not match any NZ business.

  • BUSINESS_ALREADY_EXISTS

    403

    The account already has a business or there is already a business with the provided NZBN.

Request
POST/api/businesses
curl -X POST \
  https://service.centrapay.com/api/businesses \
  -H 'content-type: application/json' \
  -H 'x-api-key: <TOKEN>' \
@@ -157,7 +157,7 @@
 Collapse all
 
  • taxNumber

    object

    The value-added tax configuration.

  • farmlandsBusinessNumber

    string

    The number associated with your Farmlands business.

Errors

  • INVALID_ACCOUNT

    403

    Account does not exist, is not authorized, is of the wrong type, or is not in the NZ region.

  • INVALID_NZBN

    403

    The NZBN provided does not match any NZ business.

  • BUSINESS_ALREADY_EXISTS

    403

    The account already has a business or there is already a business with the provided NZBN.

Request
PUT/api/businesses/DKTs3U38hdhfEqwF1JKoT2
curl -X PUT \
+
  • INVALID_ACCOUNT

    403

    Account does not exist, is not authorized, is of the wrong type, or is not in the NZ region.

  • INVALID_NZBN

    403

    The NZBN provided does not match any NZ business.

Request
PUT/api/businesses/DKTs3U38hdhfEqwF1JKoT2
curl -X PUT \
  https://service.centrapay.com/api/businesses/DKTs3U38hdhfEqwF1JKoT2 \
  -H 'content-type: application/json' \
  -H 'x-api-key: <TOKEN>' \
@@ -264,7 +264,9 @@
 
POST/api/businesses/{businessId}/set-onboarding-status

This endpoint returns allows you to set the onboarding status of a Business.

Attributes

Request
POST/api/businesses/DKTs3U38hdhfEqwF1JKoT2/set-onboarding-status
curl -X POST \
+

Errors

  • BUSINESS_ALREADY_EXISTS

    403

    The account already has a business or there is already a business with the provided NZBN.

Request
POST/api/businesses/DKTs3U38hdhfEqwF1JKoT2/set-onboarding-status
curl -X POST \
  https://service.centrapay.com/api/businesses/DKTs3U38hdhfEqwF1JKoT2/set-onboarding-status \
  -H 'content-type: application/json' \
  -H 'x-api-key: <TOKEN>' \
diff --git a/api/events/index.html b/api/events/index.html
index 57b3c5274..cce3d75ce 100644
--- a/api/events/index.html
+++ b/api/events/index.html
@@ -19,7 +19,7 @@