API Docs Help

Vendor Web

/v1/entities/vendors GET

GET method/v1/entities/vendors

Request parameters

Responses

{ "data": [ { "id": "example", "companyId": "example", "profileName": "example", "internalNumber": "example", "recipientGroupId": "example", "name": "example", "street": "example", "city": "example", "country": "example", "zipCode": "example", "currency": "example", "kvk": "example", "invoicesCount": 96, "vatNumbers": [ "example" ], "taxNumbers": [ "example" ], "ibans": [ "example" ], "createdAt": "example", "updatedAt": "example", "recipientGroup": { "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/vendors POST

POST method/v1/entities/vendors

Request parameters

{ "profileName": "example", "internalNumber": "example", "recipientGroupId": "example", "name": "example", "street": "example", "city": "example", "country": "example", "zipCode": "example", "currency": "example", "kvk": "example", "vatNumbers": [ "example" ], "taxNumbers": [ "example" ], "ibans": [ "example" ] }

Responses

{ "id": "example", "companyId": "example", "profileName": "example", "internalNumber": "example", "recipientGroupId": "example", "name": "example", "street": "example", "city": "example", "country": "example", "zipCode": "example", "currency": "example", "kvk": "example", "invoicesCount": 96, "vatNumbers": [ "example" ], "taxNumbers": [ "example" ], "ibans": [ "example" ], "createdAt": "example", "updatedAt": "example", "recipientGroup": { "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/vendors/import POST

POST method/v1/entities/vendors/import

Request parameters

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

Responses

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

/v1/entities/vendors/match POST

POST method/v1/entities/vendors/match

Request parameters

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

Responses

{ "vendors": [ { "id": "example", "companyId": "example", "profileName": "example", "internalNumber": "example", "recipientGroupId": "example", "name": "example", "street": "example", "city": "example", "country": "example", "zipCode": "example", "currency": "example", "kvk": "example", "invoicesCount": 96, "vatNumbers": [ "example" ], "taxNumbers": [ "example" ], "ibans": [ "example" ], "createdAt": "example", "updatedAt": "example", "recipientGroup": { "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/vendors/{id} GET

GET method/v1/entities/vendors/{id}

Request parameters

Responses

{ "id": "example", "companyId": "example", "profileName": "example", "internalNumber": "example", "recipientGroupId": "example", "name": "example", "street": "example", "city": "example", "country": "example", "zipCode": "example", "currency": "example", "kvk": "example", "invoicesCount": 96, "vatNumbers": [ "example" ], "taxNumbers": [ "example" ], "ibans": [ "example" ], "createdAt": "example", "updatedAt": "example", "recipientGroup": { "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/vendors/{id} PUT

PUT method/v1/entities/vendors/{id}

Request parameters

{ "companyId": "example", "profileName": "example", "internalNumber": "example", "recipientGroupId": "example", "name": "example", "street": "example", "city": "example", "country": "example", "zipCode": "example", "currency": "example", "kvk": "example", "invoicesCount": 96, "vatNumbers": [ "example" ], "taxNumbers": [ "example" ], "ibans": [ "example" ], "createdAt": "example", "updatedAt": "example", "recipientGroup": { "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" } }

Responses

{ "id": "example", "companyId": "example", "profileName": "example", "internalNumber": "example", "recipientGroupId": "example", "name": "example", "street": "example", "city": "example", "country": "example", "zipCode": "example", "currency": "example", "kvk": "example", "invoicesCount": 96, "vatNumbers": [ "example" ], "taxNumbers": [ "example" ], "ibans": [ "example" ], "createdAt": "example", "updatedAt": "example", "recipientGroup": { "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/vendors/{id} DELETE

DELETE method/v1/entities/vendors/{id}

Request parameters

Responses

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

/v1/entities/vendors/{id} PATCH

PATCH method/v1/entities/vendors/{id}

Request parameters

{ "operation": "AddVatNumber", "payload": "example" }

Responses

{ "id": "example", "companyId": "example", "profileName": "example", "internalNumber": "example", "recipientGroupId": "example", "name": "example", "street": "example", "city": "example", "country": "example", "zipCode": "example", "currency": "example", "kvk": "example", "invoicesCount": 96, "vatNumbers": [ "example" ], "taxNumbers": [ "example" ], "ibans": [ "example" ], "createdAt": "example", "updatedAt": "example", "recipientGroup": { "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" } ] }
Last modified: 20 October 2024
VendorVendor Internal