public

Créer une activité

POST

/v1/activities

Créer une activité

curl --request POST \
  --url '/v1/activities' \
  --header 'Authorization: Bearer <token>' \
  --header 'idempotency-key: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "activityDate": "<string>",
  "authorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "billable": true,
  "billed": true,
  "category": "temps",
  "description": "<string>",
  "matterId": "<string>",
  "quantity": 123,
  "stakeholderId": "<string>",
  "status": "confirmed",
  "title": null,
  "unitCost": 123,
  "vatRate": 123,
  "workedQuantity": 123
}
'

{
  "activityDate": "<string>",
  "amountHt": 123,
  "authorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "billable": true,
  "billed": true,
  "category": "temps",
  "createdAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "discountKind": "percent",
  "discountValue": 123,
  "id": "<string>",
  "invoiceId": "<string>",
  "invoiceLabel": "<string>",
  "matterId": "<string>",
  "quantity": 123,
  "stakeholderId": "<string>",
  "status": "confirmed",
  "tenantId": "<string>",
  "title": "<string>",
  "unitCost": 123,
  "updatedAt": "2023-11-07T05:31:56Z",
  "vatRate": 123,
  "workedQuantity": 123
}

Autorisations

Authorizationstringheaderobligatoire

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

Clé de reprise choisie par le client (8 à 255 caractères). Quand elle est fournie, une reprise portant la même clé et la même charge ne crée rien : elle rend la ressource déjà créée, relue au moment de la reprise. La même clé sur une charge différente est refusée.

Corps

activityDatestring | nullobligatoire

authorIdstring | nullobligatoire

billablebooleanobligatoire

billedbooleanobligatoire

categoryenum<string>obligatoire

Options disponibles: temps, frais, prestation, debours

descriptionstring | nullobligatoire

matterIdstring | nullobligatoire

Motif: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

quantitynumber | nullobligatoire

Plage requise: 0 <= x

stakeholderIdstring | nullobligatoire

Motif: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

statusenum<string>default:confirmed

Options disponibles: draft, confirmed

titlestring | nulldefault:null

unitCostnumber | nullobligatoire

Plage requise: 0 <= x

vatRatenumber | nullobligatoire

Plage requise: 0 <= x <= 1

workedQuantitynumber | nullobligatoire

Réponse

activityDatestring | nullobligatoire

amountHtnumber | nullobligatoire

authorIdstring | nullobligatoire

billablebooleanobligatoire

billedbooleanobligatoire

categoryenum<string>obligatoire

Options disponibles: temps, frais, prestation, debours

createdAtstringobligatoire

deletedAtstring | nullobligatoire

descriptionstring | nullobligatoire

discountKindenum<string> | nullobligatoire

Options disponibles: percent, amount

discountValuenumber | nullobligatoire

idstringobligatoire

Motif: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

invoiceIdstring | nullobligatoire

Motif: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

invoiceLabelstring | nullobligatoire

matterIdstring | nullobligatoire

Motif: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

quantitynumber | nullobligatoire

stakeholderIdstring | nullobligatoire

Motif: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

statusenum<string>default:confirmed

Options disponibles: draft, confirmed

tenantIdstringobligatoire

Motif: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

titlestring | nullobligatoire

unitCostnumber | nullobligatoire

updatedAtstringobligatoire

vatRatenumber | nullobligatoire

Plage requise: 0 <= x <= 1

workedQuantitynumber | nullobligatoire

Besoin d'aide supplémentaire ? Demander à l'équipe

Autorisations

En-têtes

Corps

Réponse