NONCONFIDENTIAL // EXTERNAL

Version 1.6 G-Invoicing Remittance Advice API 10/12/2022

G-Invoicing Remittance Advice API

This specification describes how to call the application programming
interface to pull G-Invoicing’s Remittance Advice for a specific ALC
Description/Purpose and Transfer Date. This interface was designed at the request of the
Defense Finance and Accounting Services (DFAS), but may be used
by other Federal agencies to pull Remittance Advice.
Common HTTP Status Codes:
• 200 – Okay
Status Codes • 400 – Bad request
• 403 – Forbidden
• 500 – Internal server error

Remittance Advice
Summary
This service provides Remittance Advice in JavaScript Object Notation (JSON) format to an
external agency partner. Remittance Advice consists of IGT Buy/Sell Performance in “settled”
status (i.e., for which funds have transferred from one TAS to another). This service is limited to
one ALC for one Transfer Date, and can be called repeatedly if more ALCs or more dates are
required.

Note: Only an authorized Partner ID (and accompanying System ID) will elicit a response from
G-Invoicing. See the System Integration Guide or G-Invoicing Playbook for information on how
to partner with G-Invoicing, or contact us at [email protected]

Entity Relationships

Order

Requesting Performance Servicing

Schedule Fact Schedule

Performance
Reference

1
NONCONFIDENTIAL // EXTERNAL
Version 1.6 G-Invoicing Remittance Advice API 10/12/2022

Get Remittance
This endpoint allows systems to extract Remittance Advice from G-Invoicing.

HTTP method: GET

Path: /ginv/services/v1_0/remittance/

Request:
Parameters
Name: SystemID
Description: Identifies the system that is exchanging data with G-Invoicing
In: header
Type: string [100]
Required: true

Name: agencyLocationCode
Description: Limits results to Remittance associated with the passed ALC
In: query
Type: string [8]
Required: true

Name: transferDate
Description: Limits results to Remittance settled on that date
In: query
Type: date; Format: YYYY-MM-DD
Required: true

Note: transferDate parameter assumes date is UTC

Example
GET /ginv/services/v1_0/remittance?agencyLocationCode=17000001,
transferDate=2022-11-30
Host: ws.igt.fiscal.treasury.gov
Accept: application/json
Accept Encoding: gzip, deflate
Connection: Keep-Alive

2
NONCONFIDENTIAL // EXTERNAL
Version 1.6 G-Invoicing Remittance Advice API 10/12/2022

Responses:
Bad Request
Content Type: application/json
Status Code: 400
Description: Remittance request could not be processed, returned with a
message text containing the problem encountered (in the response).
Schema: errors

Example

{
"callDetail": {
"environment": "DEVF",
"recordCount": "1"
},
"errors": [
{
"code": "400",
"message": "Transfer Date invalid. Must be in YYYY-MM-DD format."
}
]
}

Forbidden (aka, unauthorized request)

Content Type: application/json
Status Code: 403
Description: User submitting the Remittance request was not authorized
to view Order/Performance data or the System ID does not fall under the
Partner ID (certificate).
Schema: errors

Internal Server Error

Content Type: application/json
Status Code: 500
Description: An unexpected error was encountered.
Schema: errors

Okay (aka, success)

Content Type: application/json
Status Code: 200
Description: Remittance request was successfully processed with a
response containing settled details for the ALC and Transfer Date.
Schema: Remittance

3
NONCONFIDENTIAL // EXTERNAL
Version 1.6 G-Invoicing Remittance Advice API 10/12/2022

Examples of Get Remittance success responses

Get Remittance successful response – with records returned

