API Docs Help

Recipient Web

/v1/entities/recipient-groups GET

GET method/v1/entities/recipient-groups

Request parameters

Responses

{ "data": [ { "id": "example", "companyId": "example", "profileName": "example", "internalNumber": "example", "name": "example", "country": "example", "synonyms": [ "example" ], "invoicesCount": 96, "recipients": [ { "id": "example", "recipientGroupId": "example", "companyId": "example", "street": "example", "city": "example", "country": "example", "zipCode": "example", "vatNumber": "example", "invoicesCount": 96, "createdAt": "example", "updatedAt": "example" } ], "createdAt": "example", "updatedAt": "example" } ], "count": 96, "total": 96, "page": 96, "pageCount": 96 }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/entities/recipient-groups POST

POST method/v1/entities/recipient-groups

Request parameters

{ "profileName": "example", "internalNumber": "example", "name": "example", "country": "example", "recipients": [ { "street": "example", "city": "example", "country": "example", "zipCode": "example", "vatNumber": "example" } ], "synonyms": [ "example" ] }

Responses

{ "id": "example", "companyId": "example", "profileName": "example", "internalNumber": "example", "name": "example", "country": "example", "synonyms": [ "example" ], "invoicesCount": 96, "recipients": [ { "id": "example", "recipientGroupId": "example", "companyId": "example", "street": "example", "city": "example", "country": "example", "zipCode": "example", "vatNumber": "example", "invoicesCount": 96, "createdAt": "example", "updatedAt": "example" } ], "createdAt": "example", "updatedAt": "example" }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/entities/recipient-groups/import POST

POST method/v1/entities/recipient-groups/import

Request parameters

{ "companyId": "example", "fileName": "example", "fileContent": "example", "csvHeaders": [ "ProfileName" ], "fieldsToUpdate": [ "ProfileName" ] }

Responses

{}
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/entities/recipient-groups/match POST

POST method/v1/entities/recipient-groups/match

Request parameters

{ "companyId": "example", "vatNumbers": [ "example" ], "name": "example", "ibans": [ "example" ], "projectNumber": "example" }

Responses

{ "recipientGroups": [ { "id": "example", "companyId": "example", "profileName": "example", "internalNumber": "example", "name": "example", "country": "example", "synonyms": [ "example" ], "invoicesCount": 96, "recipients": [ { "id": "example", "recipientGroupId": "example", "companyId": "example", "street": "example", "city": "example", "country": "example", "zipCode": "example", "vatNumber": "example", "invoicesCount": 96, "createdAt": "example", "updatedAt": "example" } ], "createdAt": "example", "updatedAt": "example" } ] }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/entities/recipient-groups/{id} GET

GET method/v1/entities/recipient-groups/{id}

Request parameters

Responses

{ "id": "example", "companyId": "example", "profileName": "example", "internalNumber": "example", "name": "example", "country": "example", "synonyms": [ "example" ], "invoicesCount": 96, "recipients": [ { "id": "example", "recipientGroupId": "example", "companyId": "example", "street": "example", "city": "example", "country": "example", "zipCode": "example", "vatNumber": "example", "invoicesCount": 96, "createdAt": "example", "updatedAt": "example" } ], "createdAt": "example", "updatedAt": "example" }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/entities/recipient-groups/{id} PUT

PUT method/v1/entities/recipient-groups/{id}

Request parameters

{ "companyId": "example", "profileName": "example", "internalNumber": "example", "name": "example", "country": "example", "synonyms": [ "example" ], "invoicesCount": 96, "recipients": [ { "id": "example", "recipientGroupId": "example", "companyId": "example", "street": "example", "city": "example", "country": "example", "zipCode": "example", "vatNumber": "example", "invoicesCount": 96, "createdAt": "example", "updatedAt": "example" } ], "createdAt": "example", "updatedAt": "example" }

Responses

{ "id": "example", "companyId": "example", "profileName": "example", "internalNumber": "example", "name": "example", "country": "example", "synonyms": [ "example" ], "invoicesCount": 96, "recipients": [ { "id": "example", "recipientGroupId": "example", "companyId": "example", "street": "example", "city": "example", "country": "example", "zipCode": "example", "vatNumber": "example", "invoicesCount": 96, "createdAt": "example", "updatedAt": "example" } ], "createdAt": "example", "updatedAt": "example" }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/entities/recipient-groups/{id} DELETE

DELETE method/v1/entities/recipient-groups/{id}

Request parameters

Responses

{}
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/entities/recipient-groups/{recipientGroupId} PATCH

PATCH method/v1/entities/recipient-groups/{recipientGroupId}

Request parameters

{ "recipientId": "example", "operation": "AddSynonym", "payload": "example" }

Responses

{ "id": "example", "companyId": "example", "profileName": "example", "internalNumber": "example", "name": "example", "country": "example", "synonyms": [ "example" ], "invoicesCount": 96, "recipients": [ { "id": "example", "recipientGroupId": "example", "companyId": "example", "street": "example", "city": "example", "country": "example", "zipCode": "example", "vatNumber": "example", "invoicesCount": 96, "createdAt": "example", "updatedAt": "example" } ], "createdAt": "example", "updatedAt": "example" }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/entities/recipient-groups/{recipientGroupId}/recipients POST

POST method/v1/entities/recipient-groups/{recipientGroupId}/recipients

Request parameters

{ "street": "example", "city": "example", "country": "example", "zipCode": "example", "vatNumber": "example" }

Responses

{ "id": "example", "recipientGroupId": "example", "companyId": "example", "street": "example", "city": "example", "country": "example", "zipCode": "example", "vatNumber": "example", "invoicesCount": 96, "createdAt": "example", "updatedAt": "example" }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/entities/recipient-groups/{recipientGroupId}/recipients/{id} PUT

PUT method/v1/entities/recipient-groups/{recipientGroupId}/recipients/{id}

Request parameters

{ "companyId": "example", "street": "example", "city": "example", "country": "example", "zipCode": "example", "vatNumber": "example", "invoicesCount": 96, "createdAt": "example", "updatedAt": "example" }

Responses

{ "id": "example", "recipientGroupId": "example", "companyId": "example", "street": "example", "city": "example", "country": "example", "zipCode": "example", "vatNumber": "example", "invoicesCount": 96, "createdAt": "example", "updatedAt": "example" }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/entities/recipient-groups/{recipientGroupId}/recipients/{recipientId} GET

GET method/v1/entities/recipient-groups/{recipientGroupId}/recipients/{recipientId}

Request parameters

Responses

{ "id": "example", "recipientGroupId": "example", "companyId": "example", "street": "example", "city": "example", "country": "example", "zipCode": "example", "vatNumber": "example", "invoicesCount": 96, "createdAt": "example", "updatedAt": "example" }
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }

/v1/entities/recipient-groups/{recipientGroupId}/recipients/{recipientId} DELETE

DELETE method/v1/entities/recipient-groups/{recipientGroupId}/recipients/{recipientId}

Request parameters

Responses

{}
{ "code": 96, "message": "example", "details": [ { "@type": "example" } ] }
Last modified: 20 October 2024
Recipient InternalVendor