Invoice profiles

Supported Formats

json
>>>

PUT /api/invoice_profiles/:user_id
Updates a user profile.

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
invoice_profile
required

Invoice Profile parameter container

Validations:

  • Must be a Hash
invoice_profile[profile_type]
optional

INDIVIDUAL/BUSINESS

Validations:

  • Must be a String
invoice_profile[address_line_1]
optional

…

Validations:

  • Must be a String
invoice_profile[address_line_2]
optional

…

Validations:

  • Must be a String
invoice_profile[business_contact_role]
optional

DIRECTOR/OWNER/OTHER

Validations:

  • Must be a String
invoice_profile[business_name]
optional

…

Validations:

  • Must be a String
invoice_profile[business_registration_country]
optional

2 letter ISO 3166-1 country code

Validations:

  • Must be a String
invoice_profile[business_registration_id]
optional

…

Validations:

  • Must be a String
invoice_profile[business_registration_state_province]
optional

…

Validations:

  • Must be a String
invoice_profile[business_type]
optional

…

Validations:

  • Must be a String
invoice_profile[city]
optional

…

Validations:

  • Must be a String
invoice_profile[country]
optional

2 letter ISO 3166-1 country code

Validations:

  • Must be a String
invoice_profile[country_of_birth]
optional

2 letter ISO 3166-1 country code

Validations:

  • Must be a String
invoice_profile[date_of_birth]
optional

…

Validations:

  • Must be a String
invoice_profile[driver_licence_id]
optional

…

Validations:

  • Must be a String
invoice_profile[email]
optional

…

Validations:

  • Must be a String
invoice_profile[employer_id]
optional

…

Validations:

  • Must be a String
invoice_profile[first_name]
optional

…

Validations:

  • Must be a String
invoice_profile[gender]
optional

MALE/FEMALE

Validations:

  • Must be a String
invoice_profile[government_id]
optional

…

Validations:

  • Must be a String
invoice_profile[language]
optional

2 letter ISO 639-1 language code

Validations:

  • Must be a String
invoice_profile[last_name]
optional

…

Validations:

  • Must be a String
invoice_profile[middle_name]
optional

…

Validations:

  • Must be a String
invoice_profile[mobile_number]
optional

…

Validations:

  • Must be a String
invoice_profile[passport_id]
optional

…

Validations:

  • Must be a String
invoice_profile[phone_number]
optional

…

Validations:

  • Must be a String
invoice_profile[postal_code]
optional

…

Validations:

  • Must be a String
invoice_profile[state_province]
optional

…

Validations:

  • Must be a String
invoice_profile[tax_id]
optional

…

Validations:

  • Must be a String
>>>

GET /api/invoice_profiles/:user_id
Returns invoice profile.

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
>>>

GET /api/invoice_profiles/required_fields
Returns required fields.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
country
optional

Country Code

Validations:

  • Must be a String
profile_type
optional

Profile Type

Validations:

  • Must be a String