{
"callDetail": {
"environment": "DEVF",
"recordCount": "1"
},
"totalTransferAmt": 10,
"remittanceAdvice": [
{
"performanceNbr": "P2210-015-015-085198",
"performanceDt": "2022-10-05T02:04:17.226Z",
"transactionDt": "2022-10-05T02:04:17.406Z",
"accountingPeriod": 202212,
"performanceTypeCd": "548",
"performanceTypeDesc": "Advance",
"performanceDetailNbr": 1,
"quantity": 10,
"performanceStatusCd": "STL",
"disbursingOfficeSymbol": "GI000",
"documentRefNbr": "00063747",
"transferDt": "2022-10-05T02:04:42.918Z",
"transferDetailAmt": 10,
"reqTransferBETC": "DISNGF",
"srvTransferBETC": "COLL",
"order": {
"orderNbr": "O2210-015-015-164267",
"gtcNbr": "A2112-015-015-012619",
"orderCreateDt": "2022-10-05T01:58:42.653Z",
"orderModNbr": 0,
"reqOrderTrackingId": "OrderTrackingIdentifier",
"reqAlc": "15100419",
"fobPoint": "D",
"srvOrderTrackingId": "Requesting Agency Order Number",
"srvAlc": "15100413",
"orderStartDt": "2020-12-02T09:30:47Z",
"orderEndDt": "2023-06-17T09:30:47Z",
"fundingOfficeCd": "Verify",
"fundingAgencyCd": "Fund",
"reqUniqueEntityId": "RequestinUEI",
"srvUniqueEntityId": "ServicingUEI",
"orderOrigPartnerInd": "R",
"reqGroupUUID": "03319bdf-cac7-4a3a-9579-2c7338acbc1d",
"reqGroupNm": "Agency - Group 1",
"srvGroupUUID": "03319bdf-cac7-4a3a-9579-2c7338acbc1d",
"srvGroupNm": "Agency - Group 1"

4
NONCONFIDENTIAL // EXTERNAL
Version 1.6 G-Invoicing Remittance Advice API 10/12/2022

},
"reqSchedule": {
"lineNbr": 1,
"quantity": 1000000,
"orderScheduleNbr": 1,
"reqBusEventTypeCd": "DISNGF",
"reqAcctClassRefNbr": "AC",
"reqAgencyAcctId": 876543,
"reqActivityId": "ActivityIdentifi",
"reqAddtlAcctClass": "AdditionalAccountingInformation",
"reqBudgetLineItem": "BudgetLineItem",
"reqAvailabilityTypeCd": "X",
"reqAgencyId": "015",
"reqMainAcctCd": "0130",
"reqSubAccountCd": "000",
"reqCostCenterId": "CostCenterIdenti",
"reqCostElement": "CostElement",
"reqAgencyDisbId": 12345678,
"reqFunctionalArea": "FunctionalArea",
"reqFundingCenterId": "FundingCenterIde",
"reqObjectClassCd": "0.0",
"reqProjectId": "ProjectIdentifier",
"reqReimbursableInd": "R",
"reqSecCooperationCaseDesg": "ew12",
"reqSecurityCooperation": "FMS",
"reqSecCoopCaseLineitemId": "AJW",
"reqSecCoopImplAgency": "B",
"reqSubAllocation": "SubA",
"reqWorkOrder": "WorkOrderNumber",
"reqActivityAddressCd": "Activi"
},
"srvSchedule": {
"lineNbr": 1,
"quantity": 1000000,
"orderScheduleNbr": 1,
"srvBusEventTypeCd": "COLL",
"srvAcctClassRefNbr": "AC",
"srvAgencyAcctId": 876543,
"srvActivityId": "ActivityIdentifi",
"srvAddtlAcctClass": "does this work",
"srvBudgetLineItem": "BudgetLineItem",
"srvAvailabilityTypeCd": "X",
"srvAgencyId": "015",
"srvMainAcctCd": "0130",
"srvSubAccountCd": "000",
"srvCostCenterId": "CostCenterIdenti",
"srvCostElement": "CostElement",
"srvAgencyDisbId": 12345678,

5
NONCONFIDENTIAL // EXTERNAL
Version 1.6 G-Invoicing Remittance Advice API 10/12/2022

"srvFunctionalArea": "FunctionalArea",
"srvFundingCenterId": "FundingCenterIde",
"srvObjectClassCd": "0.0",
"srvProjectId": "ProjectIdentifier",
"srvReimbursableInd": "R",
"srvSecCooperationCaseDesg": "ew12",
"srvSecurityCooperation": "FMS",
"srvSecCoopCaseLineitemId": "AJW",
"srvSecCoopImplAgency": "B",
"srvSubAllocation": "SubA",
"srvWorkOrder": "WorkOrderNumber",
"srvActivityAddressCd": "Activi"
}
}
]
}

