GET api/cogeo/avoir/{idAvoir}
Récupère un avoir en fonction de son identifiant unique.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
idAvoir |
Identifiant unique de l'avoir |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Retourne un ApiFacture.
ApiAvoirName | Description | Type | Additional information |
---|---|---|---|
IdAvoir |
Identifiant unique de l'avoir |
integer |
None. |
IdFactureAssociee |
Identifiant unique de la facture associée à l'avoir |
integer |
None. |
IsIntegral |
Détermine si l'avoir est total ou non |
boolean |
None. |
Numero |
Numéro de la pièce comptable |
string |
None. |
DateEmission |
Date d'émission de la pièce comptable |
date |
None. |
IdsLignesArticle |
Liste des identifiants uniques des lignes articles de la pièce comptable |
Collection of integer |
None. |
IdsReglements |
Liste des identifiants uniques des règlements de la pièce comptable |
Collection of integer |
None. |
IdAffaire |
Identifiant unique de l'affaire de la pièce comptable |
integer |
None. |
IdDestinataire |
Identifiant unique du destinataire de la pièce comptable |
integer |
None. |
IdContactInterne |
Identifiant unique du contact interne de la pièce comptable |
integer |
None. |
DateCreation |
Date de création de la pièce comptable |
date |
None. |
MentionHautDePage |
Mention de haut de page de la pièce comptable |
string |
None. |
MentionBasDePage |
Mention de bas de page de la pièce comptable |
string |
None. |
NumeroOrdre |
Numéro d'ordre de la pièce comptable |
string |
None. |
IdAdresse |
Identifiant unique de l'adresse postale associée à la pièce comptable |
integer |
None. |
ConcrObjet |
Objet de la pièce comptable (en RTF) |
string |
None. |
ConcrObjetBrut |
Objet de la pièce comptable |
string |
None. |
ConcrDetailPrestations |
Détails des prestations de la pièce comptable (en RTF) |
string |
None. |
ConcrDetailPrestationsBrut |
Détails des prestations de la pièce comptable |
string |
None. |
DateDerniereAlerte |
Date de dernière alerte au sujet de la pièce comptable |
date |
None. |
TypeDerniereAlerte |
Type de dernière alerte au sujet de la pièce comptable |
integer |
None. |
IdResponsable |
Identifiant unique du responsable de la pièce comptable |
integer |
None. |
IdRedacteur |
Identifiant unique du rédacteur de la pièce comptable |
integer |
None. |
IdSite |
Identifiant unique du site de la pièce comptable |
integer |
None. |
IdService |
Identifiant unique du service de la pièce comptable |
integer |
None. |
IsMO |
Indique si de la pièce comptable est de type maitrise d'œuvre. |
boolean |
None. |
IdOperationApplication |
Identifiant unique de l'opération associée à la pièce comptable |
integer |
None. |
IdCoefficientActualisation |
Identifiant unique du cœfficient d'actualisation de la pièce comptable |
integer |
None. |
IsExternal |
Indique si la pièce comptable est externe à Cogeo. |
boolean |
None. |
IdCommune |
Identifiant unique de la commune associée à la pièce comptable |
integer |
None. |
Response Formats
application/json, text/json
{ "IdAvoir": 1, "IdFactureAssociee": 1, "IsIntegral": true, "Numero": "sample string 3", "DateEmission": "2024-12-22T04:31:27.5685437+01:00", "IdsLignesArticle": [ 1, 2 ], "IdsReglements": [ 1, 2 ], "IdAffaire": 1, "IdDestinataire": 1, "IdContactInterne": 1, "DateCreation": "2024-12-22T04:31:27.5685437+01:00", "MentionHautDePage": "sample string 6", "MentionBasDePage": "sample string 7", "NumeroOrdre": "sample string 8", "IdAdresse": 1, "ConcrObjet": "sample string 9", "ConcrObjetBrut": "sample string 10", "ConcrDetailPrestations": "sample string 11", "ConcrDetailPrestationsBrut": "sample string 12", "DateDerniereAlerte": "2024-12-22T04:31:27.5685437+01:00", "TypeDerniereAlerte": 14, "IdResponsable": 1, "IdRedacteur": 1, "IdSite": 1, "IdService": 1, "IsMO": true, "IdOperationApplication": 1, "IdCoefficientActualisation": 1, "IsExternal": true, "IdCommune": 1 }
application/xml, text/xml
<ApiAvoir xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ModuleoWeb.Models.Api"> <ConcrDetailPrestations>sample string 11</ConcrDetailPrestations> <ConcrDetailPrestationsBrut>sample string 12</ConcrDetailPrestationsBrut> <ConcrObjet>sample string 9</ConcrObjet> <ConcrObjetBrut>sample string 10</ConcrObjetBrut> <DateCreation>2024-12-22T04:31:27.5685437+01:00</DateCreation> <DateDerniereAlerte>2024-12-22T04:31:27.5685437+01:00</DateDerniereAlerte> <DateEmission>2024-12-22T04:31:27.5685437+01:00</DateEmission> <IdAdresse>1</IdAdresse> <IdAffaire>1</IdAffaire> <IdCoefficientActualisation>1</IdCoefficientActualisation> <IdCommune>1</IdCommune> <IdContactInterne>1</IdContactInterne> <IdDestinataire>1</IdDestinataire> <IdOperationApplication>1</IdOperationApplication> <IdRedacteur>1</IdRedacteur> <IdResponsable>1</IdResponsable> <IdService>1</IdService> <IdSite>1</IdSite> <IdsLignesArticle xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> </IdsLignesArticle> <IdsReglements xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> </IdsReglements> <IsExternal>true</IsExternal> <IsMO>true</IsMO> <MentionBasDePage>sample string 7</MentionBasDePage> <MentionHautDePage>sample string 6</MentionHautDePage> <Numero>sample string 3</Numero> <NumeroOrdre>sample string 8</NumeroOrdre> <TypeDerniereAlerte>14</TypeDerniereAlerte> <IdAvoir>1</IdAvoir> <IdFactureAssociee>1</IdFactureAssociee> <IsIntegral>true</IsIntegral> </ApiAvoir>
multipart/form-data
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IdAvoir" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IdFactureAssociee" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IsIntegral" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Numero" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="DateEmission" 2024-12-22T04:31:27.5685437+01:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IdsLignesArticle[0]" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IdsLignesArticle[1]" 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IdsReglements[0]" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IdsReglements[1]" 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IdAffaire" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IdDestinataire" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IdContactInterne" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="DateCreation" 2024-12-22T04:31:27.5685437+01:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="MentionHautDePage" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="MentionBasDePage" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="NumeroOrdre" sample string 8 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IdAdresse" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ConcrObjet" sample string 9 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ConcrObjetBrut" sample string 10 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ConcrDetailPrestations" sample string 11 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ConcrDetailPrestationsBrut" sample string 12 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="DateDerniereAlerte" 2024-12-22T04:31:27.5685437+01:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TypeDerniereAlerte" 14 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IdResponsable" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IdRedacteur" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IdSite" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IdService" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IsMO" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IdOperationApplication" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IdCoefficientActualisation" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IsExternal" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IdCommune" 1 --MultipartDataMediaFormatterBoundary1q2w3e--