Create Billing Group | Deel. PayAndBill API Documentation

curl -X POST https://{{baseurl}}/billing-groups \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "billingGroupName": "Billing Group Name",
  "primaryEmailRecipient": "primary@example.com",
  "tradingName": "Trading Name",
  "invoiceName": "Invoice Name",
  "additionalEmailRecipient": "additional@example.com",
  "customerUuid": "123e4567-e89b-12d3-a456-426655440000",
  "phone": {
    "countryCode": "+44",
    "number": "1234567890"
  },
  "address": {
    "line1": "5221B Baker Street",
    "townCity": "London",
    "country": "England",
    "postcode": "E1 6AN"
  }
}'

{
  "uuid": "0f98c866-a458-4db5-9950-0fb996042520",
  "billingGroupName": "Default Billing Group",
  "invoiceName": "Acme Invoice",
  "tradingName": "Acme",
  "primaryEmailRecipient": "billing@acme.com",
  "additionalEmailRecipient": "string",
  "customerUuid": "45b0d09b-bc25-4b45-af21-dc15cba56ce2",
  "phone": {
    "countryCode": "+44",
    "number": "1234567890"
  },
  "address": {
    "line1": "5221B Baker Street",
    "line2": "string",
    "townCity": "London",
    "country": "England",
    "foreignCountry": "string",
    "postcode": "E1 6AN"
  }
}

Create a new billing group. When using OAuth, primaryEmailRecipient and tradingName are required.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

billingGroupNamestringRequired<=250 characters

primaryEmailRecipientstringRequiredformat: "email"<=100 characters

tradingNamestringRequired<=250 characters

invoiceNamestringOptional<=250 characters

additionalEmailRecipientstringOptionalformat: "email"<=250 characters

customerUuidstringOptionalformat: "uuid"

phoneobjectOptional

addressobjectOptional

Response

Billing group created successfully

uuidstringOptionalformat: "uuid"

billingGroupNamestringOptional

invoiceNamestringOptional

tradingNamestringOptional

primaryEmailRecipientstringOptionalformat: "email"

additionalEmailRecipientstringOptionalformat: "email"