Get Remittance successful response – no records returned

{
"callDetail": {
"environment": "DEVF",
"recordCount": "0"
}
}

6
NONCONFIDENTIAL // EXTERNAL
Version 1.6 G-Invoicing Remittance Advice API 10/12/2022

Appendix A: errors JSON Schema

{
"type": "object",
"properties": {
"callDetail": {
"type": "object",
"properties": {
"environment": {
"type": "string"
},
"recordCount": {
"type": "string"
}
}
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}

7
NONCONFIDENTIAL // EXTERNAL
Version 1.6 G-Invoicing Remittance Advice API 10/12/2022

Appendix B: remittanceAdvice JSON Schema

{
"type": "object",
"properties": {
"callDetail": {
"type": "object",
"properties": {
"environment": {
"type": "string"
},
"recordCount": {
"type": "string"
}
}
},
"totalTransferAmt": {
"type": "number"
},
"remittanceAdvice": [
"type": "array",
"items": {
"type": "object",
"properties": {
"performanceNbr": {
"type": "string"
},
"refPerformanceNbr": {
"type": "string"
},
"agencyTransactionId": {
"type": "string"
},
"performanceDt": {
"type": "string",
"format": "date-time"
},
"transactionDt": {
"type": "string",
"format": "date-time"
},
"accountingPeriod": {
"type": "integer"
},
"performanceTypeCd": {
"type": "string"
},
"performanceTypeDesc": {
"type": "string"
},
"performanceDetailNbr": {
"type": "integer"
},
"performanceRefDetailNbr": {
"type": "integer"
},

8
NONCONFIDENTIAL // EXTERNAL
Version 1.6 G-Invoicing Remittance Advice API 10/12/2022

"finalPerformanceInd": {
"type": "string"
},
"quantity": {
"type": "number"
},
"performanceStatusCd": {
"type": "string"
},
"disbursingOfficeSymbol": {
"type": "string"
},
"documentRefNbr": {
"type": "string"
},
"transferDt": {
"type": "string",
"format": "date-time"
},
"transferDetailAmt": {
"type": "number"
},
"reqTransferBETC": {
"type": "string"
},
"srvTransferBETC": {
"type": "string"
},
"order": {
"type": "object",
"properties": {
"orderNbr": {
"type": "string"
},
"gtcNbr": {
"type": "string"
},
"orderCreateDt": {
"type": "string",
"format": "date-time"
},
"orderModNbr": {
"type": "integer"
},
"reqOrderTrackingId": {
"type": "string"
},
"reqAlc": {
"type": "string"
},
"fobPoint": {
"type": "string"
},
"srvOrderTrackingId": {
"type": "string"

9
NONCONFIDENTIAL // EXTERNAL
Version 1.6 G-Invoicing Remittance Advice API 10/12/2022

},
"srvAlc": {
"type": "string"
},
"orderStartDt": {
"type": "string",
"format": "date-time"
},
"orderEndDt": {
"type": "string",
"format": "date-time"
},
"fundingOfficeCd": {
"type": "string"
},
"fundingAgencyCd": {
"type": "string"
},
"reqUniqueEntityId": {
"type": "string"
},
"srvUniqueEntityId": {
"type": "string"
}
"orderOrigPartnerInd": {
"type": "string"
}
"reqGroupUUID”: {
"type": "string"
}
"reqGroupNm”: {
"type": "string"
}
"srvGroupUUID”: {
"type": "string"
}
"srvGroupNm”: {
"type": "string"
}
}
},
"reqSchedule": {
"type": "object",
"properties": {
"lineNbr": {
"type": "integer"
},
"quantity": {
"type": "integer"
},
"orderScheduleNbr": {
"type": "integer"
},
"reqBusEventTypeCd": {
"type": "string"

10
NONCONFIDENTIAL // EXTERNAL
Version 1.6 G-Invoicing Remittance Advice API 10/12/2022

},
"reqAcctClassRefNbr": {
"type": "string"
},
"reqAgencyAcctId": {
"type": "integer"
},
"reqActivityId": {
"type": "string"
},
"reqAddtlAcctClass": {
"type": "string"
},
"reqBudgetLineItem": {
"type": "string"
},
"reqAvailabilityTypeCd": {
"type": "string"
},
"reqAgencyId": {
"type": "string"
},
"reqAllocTransferAgcyId": {
"type": "string"
},
"reqBeginningPeriodAvail": {
"type": "string"
},
"reqEndingPeriodAvail": {
"type": "string"
},
"reqMainAcctCd": {
"type": "string"
},
"reqSubLevelPrefixCd": {
"type": "string"
},
"reqSubAccountCd": {
"type": "string"
},
"reqCostCenterId": {
"type": "string"
},
"reqCostElement": {
"type": "string"
},
"reqAgencyDisbId": {
"type": "integer"
},
"reqFunctionalArea": {
"type": "string"
},
"reqFundingCenterId": {
"type": "string"
},

11
NONCONFIDENTIAL // EXTERNAL
Version 1.6 G-Invoicing Remittance Advice API 10/12/2022

"reqObjectClassCd": {
"type": "string"
},
"reqProjectId": {
"type": "string"
},
"reqReimbursableInd": {
"type": "string"
},
"reqSecCooperationCaseDesg": {
"type": "string"
},
"reqSecurityCooperation": {
"type": "string"
},
"reqSecCoopCaseLineitemId": {
"type": "string"
},
"reqSecCoopImplAgency": {
"type": "string"
},
"reqSubAllocation": {
"type": "string"
},
"reqWorkOrder": {
"type": "string"
},
"reqActivityAddressCd": {
"type": "string"
}
}
},
"srvSchedule": {
"type": "object",
"properties": {
"lineNbr": {
"type": "integer"
},
"quantity": {
"type": "integer"
},
"orderScheduleNbr": {
"type": "integer"

"srvBusEventTypeCd": {
"type": "string"
},
"srvAcctClassRefNbr": {
"type": "string"
},
"srvAgencyAcctId": {
"type": "integer"
},
"srvActivityId": {
"type": "string"

12
NONCONFIDENTIAL // EXTERNAL
Version 1.6 G-Invoicing Remittance Advice API 10/12/2022

},
"srvAddtlAcctClass": {
"type": "string"
},
"srvBudgetLineItem": {
"type": "string"
},

"srvAvailabilityTypeCd": {
"type": "string"
},
"srvAgencyId": {
"type": "string"
},
"srvAllocTransferAgcyId": {
"type": "string"
},
"srvBeginningPeriodAvail": {
"type": "string"
},
"srvEndingPeriodAvail": {
"type": "string"
},
"srvMainAcctCd": {
"type": "string"
},
"srvSubLevelPrefixCd": {
"type": "string"
},
"srvSubAccountCd": {
"type": "string"
},
"srvCostCenterId": {
"type": "string"
},
"srvCostElement": {
"type": "string"
},
"srvAgencyDisbId": {
"type": "integer"
},
"srvFunctionalArea": {
"type": "string"
},
"srvFundingCenterId": {
"type": "string"
},
"srvObjectClassCd": {
"type": "string"
},
"srvProjectId": {
"type": "string"
},
"srvReimbursableInd": {
"type": "string"

13
NONCONFIDENTIAL // EXTERNAL
Version 1.6 G-Invoicing Remittance Advice API 10/12/2022

},
"srvSecCooperationCaseDesg": {
"type": "string"
},
"srvSecurityCooperation": {
"type": "string"
},
"srvSecCoopCaseLineitemId": {
"type": "string"
},
"srvSecCoopImplAgency": {
"type": "string"
},
"srvSubAllocation": {
"type": "string"
},
"srvWorkOrder": {
"type": "string"
},
"srvActivityAddressCd": {
"type": "string"
}
}
},
"performanceRefDtl": {
"type": "object",
"properties": {
"performanceNbr": {
"type": "string"
},
"refAgencyTransactionId": {
"type": "string"
},
"refPerformanceDt": {
"type": "string",
"format": "date-time"
},
"refTransactionDt": {
"type": "string",
"format": "date-time"
},
"refAccountingPeriod": {
"type": "integer"
},
"refPerformanceTypeCd": {
"type": "string"
},
"refPerformanceTypeDesc": {
"type": "string"
},
"refPerformanceDetailNbr": {
"type": "integer"
},
"refQuantity": {
"type": "integer"

14
NONCONFIDENTIAL // EXTERNAL
Version 1.6 G-Invoicing Remittance Advice API 10/12/2022

},
"refPerformanceStatusCd": {
"type": "string"
},
"refDisbursingOfficeSymbol": {
"type": "string"
},
"refDocumentRefNbr": {
"type": "string"
},
"refTransferDt": {
"type": "string",
"format": "date-time"
},
"refTransferDetailAmt": {
"type": "number"
}
}
}
}
}
}
}
}

