Sign in
organization

Changed on
post/organization

Request

  • Base URL: https://api.abby.fr
  • URL: https://api.abby.fr/organization
  • Auth: HTTP bearer

Request body

namestring required

The official name of the organization

commercialNamestring

The commercial or trading name of the organization

emailsstring[]
siretstring

The SIRET number (required for French organizations)

vatNumberstring

The VAT number of the organization

notesstring

Additional notes about the organization

Example request

{
  "name": "Acme Corporation",
  "commercialName": "Acme Corp",
  "siret": "12345678901234",
  "vatNumber": "FR12345678901",
  "billingAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY"
  },
  "deliveryAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY"
  },
  "notes": "Preferred supplier for anvils and TNT",
  "bankInformations": {
    "iban": "DE89370400440532013000",
    "bic": "DEUTDEFF",
    "holder": "John Doe"
  },
  "preferences": {
    "paymentMethods": [
      "cheque",
      "stripe"
    ]
  }
}

Response

language'fr' | 'en' | 'de' | 'it' | 'nl' | 'pt' | 'es'
currency'EUR' | 'GBP' | 'CHF' | 'USD' | 'AUD' | 'CAD' | 'JPY' | 'CNH' | 'CZK' | 'DKK' | 'BGN' | 'PLN' | 'HUF' | 'RON' | 'SEK' | 'NOK' | 'TRY' | 'BRL' | 'HKD' | 'ILS' | 'INR' | 'KRW' | 'MXN' | 'XPF' | 'XOF' | 'XAF'

Preferred currency of the customer

paymentMethodsPaymentMethod[]

The client's preferred payment methods

idstring required
namestring required
commercialNamestring required
emailsstring[] required
siretstring required
vatNumberstring required
countContactsnumber required
notesstring required
createdAtnumber required

Contact creation timestamp

archivedAtnumber required

Contact archival timestamp

hasBillingsboolean required
testboolean required

Example response

{
  "paymentMethods": [
    "cheque",
    "stripe"
  ],
  "billingAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY"
  },
  "deliveryAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY"
  },
  "bankInformations": {
    "iban": "DE89370400440532013000",
    "bic": "DEUTDEFF",
    "holder": "John Doe"
  },
  "createdAt": 1617187200,
  "archivedAt": 1617187200
}

Changes

  • bb3dad0e053fRevision changes
    • breaking

      request property ////// was restricted to a list of enum values

    • warning

      added the new XAF enum value to the //// response property for the response status

    • warning

      added the new XOF enum value to the //// response property for the response status

    • warning

      added the new XPF enum value to the //// response property for the response status

    • warning

      added the new cash enum value to the / response property for the response status

    • warning

      added the new cheque enum value to the / response property for the response status

    • warning

      added the new credit_card enum value to the / response property for the response status

    • warning

      added the new direct_debit enum value to the / response property for the response status

    • warning

      added the new other enum value to the / response property for the response status

    • warning

      added the new paypal enum value to the / response property for the response status

    • warning

      added the new stripe enum value to the / response property for the response status

    • warning

      added the new transfer enum value to the / response property for the response status

    • warning

      added the new universal_employment_service_cheque enum value to the / response property for the response status

    • info

      api operation id OrganizationController-createOrganization removed and replaced with OrganizationController_createOrganization

    • info

      added the new XAF enum value to the request property /////////

    • info

      added the new XOF enum value to the request property /////////

    • info

      added the new XPF enum value to the request property /////////

    • info

      added the new cash enum value to the request property //////

    • info

      added the new cheque enum value to the request property //////

    • info

      added the new credit_card enum value to the request property //////

    • info

      added the new direct_debit enum value to the request property //////

    • info

      added the new other enum value to the request property //////

    • info

      added the new paypal enum value to the request property //////

    • info

      added the new stripe enum value to the request property //////

    • info

      added the new transfer enum value to the request property //////

    • info

      added the new universal_employment_service_cheque enum value to the request property //////

    This list may be incomplete.