15
NONCONFIDENTIAL // EXTERNAL
Version 1.6 G-Invoicing Remittance Advice API 10/12/2022

Appendix C: Revision History

Vers. Date of G-Inv Page/Section

Change/Revision Description
Num. Change Rel. Affected
0.1 11/22/19 TBD Initial draft for internal review. All
0.2 11/26/19 TBD Folded in JSON schemas and samples. All
1.0 11/26/19 TBD Removed draft watermark after review w/ PO. All
Changed transferAmt to transferDetailAmt.
1.1 1/31/20 TBD Renamed performanceDetailNum to performanceDetailNbr. Appendix B,
Renamed performanceRefDetailNum to performanceRefDetailNbr. JSON Example
Renamed refPerfromanceDetailNum to refPerformanceDetailNbr.
Renamed refAgencyPerformanceId to refAgencyTransactionId.
Added totalTransferAmt element.
Note: None of these changes were made to the reporting
database. That will be done when the API is actually built.
1.2 3/5/20 TBD 1. Changed all dates to "type": "string", "format": "date-time" Appendix B,
2. Dropped BPN and BPN+4 as per Order FIDS changes JSON Example
3. Added fundingOfficeCode as per Order FIDS changes
4. Added fundingAgencyCode as per Order FIDS changes
5. Added requestingUniqueEntityIdentifier as per FIDS changes
6. Added servicingUniqueEntityIdentifier as per FIDS changes
7. Changed type for Quantity from integer to number
Note: None of these changes were made to the reporting
database. That will be done when the API is actually built.
1.3 3/24/20 TBD transferAmt in schema should be transferDetailAmt, as per v1.0 Examples
change above Appendix B
1.4 5/15/20 TBD Added reqActivityAddressCd to reqSchedule. Examples
Added srvActivityAddressCd to srvSchedule. Appendix B
1.4.1 1/27/21 TBD Dropped remaining BPN+4 data element from JSON sample that Examples
should have been dropped with the 3/5/2020 change.
1.5 5/3/21 4.3 1. Changed Performance Details entity to Performance Fact 1. Entity
Draft for DoD review: Relationships
2. Added Requesting and Servicing Performance BETCs 2-4. Response
3. Added Requesting and Servicing Group Name and UUID Schema and
4. Added Order Originating Partner Indicator Sample
1.5.1 5/17/21 4.3 Due to r4.0 access model changes, a 403 error cannot detect Responses >
missing ALC access, only a missing role or a bad Partner/System ID Bad Request
combination. Client gets back whatever remittance data their On Page 3
Group assignment(s) provide.
1.6 10/12/22 4.6.1 1. Added additional note indicating the transferDate parameter 1. Request
assumes date passed is UTC. Parameters
2. Updated examples to indicate corrected JSON responses 2.Responses
throughout
3. Updated remittanceAdvice JSON Schema to indicate added
3. Appendix B
srvSchedule fields (Line Number, Schedule Number, Quantity,
Budget Line Item, Object Class Code and Reimbursable
Indicator)

End of Specification

16